CreateFlowDef API¶

Creates a new workflow definition on the specified domain/library. The workflow is created in inactive state -" steps and tasks must be added with AddFlowStepDef and AddFlowTaskDef before activating it with ActivateFlowDef.

This is the minimal variant. Use the numbered variants for additional configuration:

Endpoint¶

/srv.asmx/CreateFlowDef

Methods¶

• GET /srv.asmx/CreateFlowDef?authenticationTicket=...&DomainName=...&FlowName=...&ActiveFolderPath=...
• POST /srv.asmx/CreateFlowDef (form data)
• SOAP Action: http://tempuri.org/CreateFlowDef

Parameters¶

Response¶

Success Response¶

<response success="true">
  <FlowDef
    FlowDefID="123"
    FlowName="ContractApproval"
    DomainId="45"
    DomainName="Corporate"
    ActiveFolderPath="/Corporate/Contracts"
    RequiresStartUpPlayers="false"
    Active="false"
    OnEndMoveToPath=""
    OnEndEventUrl=""
    Hide="False">
    <Supervisors />
  </FlowDef>
</response>

Error Response¶

<response success="false" error="Session expired or invalid ticket" errorCode="4010" />

Required Permissions¶

The calling user must be a domain/library manager or a system administrator.

Example¶

GET Request¶

GET /srv.asmx/CreateFlowDef
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &DomainName=Corporate
    &FlowName=ContractApproval
    &ActiveFolderPath=/Corporate/Contracts
HTTP/1.1
Host: yourserver

POST Request¶

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&DomainName=Corporate&FlowName=ContractApproval&ActiveFolderPath=/Corporate/Contracts

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

Creates a workflow definition over a folder, with no supervisor. Use CreateFlowDef2 or CreateFlowDef3 to name one at creation, or UpdateWorkflowDefinition to add one later.

await call('CreateFlowDef', {
  authenticationTicket: ticket,
  DomainName: 'Public',
  FlowName: 'Invoice approval',
  ActiveFolderPath: '/Public/Invoices'
});

Notes¶

• The workflow is created in inactive state. No documents can be submitted to it until it is activated with ActivateFlowDef.
• FlowName must be alphanumeric, maximum 32 characters, and must be unique within the domain/library.
• ActiveFolderPath must refer to an existing infoRouter folder. It cannot be empty.
• The OnEndMoveToPath, supervisor, OnEndEventUrl, and Hide fields are all left at their defaults (empty / false) by this variant. Use CreateFlowDef1, CreateFlowDef2, or CreateFlowDef3 to configure those.
• The typical workflow-building sequence is: CreateFlowDef -' AddFlowStepDef -' AddFlowTaskDef -' ActivateFlowDef.

Related APIs¶

• CreateFlowDef1 -" Creates a workflow definition with an on-end destination folder.
• CreateFlowDef2 -" Creates a workflow definition with an on-end folder and a supervisor.
• CreateFlowDef3 -" Creates a workflow definition with all options including event URL and hidden flag.
• AddFlowStepDef -" Add steps to the workflow definition after creation.
• AddFlowTaskDef -" Add task definitions to workflow steps.
• ActivateFlowDef -" Activate the workflow so documents can be submitted to it.
• GetFlowDef -" Retrieve the full definition of a workflow.
• DeactivateFlowDef -" Deactivate a workflow to modify its steps.
• DeleteWorkflow -" Permanently delete a workflow definition.

Error Codes¶

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