apidocs

CreateFlowDef1 API

Creates a new workflow definition on the specified domain/library, with an optional destination folder for documents when the workflow ends. The workflow is created in inactive state.

This extends CreateFlowDef by adding the OnEndMoveToPath parameter. For the full parameter set see CreateFlowDef3.

Variant	Extra parameters
CreateFlowDef	(base)
CreateFlowDef1	OnEndMoveToPath
CreateFlowDef2	OnEndMoveToPath, Supervisor
CreateFlowDef3	OnEndMoveToPath, Supervisor, OnEndEventUrl, Hide

Endpoint

/srv.asmx/CreateFlowDef1

Methods

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

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).
OnEndMoveToPath	string	No	Full infoRouter path of the folder where documents are automatically moved when the workflow completes. Pass an empty string or omit to leave documents in place.

Response

Success Response

<root success="true">
  <FlowDef
    FlowDefID="124"
    FlowName="ContractApproval"
    DomainId="45"
    DomainName="Corporate"
    ActiveFolderPath="/Corporate/Contracts"
    RequiresStartUpPlayers="false"
    Active="false"
    OnEndMoveToPath="/Corporate/Archive"
    OnEndEventUrl=""
    Hide="False">
    <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/CreateFlowDef1
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &DomainName=Corporate
    &FlowName=ContractApproval
    &ActiveFolderPath=/Corporate/Contracts
    &OnEndMoveToPath=/Corporate/Archive
HTTP/1.1
Host: yourserver

POST Request

POST /srv.asmx/CreateFlowDef1 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

Notes

• OnEndMoveToPath must refer to an existing infoRouter folder if provided. An invalid path returns an error.
• Pass an empty string for OnEndMoveToPath to create the workflow without an end-move folder (equivalent to CreateFlowDef).
• The workflow is created in inactive state. Activate with ActivateFlowDef after adding steps and tasks.
• The typical workflow-building sequence is: CreateFlowDef1 -‘ AddFlowStepDef -‘ AddFlowTaskDef -‘ ActivateFlowDef.

Related APIs

• CreateFlowDef -“ Minimal variant without OnEndMoveToPath.
• CreateFlowDef2 -“ Adds a Supervisor parameter.
• CreateFlowDef3 -“ Full variant with all options.
• AddFlowStepDef -“ Add steps after creation.
• ActivateFlowDef -“ Activate the 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	ActiveFolderPath or OnEndMoveToPath 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.