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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get a multitask.
*/
@Api(Description="Get a multitask.")
open class GetMultiTaskOperation
{
    /**
    * ID of the workflow task(s) to return
    */
    @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    open var TaskIDs:ArrayList<Int> = ArrayList<Int>()
}

open class WorkflowMultiTaskDTO
{
    open var MultiTask:WorkflowTaskDTO? = null
    open var TaskIDs:ArrayList<Int>? = null
}

open class WorkflowTaskDTO
{
    open var ID:Int? = null
    open var Name:String? = null
    open var WorkflowID:Int? = null
    open var WorkflowDescription:String? = null
    open var RootWorkflowID:Int? = null
    open var TransitionID:UUID? = null
    open var TransitionName:String? = null
    open var ActivationID:UUID? = null
    open var TypeID:Int? = null
    open var TypeDescription:String? = null
    open var StatusID:Int? = null
    open var StatusDescription:String? = null
    open var UserID:Int? = null
    open var Active:Boolean? = null
    open var OfferedDate:Date? = null
    open var AssignedDate:Date? = null
    open var StartDate:Date? = null
    open var ExpirationDate:Date? = null
    open var Order:Int? = null
    open var Progress:Float? = null
    open var FinishedDate:Date? = null
    open var FinishedByUserID:Int? = null
    open var FinishedDocumentID:UUID? = null
    open var Read:Boolean? = null
    open var DeferDate:Date? = null
    open var DeferReason:String? = null
    open var Reason:String? = null
    open var Urgent:Boolean? = null
    open var Status:String? = null
    open var AvailableActions:ArrayList<WorkflowTaskActionDTO>? = null
    open var FinishActions:ArrayList<WorkflowTaskActionDTO>? = null
    open var CommentActions:ArrayList<WorkflowTaskActionDTO>? = null
    open var DocumentActions:ArrayList<WorkflowTaskActionDTO>? = null
    open var NumberOfComments:Int? = null
    open var RelativeDetailLink:String? = null
    open var FirstSideStepID:Int? = null
    open var FirstSideStepOmschr:String? = null
    open var FirstSideStepDetailLink:String? = null
    open var IsSideStepOfWorkflowID:Int? = null
    open var IsSideStepOfWorkflowOmschr:String? = null
    open var IsSideStepOfWorkflowDetailLink:String? = null
    open var IsSideStepOfTaskID:Int? = null
    open var IsSideStepOfTaskOmschr:String? = null
    open var IsSideStepOfTaskDetailLink:String? = null
    open var IsObservedID:Int? = null
    open var IsObservedOmschr:String? = null
    open var IsObservedDetailLink:String? = null
}

open class WorkflowTaskActionDTO
{
    open var BeginGroup:Boolean? = null
    open var DigiOfficeIcon:String? = null
    open var Enabled:Boolean? = null
    open var FontAwesomeIcon:String? = null
    open var Hint:String? = null
    open var Name:String? = null
    open var ShowTextForRootItems:Boolean? = null
    open var Text:String? = null
    open var Url:String? = null
    open var Items:ArrayList<WorkflowTaskActionDTO>? = null
}

Kotlin GetMultiTaskOperation 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/workflowmultitasks HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetMultiTaskOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
</GetMultiTaskOperation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowMultiTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <MultiTask>
    <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>
  </MultiTask>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
</WorkflowMultiTaskDTO>