DigiOffice API Services Services

GetTaskOperation

Get workflow task.

The following routes are available for this service:
GET	/api/workflowtasks/{TaskID}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get workflow task.
*/
@Api(Description="Get workflow task.")
open class GetTaskOperation
{
    /**
    * ID of the workflow task(s) to return
    */
    @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    open var TaskID: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 GetTaskOperation DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

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

{"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"}