SubmitDocumentToFlow1 API¶

Submits a document to a workflow definition, with the ability to specify which users and/or groups should be assigned to the first step of the workflow at submission time. This overrides the default task assignees configured in the workflow definition for the first step only.

For all subsequent steps, the workflow definition's configured assignees are used.

To submit with the default assignees from the workflow definition, use SubmitDocumentToFlow.

Endpoint¶

/srv.asmx/SubmitDocumentToFlow1

Methods¶

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

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¶

Same as SubmitDocumentToFlow:

Example¶

GET Request -" assigning users to the first step¶

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

GET Request -" assigning a group to the first step¶

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

POST Request¶

POST /srv.asmx/SubmitDocumentToFlow1 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&StepPlayerIDs=15%2C23&StepGroupIDs=

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;
}

SubmitDocumentToFlow with the assignees for the steps that need choosing. StepPlayerIDs and StepGroupIDs are comma separated lists and both are optional.

await call('SubmitDocumentToFlow1', {
  authenticationTicket: ticket,
  Path: '/Public/Invoices/inv-1001.pdf',
  FlowDefID: flowDefId,
  StepPlayerIDs: '101,102',
  StepGroupIDs: ''
});

Notes¶

• StepPlayerIDs contains user IDs (numeric), not login names. To get a user's ID, use GetUser.
• StepGroupIDs contains user group IDs (numeric). To get a group's ID, use GetUserGroup.
• Both StepPlayerIDs and StepGroupIDs can be specified simultaneously to mix individual users and groups for the first step.
• Only the first step assignees are overridden. All subsequent steps use the workflow definition's configured assignees.
• If both StepPlayerIDs and StepGroupIDs are empty, the workflow definition's default first-step assignees are used (equivalent to calling SubmitDocumentToFlow).
• The FlowDefID is the workflow definition ID, not a running workflow ID. Use GetFolderFlows to find definition IDs.

Related APIs¶

• SubmitDocumentToFlow -" Submit using the workflow definition's default assignees.
• GetFolderFlows -" List workflow definitions available for a folder.
• GetUser -" Get a user's numeric ID by login name.
• GetUserGroup -" Get a group's numeric ID by name.
• StopCurrentWorkflow -" Stop a running workflow gracefully.
• getTasks -" Get workflow tasks created after submission.

Error Codes¶

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