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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Cancel a workflow.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CancelWorkflowOperation:
    """
    Cancel a workflow.
    """

    # @ApiMember(Description="ID of the workflow to cancel", IsRequired=true)
    workflow_i_d: int = 0
    """
    ID of the workflow to cancel
    """

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