DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

import Foundation
import ServiceStack

/**
* Get workflow task.
*/
// @Api(Description="Get workflow task.")
public class GetTaskOperation : Codable
{
    /**
    * ID of the workflow task(s) to return
    */
    // @ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)
    public var taskID:Int

    required public init(){}
}

public class WorkflowTaskDTO : Codable
{
    public var id:Int
    public var name:String
    public var workflowID:Int
    public var workflowDescription:String
    public var rootWorkflowID:Int
    public var transitionID:String
    public var transitionName:String
    public var activationID:String?
    public var typeID:Int
    public var typeDescription:String
    public var statusID:Int
    public var statusDescription:String
    public var userID:Int?
    public var active:Bool
    public var offeredDate:Date?
    public var assignedDate:Date?
    public var startDate:Date?
    public var expirationDate:Date?
    public var order:Int
    public var progress:Float?
    public var finishedDate:Date?
    public var finishedByUserID:Int?
    public var finishedDocumentID:String?
    public var read:Bool
    public var deferDate:Date?
    public var deferReason:String
    public var reason:String
    public var urgent:Bool
    public var status:String
    public var availableActions:[WorkflowTaskActionDTO]
    public var finishActions:[WorkflowTaskActionDTO]
    public var commentActions:[WorkflowTaskActionDTO]
    public var documentActions:[WorkflowTaskActionDTO]
    public var numberOfComments:Int
    public var relativeDetailLink:String
    public var firstSideStepID:Int
    public var firstSideStepOmschr:String
    public var firstSideStepDetailLink:String
    public var isSideStepOfWorkflowID:Int?
    public var isSideStepOfWorkflowOmschr:String
    public var isSideStepOfWorkflowDetailLink:String
    public var isSideStepOfTaskID:Int?
    public var isSideStepOfTaskOmschr:String
    public var isSideStepOfTaskDetailLink:String
    public var isObservedID:Int?
    public var isObservedOmschr:String
    public var isObservedDetailLink:String

    required public init(){}
}

public class WorkflowTaskActionDTO : Codable
{
    public var beginGroup:Bool
    public var digiOfficeIcon:String
    public var enabled:Bool
    public var fontAwesomeIcon:String
    public var hint:String
    public var name:String
    public var showTextForRootItems:Bool
    public var text:String
    public var url:String
    public var items:[WorkflowTaskActionDTO]

    required public init(){}
}

Swift 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>