DigiOffice API Services Services

<back to all web services

CancelWorkflowOperation

Cancel a workflow.

Requires Authentication
The following routes are available for this service:
POST/api/workflows/cancel

/** @description Cancel a workflow. */
// @Api(Description="Cancel a workflow.")
export class CancelWorkflowOperation
{
    /** @description ID of the workflow to cancel */
    // @ApiMember(Description="ID of the workflow to cancel", IsRequired=true)
    public WorkflowID: number;

    public constructor(init?: Partial<CancelWorkflowOperation>) { (Object as any).assign(this, init); }
}

TypeScript CancelWorkflowOperation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/workflows/cancel HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CancelWorkflowOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <WorkflowID>0</WorkflowID>
</CancelWorkflowOperation>