CreateFlowDef3

# CreateFlowDef3 API

Creates a new workflow definition on the specified domain/library with the full set of configuration options: on-end destination folder, supervisor, webhook event URL, and visibility. The workflow is created in inactive state.

This is the most complete variant of the CreateFlowDef family. Use it when you need to configure OnEndEventUrl or Hide.

Endpoint¶

/srv.asmx/CreateFlowDef3

Methods¶

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

Parameters¶

Response¶

Success Response¶

<root success="true">
  <FlowDef
    FlowDefID="126"
    FlowName="ContractApproval"
    DomainId="45"
    DomainName="Corporate"
    ActiveFolderPath="/Corporate/Contracts"
    RequiresStartUpPlayers="false"
    Active="false"
    OnEndMoveToPath="/Corporate/Archive"
    OnEndEventUrl="https://erp.example.com/workflow-complete"
    Hide="True">
    <Supervisors>
      <User id="7" />
    </Supervisors>
  </FlowDef>
</root>

See CreateFlowDef for a full description of all response attributes.

Error Response¶

<root success="false" error="[901] Session expired or Invalid ticket" />

Required Permissions¶

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

Example¶

GET Request¶

GET /srv.asmx/CreateFlowDef3
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &DomainName=Corporate
    &FlowName=ContractApproval
    &ActiveFolderPath=/Corporate/Contracts
    &OnEndMoveToPath=/Corporate/Archive
    &Supervisor=john.smith
    &OnEndEventUrl=https://erp.example.com/workflow-complete
    &Hide=false
HTTP/1.1
Host: yourserver

POST Request¶

POST /srv.asmx/CreateFlowDef3 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&OnEndMoveToPath=/Corporate/Archive&Supervisor=john.smith&OnEndEventUrl=https%3A%2F%2Ferp.example.com%2Fworkflow-complete&Hide=false

Notes¶

• Supervisor is a login name (username), not a display name or user ID. The user must exist in the infoRouter system.
• Pass an empty string for Supervisor to create the workflow without a supervisor.
• OnEndMoveToPath must refer to an existing folder if non-empty. An invalid path returns an error.
• OnEndEventUrl is a plain URL string stored against the workflow. The server calls this URL via HTTP when the workflow ends. Pass an empty string to disable the webhook.
• Hide=true hides the workflow from the folder-level workflow list in the document library UI, but administrators and managers can still see it.
• FlowName must be alphanumeric, maximum 32 characters, and unique within the domain/library.
• ActiveFolderPath must refer to an existing infoRouter folder and cannot be empty.
• The workflow is created in inactive state. The typical build sequence is: CreateFlowDef3 → AddFlowStepDef → AddFlowTaskDef → ActivateFlowDef.

Related APIs¶

• CreateFlowDef – Minimal variant with only the three required parameters.
• CreateFlowDef1 – Adds OnEndMoveToPath.
• CreateFlowDef2 – Adds OnEndMoveToPath and Supervisor.
• AddFlowStepDef – Add steps to the workflow 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 it.
• DeleteWorkflow – Permanently delete a workflow definition.

Error Codes¶