SubmitDocumentToFlow API¶

Submits a document to a workflow definition. Once submitted, the workflow engine creates running tasks based on the workflow definition, assigns them to the configured task assignees, and sends task notification emails.

To override the task assignees for the first step at submission time, use SubmitDocumentToFlow1.

Endpoint¶

/srv.asmx/SubmitDocumentToFlow

Methods¶

• GET /srv.asmx/SubmitDocumentToFlow?authenticationTicket=...&Path=...&FlowDefID=...
• POST /srv.asmx/SubmitDocumentToFlow (form data)
• SOAP Action: http://tempuri.org/SubmitDocumentToFlow

Parameters¶

Response¶

Success Response¶

<response success="true" error="" errorCode="0" />

Error Response¶

<response success="false" error="Workflow submission failed. Document is currently checked out." />

Required Permissions¶

The calling user must have the Submit to Workflow permission on the document.

Anonymous access is not permitted. The infoRouter server must have a Workflow license.

Preconditions¶

Hidden workflows can be submitted. The workflow does not have to be applied to the document's folder, only to the same library.

Example¶

GET Request¶

GET /srv.asmx/SubmitDocumentToFlow
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &Path=/Cabinet/ProjectDocs/proposal.pdf
    &FlowDefID=42
HTTP/1.1
Host: yourserver

POST Request¶

POST /srv.asmx/SubmitDocumentToFlow HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&Path=/Cabinet/ProjectDocs/proposal.pdf&FlowDefID=42

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Starts a workflow over a document. FlowDefID is the numeric id CreateFlowDef3 or GetFlowDef reports - not the workflow name - and the definition has to be active.

const flow = await call('GetFlowDef', {
  authenticationTicket: ticket, DomainName: 'Public', WorkflowName: 'Invoice approval'
});
const flowDefId = flow.querySelector('FlowDef').getAttribute('FlowDefID');

await call('SubmitDocumentToFlow', {
  authenticationTicket: ticket,
  Path: '/Public/Invoices/inv-1001.pdf',
  FlowDefID: flowDefId
});

Notes¶

• The FlowDefID is the ID of the workflow definition (created with CreateFlowDef), not the ID of a running workflow instance.
• Task assignees are taken from the workflow definition. To specify custom assignees for the first step at submission time, use SubmitDocumentToFlow1.
• To find the workflow definition ID, use GetFolderFlows or GetDomainFlows.
• After a successful submission, the document's CurrentFlowId is set to the running workflow ID. Use GetTask or getTasks to retrieve the created tasks.
• A document can only be in one active workflow at a time. Stop or remove the current workflow before re-submitting.

Related APIs¶

• SubmitDocumentToFlow1 -" Submit with custom first-step task assignees.
• GetFolderFlows -" List workflow definitions available for a folder.
• GetDomainFlows -" List workflow definitions for a library/domain.
• StopCurrentWorkflow -" Stop a running workflow gracefully.
• RemoveCurrentWorkflow -" Remove a running workflow (hard delete).
• getTasks -" Get the workflow tasks created after submission.

Error Codes¶

The errorCode values this operation returns, checked against a running server: