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}
"use strict";
export class WorkflowTaskActionDTO {
    /** @param {{BeginGroup?:boolean,DigiOfficeIcon?:string,Enabled?:boolean,FontAwesomeIcon?:string,Hint?:string,Name?:string,ShowTextForRootItems?:boolean,Text?:string,Url?:string,Items?:WorkflowTaskActionDTO[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    BeginGroup;
    /** @type {string} */
    DigiOfficeIcon;
    /** @type {boolean} */
    Enabled;
    /** @type {string} */
    FontAwesomeIcon;
    /** @type {string} */
    Hint;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    ShowTextForRootItems;
    /** @type {string} */
    Text;
    /** @type {string} */
    Url;
    /** @type {WorkflowTaskActionDTO[]} */
    Items;
}
export class WorkflowTaskDTO {
    /** @param {{ID?:number,Name?:string,WorkflowID?:number,WorkflowDescription?:string,RootWorkflowID?:number,TransitionID?:string,TransitionName?:string,ActivationID?:string,TypeID?:number,TypeDescription?:string,StatusID?:number,StatusDescription?:string,UserID?:number,Active?:boolean,OfferedDate?:string,AssignedDate?:string,StartDate?:string,ExpirationDate?:string,Order?:number,Progress?:number,FinishedDate?:string,FinishedByUserID?:number,FinishedDocumentID?:string,Read?:boolean,DeferDate?:string,DeferReason?:string,Reason?:string,Urgent?:boolean,Status?:string,AvailableActions?:WorkflowTaskActionDTO[],FinishActions?:WorkflowTaskActionDTO[],CommentActions?:WorkflowTaskActionDTO[],DocumentActions?:WorkflowTaskActionDTO[],NumberOfComments?:number,RelativeDetailLink?:string,FirstSideStepID?:number,FirstSideStepOmschr?:string,FirstSideStepDetailLink?:string,IsSideStepOfWorkflowID?:number,IsSideStepOfWorkflowOmschr?:string,IsSideStepOfWorkflowDetailLink?:string,IsSideStepOfTaskID?:number,IsSideStepOfTaskOmschr?:string,IsSideStepOfTaskDetailLink?:string,IsObservedID?:number,IsObservedOmschr?:string,IsObservedDetailLink?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Name;
    /** @type {number} */
    WorkflowID;
    /** @type {string} */
    WorkflowDescription;
    /** @type {number} */
    RootWorkflowID;
    /** @type {string} */
    TransitionID;
    /** @type {string} */
    TransitionName;
    /** @type {?string} */
    ActivationID;
    /** @type {number} */
    TypeID;
    /** @type {string} */
    TypeDescription;
    /** @type {number} */
    StatusID;
    /** @type {string} */
    StatusDescription;
    /** @type {?number} */
    UserID;
    /** @type {boolean} */
    Active;
    /** @type {?string} */
    OfferedDate;
    /** @type {?string} */
    AssignedDate;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    ExpirationDate;
    /** @type {number} */
    Order;
    /** @type {?number} */
    Progress;
    /** @type {?string} */
    FinishedDate;
    /** @type {?number} */
    FinishedByUserID;
    /** @type {?string} */
    FinishedDocumentID;
    /** @type {boolean} */
    Read;
    /** @type {?string} */
    DeferDate;
    /** @type {string} */
    DeferReason;
    /** @type {string} */
    Reason;
    /** @type {boolean} */
    Urgent;
    /** @type {string} */
    Status;
    /** @type {WorkflowTaskActionDTO[]} */
    AvailableActions;
    /** @type {WorkflowTaskActionDTO[]} */
    FinishActions;
    /** @type {WorkflowTaskActionDTO[]} */
    CommentActions;
    /** @type {WorkflowTaskActionDTO[]} */
    DocumentActions;
    /** @type {number} */
    NumberOfComments;
    /** @type {string} */
    RelativeDetailLink;
    /** @type {number} */
    FirstSideStepID;
    /** @type {string} */
    FirstSideStepOmschr;
    /** @type {string} */
    FirstSideStepDetailLink;
    /** @type {?number} */
    IsSideStepOfWorkflowID;
    /** @type {string} */
    IsSideStepOfWorkflowOmschr;
    /** @type {string} */
    IsSideStepOfWorkflowDetailLink;
    /** @type {?number} */
    IsSideStepOfTaskID;
    /** @type {string} */
    IsSideStepOfTaskOmschr;
    /** @type {string} */
    IsSideStepOfTaskDetailLink;
    /** @type {?number} */
    IsObservedID;
    /** @type {string} */
    IsObservedOmschr;
    /** @type {string} */
    IsObservedDetailLink;
}
export class GetTaskOperation {
    /** @param {{TaskID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description ID of the workflow task(s) to return */
    TaskID;
}

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