DigiOffice API Services Services

<back to all web services

GetMultiTaskOperation

Get a multitask.

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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkflowMultiTaskDTO:
    multi_task: Optional[WorkflowTaskDTO] = None
    task_i_ds: Optional[List[int]] = None


# @Api(Description="Get a multitask.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetMultiTaskOperation:
    """
    Get a multitask.
    """

    # @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    task_i_ds: List[int] = field(default_factory=list)
    """
    ID of the workflow task(s) to return
    """

Python GetMultiTaskOperation DTOs

POST /api/workflowmultitasks HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TaskIDs: 
	[
		0
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MultiTask: 
	{
		ID: 0,
		Name: String,
		WorkflowID: 0,
		WorkflowDescription: String,
		RootWorkflowID: 0,
		TransitionName: String,
		ActivationID: 00000000-0000-0000-0000-000000000000,
		TypeID: 0,
		TypeDescription: String,
		StatusID: 0,
		StatusDescription: String,
		UserID: 0,
		Active: False,
		OfferedDate: 0001-01-01,
		AssignedDate: 0001-01-01,
		StartDate: 0001-01-01,
		ExpirationDate: 0001-01-01,
		Order: 0,
		Progress: 0,
		FinishedDate: 0001-01-01,
		FinishedByUserID: 0,
		FinishedDocumentID: 00000000-0000-0000-0000-000000000000,
		Read: False,
		DeferDate: 0001-01-01,
		DeferReason: String,
		Reason: String,
		Urgent: False,
		Status: String,
		NumberOfComments: 0,
		RelativeDetailLink: String,
		FirstSideStepID: 0,
		FirstSideStepOmschr: String,
		FirstSideStepDetailLink: String,
		IsSideStepOfWorkflowID: 0,
		IsSideStepOfWorkflowOmschr: String,
		IsSideStepOfWorkflowDetailLink: String,
		IsSideStepOfTaskID: 0,
		IsSideStepOfTaskOmschr: String,
		IsSideStepOfTaskDetailLink: String,
		IsObservedID: 0,
		IsObservedOmschr: String,
		IsObservedDetailLink: String
	},
	TaskIDs: 
	[
		0
	]
}