DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

Requires Authentication
The following routes are available for this service:
GET/api/workflowtasks/{TaskID}
namespace IDB.Workflow.API.DTOs

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowTaskActionDTO() = 
        member val BeginGroup:Boolean = new Boolean() with get,set
        member val DigiOfficeIcon:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val FontAwesomeIcon:String = null with get,set
        member val Hint:String = null with get,set
        member val Name:String = null with get,set
        member val ShowTextForRootItems:Boolean = new Boolean() with get,set
        member val Text:String = null with get,set
        member val Url:String = null with get,set
        member val Items:ResizeArray<WorkflowTaskActionDTO> = null with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskDTO() = 
        member val ID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val WorkflowID:Int32 = new Int32() with get,set
        member val WorkflowDescription:String = null with get,set
        member val RootWorkflowID:Int32 = new Int32() with get,set
        member val TransitionID:Guid = new Guid() with get,set
        member val TransitionName:String = null with get,set
        member val ActivationID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val TypeID:Int32 = new Int32() with get,set
        member val TypeDescription:String = null with get,set
        member val StatusID:Int32 = new Int32() with get,set
        member val StatusDescription:String = null with get,set
        member val UserID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val OfferedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AssignedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val StartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExpirationDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Order:Int32 = new Int32() with get,set
        member val Progress:Nullable<Single> = new Nullable<Single>() with get,set
        member val FinishedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FinishedByUserID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FinishedDocumentID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Read:Boolean = new Boolean() with get,set
        member val DeferDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DeferReason:String = null with get,set
        member val Reason:String = null with get,set
        member val Urgent:Boolean = new Boolean() with get,set
        member val Status:String = null with get,set
        member val AvailableActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val FinishActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val CommentActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val DocumentActions:IEnumerable<WorkflowTaskActionDTO> = null with get,set
        member val NumberOfComments:Int32 = new Int32() with get,set
        member val RelativeDetailLink:String = null with get,set
        member val FirstSideStepID:Int32 = new Int32() with get,set
        member val FirstSideStepOmschr:String = null with get,set
        member val FirstSideStepDetailLink:String = null with get,set
        member val IsSideStepOfWorkflowID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsSideStepOfWorkflowOmschr:String = null with get,set
        member val IsSideStepOfWorkflowDetailLink:String = null with get,set
        member val IsSideStepOfTaskID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsSideStepOfTaskOmschr:String = null with get,set
        member val IsSideStepOfTaskDetailLink:String = null with get,set
        member val IsObservedID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsObservedOmschr:String = null with get,set
        member val IsObservedDetailLink:String = null with get,set

    ///<summary>
    ///Get workflow task.
    ///</summary>
    [<Api(Description="Get workflow task.")>]
    [<AllowNullLiteral>]
    type GetTaskOperation() = 
        ///<summary>
        ///ID of the workflow task(s) to return
        ///</summary>
        [<ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)>]
        member val TaskID:Int32 = new Int32() with get,set

F# GetTaskOperation 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.

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>