DeleteFlowStepDef API¶

Deletes a step from the specified workflow definition. The workflow definition must be inactive to delete a step.

Endpoint¶

/srv.asmx/DeleteFlowStepDef

Methods¶

• GET /srv.asmx/DeleteFlowStepDef?AuthenticationTicket=...&DomainName=...&FlowName=...&StepName=...
• POST /srv.asmx/DeleteFlowStepDef (form data)
• SOAP Action: http://tempuri.org/DeleteFlowStepDef

Parameters¶

Response Structure¶

Success Response¶

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

Error Response¶

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

Required Permissions¶

• User must be authenticated (valid authentication ticket required)
• User must have workflow management permissions for the domain
• The workflow definition must be inactive (not active)

Use Cases¶

1. Workflow Definition Management
2. Remove unnecessary or incorrect steps from a workflow definition

3. Simplify workflow definitions by removing unused steps

4. Workflow Redesign

5. Delete steps as part of restructuring a workflow definition
6. Clean up steps before reactivating a modified workflow

Example Requests¶

Request (GET)¶

GET /srv.asmx/DeleteFlowStepDef?AuthenticationTicket=abc123-def456&DomainName=MyLibrary&FlowName=ApprovalFlow&StepName=ReviewStep HTTP/1.1
Host: server.example.com

Request (POST)¶

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

AuthenticationTicket=abc123-def456&DomainName=MyLibrary&FlowName=ApprovalFlow&StepName=ReviewStep

Request (SOAP 1.1)¶

POST /srv.asmx HTTP/1.1
Content-Type: text/xml; charset=utf-8
SOAPAction: "http://tempuri.org/DeleteFlowStepDef"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteFlowStepDef xmlns="http://tempuri.org/">
      <AuthenticationTicket>abc123-def456</AuthenticationTicket>
      <DomainName>MyLibrary</DomainName>
      <FlowName>ApprovalFlow</FlowName>
      <StepName>ReviewStep</StepName>
    </DeleteFlowStepDef>
  </soap:Body>
</soap:Envelope>

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

Removes a step by name. The definition has to be inactive; deactivate it first.

await call('DeactivateFlowDef', {
  authenticationTicket: ticket, domainName: 'Public', flowName: 'Invoice approval'
});

await call('DeleteFlowStepDef', {
  authenticationTicket: ticket,
  DomainName: 'Public',
  FlowName: 'Invoice approval',
  StepName: 'Approve'
});

Notes¶

• The workflow definition must be inactive before a step can be deleted. If the workflow is active, deactivate it first using DeactivateFlowDef.
• Deleting a step also removes all task definitions associated with that step.
• The step is identified by name (case-insensitive match).
• If the step has an associated "on start move to" folder, that association is also removed.

Related APIs¶

• AddFlowStepDef - Add a step to a workflow definition
• AddFlowStepDef1 - Add a step with an "on start move to" folder
• ActivateFlowDef - Activate a workflow definition
• DeactivateFlowDef - Deactivate a workflow definition
• AddFlowTaskDef - Add a task definition to a workflow step

Version History¶

• New: Added to provide programmatic access to workflow step deletion previously only available through the Control Panel UI

Error Codes¶

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