UpdateWorkflowStepDef API¶

Updates the display name and on-start folder move of an existing workflow step definition.

Endpoint¶

/srv.asmx/UpdateWorkflowStepDef

Methods¶

• GET /srv.asmx/UpdateWorkflowStepDef?authenticationTicket=...&domainName=...&workflowName=...&stepNumber=...&newStepName=...&onStartMoveToFolderPath=...
• POST /srv.asmx/UpdateWorkflowStepDef (form data)
• SOAP Action: http://tempuri.org/UpdateWorkflowStepDef

Parameters¶

Response¶

Success Response¶

<response success="true" error="" errorCode="0" />

Error Response¶

<response success="false" error="Error message" />

Required Permissions¶

Requires workflow supervisor, domain/library manager, or system administrator role.

This operation is accepted on an active definition as well. Changes apply to documents submitted afterwards; running workflows keep the folder they started with.

Example¶

Request (POST)¶

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

authenticationTicket=abc123&domainName=Corporate&workflowName=ContractApproval&stepNumber=2&newStepName=LegalReview&onStartMoveToFolderPath=/Corporate/InReview

Request (GET)¶

GET /srv.asmx/UpdateWorkflowStepDef
    ?authenticationTicket=abc123
    &domainName=Corporate
    &workflowName=ContractApproval
    &stepNumber=2
    &newStepName=LegalReview
    &onStartMoveToFolderPath=/Corporate/InReview
HTTP/1.1
Host: yourserver

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

Renames a step and sets the folder the document moves to when the step starts. onStartMoveToFolderPath is declared optional, so an empty value clears the move.

await call('UpdateWorkflowStepDef', {
  authenticationTicket: ticket,
  domainName: 'Public',
  workflowName: 'Invoice approval',
  stepNumber: 1,
  newStepName: 'Checked',
  onStartMoveToFolderPath: ''
});

Notes¶

• To clear the on-start folder move without setting a new one, pass an empty string for onStartMoveToFolderPath.
• Only the step name and on-start folder move are updatable via this API. To change step order or task definitions, use DeleteFlowStepDef and AddFlowStepDef1.
• Use GetFlowDef to retrieve existing step numbers and names before calling this API.

Related APIs¶

• GetFlowDef - Retrieve the full workflow definition including all step and task definitions.
• DeactivateFlowDef - Deactivate a workflow definition so its steps can be modified.
• ActivateFlowDef - Activate a workflow definition after modifications are complete.
• AddFlowStepDef1 - Add a new step to a workflow definition with an on-start folder move.
• DeleteFlowStepDef - Delete a step from a workflow definition.
• UpdateWorkflowDefinition - Update the top-level properties of a workflow definition.

Error Codes¶

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