DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

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 WorkflowTaskActionDTO:
    begin_group: bool = False
    digi_office_icon: Optional[str] = None
    enabled: bool = False
    font_awesome_icon: Optional[str] = None
    hint: Optional[str] = None
    name: Optional[str] = None
    show_text_for_root_items: bool = False
    text: Optional[str] = None
    url: Optional[str] = None
    items: Optional[List[WorkflowTaskActionDTO]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowTaskDTO:
    id: int = 0
    name: Optional[str] = None
    workflow_i_d: int = 0
    workflow_description: Optional[str] = None
    root_workflow_i_d: int = 0
    transition_i_d: Optional[str] = None
    transition_name: Optional[str] = None
    activation_i_d: Optional[str] = None
    type_i_d: int = 0
    type_description: Optional[str] = None
    status_i_d: int = 0
    status_description: Optional[str] = None
    user_i_d: Optional[int] = None
    active: bool = False
    offered_date: Optional[datetime.datetime] = None
    assigned_date: Optional[datetime.datetime] = None
    start_date: Optional[datetime.datetime] = None
    expiration_date: Optional[datetime.datetime] = None
    order: int = 0
    progress: Optional[float] = None
    finished_date: Optional[datetime.datetime] = None
    finished_by_user_i_d: Optional[int] = None
    finished_document_i_d: Optional[str] = None
    read: bool = False
    defer_date: Optional[datetime.datetime] = None
    defer_reason: Optional[str] = None
    reason: Optional[str] = None
    urgent: bool = False
    status: Optional[str] = None
    available_actions: Optional[List[WorkflowTaskActionDTO]] = None
    finish_actions: Optional[List[WorkflowTaskActionDTO]] = None
    comment_actions: Optional[List[WorkflowTaskActionDTO]] = None
    document_actions: Optional[List[WorkflowTaskActionDTO]] = None
    number_of_comments: int = 0
    relative_detail_link: Optional[str] = None
    first_side_step_i_d: int = 0
    first_side_step_omschr: Optional[str] = None
    first_side_step_detail_link: Optional[str] = None
    is_side_step_of_workflow_i_d: Optional[int] = None
    is_side_step_of_workflow_omschr: Optional[str] = None
    is_side_step_of_workflow_detail_link: Optional[str] = None
    is_side_step_of_task_i_d: Optional[int] = None
    is_side_step_of_task_omschr: Optional[str] = None
    is_side_step_of_task_detail_link: Optional[str] = None
    is_observed_i_d: Optional[int] = None
    is_observed_omschr: Optional[str] = None
    is_observed_detail_link: Optional[str] = None


# @Api(Description="Get workflow task.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTaskOperation:
    """
    Get workflow task.
    """

    # @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    task_i_d: int = 0
    """
    ID of the workflow task(s) to return
    """

Python GetTaskOperation DTOs

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <ActivationID>00000000-0000-0000-0000-000000000000</ActivationID>
  <Active>false</Active>
  <AssignedDate>0001-01-01T00:00:00</AssignedDate>
  <AvailableActions i:nil="true" />
  <CommentActions i:nil="true" />
  <DeferDate>0001-01-01T00:00:00</DeferDate>
  <DeferReason>String</DeferReason>
  <DocumentActions i:nil="true" />
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <FinishActions i:nil="true" />
  <FinishedByUserID>0</FinishedByUserID>
  <FinishedDate>0001-01-01T00:00:00</FinishedDate>
  <FinishedDocumentID>00000000-0000-0000-0000-000000000000</FinishedDocumentID>
  <FirstSideStepDetailLink>String</FirstSideStepDetailLink>
  <FirstSideStepID>0</FirstSideStepID>
  <FirstSideStepOmschr>String</FirstSideStepOmschr>
  <ID>0</ID>
  <IsObservedDetailLink>String</IsObservedDetailLink>
  <IsObservedID>0</IsObservedID>
  <IsObservedOmschr>String</IsObservedOmschr>
  <IsSideStepOfTaskDetailLink>String</IsSideStepOfTaskDetailLink>
  <IsSideStepOfTaskID>0</IsSideStepOfTaskID>
  <IsSideStepOfTaskOmschr>String</IsSideStepOfTaskOmschr>
  <IsSideStepOfWorkflowDetailLink>String</IsSideStepOfWorkflowDetailLink>
  <IsSideStepOfWorkflowID>0</IsSideStepOfWorkflowID>
  <IsSideStepOfWorkflowOmschr>String</IsSideStepOfWorkflowOmschr>
  <Name>String</Name>
  <NumberOfComments>0</NumberOfComments>
  <OfferedDate>0001-01-01T00:00:00</OfferedDate>
  <Order>0</Order>
  <Progress>0</Progress>
  <Read>false</Read>
  <Reason>String</Reason>
  <RelativeDetailLink>String</RelativeDetailLink>
  <RootWorkflowID>0</RootWorkflowID>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Status>String</Status>
  <StatusDescription>String</StatusDescription>
  <StatusID>0</StatusID>
  <TransitionID>00000000-0000-0000-0000-000000000000</TransitionID>
  <TransitionName>String</TransitionName>
  <TypeDescription>String</TypeDescription>
  <TypeID>0</TypeID>
  <Urgent>false</Urgent>
  <UserID>0</UserID>
  <WorkflowDescription>String</WorkflowDescription>
  <WorkflowID>0</WorkflowID>
</WorkflowTaskDTO>