CreateFlowDef

# 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:

Variant	Extra parameters
`CreateFlowDef`	(base — no extras)
`CreateFlowDef1`	`OnEndMoveToPath`
`CreateFlowDef2`	`OnEndMoveToPath`, `Supervisor`
`CreateFlowDef3`	`OnEndMoveToPath`, `Supervisor`, `OnEndEventUrl`, `Hide`

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¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`DomainName`	string	Yes	Name of the domain/library in which to create the workflow definition.
`FlowName`	string	Yes	Name of the new workflow definition. Maximum 32 alphanumeric characters. Must be unique within the domain.
`ActiveFolderPath`	string	Yes	Full infoRouter path of the folder where the workflow is active (e.g. `/Corporate/Contracts`). Documents in this folder and its sub-folders can be submitted to this workflow.

Response¶

Success Response¶

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

Attribute	Description
`FlowDefID`	The unique integer ID of the newly created workflow definition.
`FlowName`	Name of the workflow definition.
`DomainId`	Internal ID of the owning domain/library.
`DomainName`	Name of the owning domain/library.
`ActiveFolderPath`	Path of the folder where the workflow is active.
`RequiresStartUpPlayers`	Whether the workflow requires startup players to be defined.
`Active`	Always `"false"` for a newly created workflow.
`OnEndMoveToPath`	Path of the folder documents are moved to when the workflow ends (empty if not set).
`OnEndEventUrl`	Webhook URL called when the workflow ends (empty if not set).
`Hide`	Whether the workflow is hidden from the folder UI.
`Supervisors`	List of supervisor users and groups. Empty for this variant.

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/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

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.

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¶

Error	Description
`[900]`	Authentication failed — invalid credentials.
`[901]`	Session expired or invalid authentication ticket.
Domain not found	The specified `DomainName` does not exist.
Folder not found	The specified `ActiveFolderPath` does not exist.
Empty active folder	`ActiveFolderPath` cannot be empty.
Name validation error	`FlowName` exceeds 32 characters or contains invalid characters.
Duplicate name	A workflow with the same name already exists in this domain.
Permission error	Calling user is not a domain manager or administrator.