DigiOffice API Services Services

<back to all web services

GetMultiTaskOperation

Get a multitask.

Requires Authentication
The following routes are available for this service:
POST/api/workflowmultitasks
GetMultiTaskOperation Parameters:
NameParameterData TypeRequiredDescription
TaskIDsbodyint[]YesID of the workflow task(s) to return
WorkflowMultiTaskDTO Parameters:
NameParameterData TypeRequiredDescription
MultiTaskformWorkflowTaskDTONo
TaskIDsformList<int>No
WorkflowTaskDTO Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
NameformstringNo
WorkflowIDformintNo
WorkflowDescriptionformstringNo
RootWorkflowIDformintNo
TransitionIDformGuidNo
TransitionNameformstringNo
ActivationIDformGuid?No
TypeIDformintNo
TypeDescriptionformstringNo
StatusIDformintNo
StatusDescriptionformstringNo
UserIDformint?No
ActiveformboolNo
OfferedDateformDateTime?No
AssignedDateformDateTime?No
StartDateformDateTime?No
ExpirationDateformDateTime?No
OrderformintNo
Progressformfloat?No
FinishedDateformDateTime?No
FinishedByUserIDformint?No
FinishedDocumentIDformGuid?No
ReadformboolNo
DeferDateformDateTime?No
DeferReasonformstringNo
ReasonformstringNo
UrgentformboolNo
StatusformstringNo
AvailableActionsformIEnumerable<WorkflowTaskActionDTO>No
FinishActionsformIEnumerable<WorkflowTaskActionDTO>No
CommentActionsformIEnumerable<WorkflowTaskActionDTO>No
DocumentActionsformIEnumerable<WorkflowTaskActionDTO>No
NumberOfCommentsformintNo
RelativeDetailLinkformstringNo
FirstSideStepIDformintNo
FirstSideStepOmschrformstringNo
FirstSideStepDetailLinkformstringNo
IsSideStepOfWorkflowIDformint?No
IsSideStepOfWorkflowOmschrformstringNo
IsSideStepOfWorkflowDetailLinkformstringNo
IsSideStepOfTaskIDformint?No
IsSideStepOfTaskOmschrformstringNo
IsSideStepOfTaskDetailLinkformstringNo
IsObservedIDformint?No
IsObservedOmschrformstringNo
IsObservedDetailLinkformstringNo
WorkflowTaskActionDTO Parameters:
NameParameterData TypeRequiredDescription
BeginGroupformboolNo
DigiOfficeIconformstringNo
EnabledformboolNo
FontAwesomeIconformstringNo
HintformstringNo
NameformstringNo
ShowTextForRootItemsformboolNo
TextformstringNo
UrlformstringNo
ItemsformList<WorkflowTaskActionDTO>No

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

HTTP + OTHER

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

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

{"TaskIDs":[0]}

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

{"MultiTask":{"ID":0,"Name":"String","WorkflowID":0,"WorkflowDescription":"String","RootWorkflowID":0,"TransitionID":"00000000-0000-0000-0000-000000000000","TransitionName":"String","ActivationID":"00000000-0000-0000-0000-000000000000","TypeID":0,"TypeDescription":"String","StatusID":0,"StatusDescription":"String","UserID":0,"Active":false,"OfferedDate":"0001-01-01T00:00:00.0000000","AssignedDate":"0001-01-01T00:00:00.0000000","StartDate":"0001-01-01T00:00:00.0000000","ExpirationDate":"0001-01-01T00:00:00.0000000","Order":0,"Progress":0,"FinishedDate":"0001-01-01T00:00:00.0000000","FinishedByUserID":0,"FinishedDocumentID":"00000000-0000-0000-0000-000000000000","Read":false,"DeferDate":"0001-01-01T00:00:00.0000000","DeferReason":"String","Reason":"String","Urgent":false,"Status":"String","AvailableActions":null,"FinishActions":null,"CommentActions":null,"DocumentActions":null,"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]}