DigiOffice API Services Services

<back to all web services

FinishTaskOperation

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/finish
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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowTransitionDTO:
    id: Optional[str] = None
    name: Optional[str] = None
    assignment_at_start_workflow_is_ad_hoc: bool = False
    assignment_is_ad_hoc_required: bool = False
    defer_at_start_workflow_is_ad_hoc: bool = False
    is_next: bool = False
    user_i_ds: Optional[List[int]] = None
    group_i_ds: Optional[List[int]] = None
    role_i_ds: Optional[List[int]] = None
    defer_until: Optional[datetime.datetime] = None
    deferral_note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinishTaskOperation:
    task_i_ds: Optional[List[int]] = None
    ws_verbinding_i_d: Optional[str] = None
    transitions: Optional[List[WorkflowTransitionDTO]] = None
    defer_to: Optional[datetime.datetime] = None
    reason: Optional[str] = None
    comment: Optional[str] = None

Python FinishTaskOperation 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/workflowtasks/finish HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinishTaskOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <Comment>String</Comment>
  <DeferTo>0001-01-01T00:00:00</DeferTo>
  <Reason>String</Reason>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
  <Transitions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs" i:nil="true" />
  <WSVerbindingID>00000000-0000-0000-0000-000000000000</WSVerbindingID>
</FinishTaskOperation>