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.

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¶

Response¶

Success Response¶

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

See CreateFlowDef for a full description of all response attributes.

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

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

Same as CreateFlowDef with a folder to move the document to when the workflow ends. It carries no supervisor either, so it hits the same inverted check and always fails 4041.

// Fails with 4041 on every release that still has the inverted check.
await call('CreateFlowDef1', {
  authenticationTicket: ticket,
  DomainName: 'Public',
  FlowName: 'Invoice approval',
  ActiveFolderPath: '/Public/Invoices',
  OnEndMoveToPath: '/Public/Invoices/Approved'
});

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¶

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