DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
"use strict";
export class WorkflowTaskAction {
    /** @param {{ID?:number,Title?:string,Type?:string,UseDialog?:boolean,ConnectionID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Title;
    /** @type {string} */
    Type;
    /** @type {boolean} */
    UseDialog;
    /** @type {string} */
    ConnectionID;
}
export class WorkflowTask {
    /** @param {{ID?:number,DocumentID?:string,Title?:string,Description?:string,ContextTitle?:string,Project?:string,Relation?:string,ImageKey?:string,Urgent?:boolean,IsRead?:boolean,AssignmentDate?:string,CompletionDate?:string,NumberOfComments?:number,ExtraField?:string,HasPreview?:boolean,Extension?:string,IsInformative?:boolean,HasPendingSideSteps?:boolean,Actions?:WorkflowTaskAction[],CanAccept?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    DocumentID;
    /** @type {string} */
    Title;
    /** @type {string} */
    Description;
    /** @type {string} */
    ContextTitle;
    /** @type {string} */
    Project;
    /** @type {string} */
    Relation;
    /** @type {string} */
    ImageKey;
    /** @type {boolean} */
    Urgent;
    /** @type {boolean} */
    IsRead;
    /** @type {?string} */
    AssignmentDate;
    /** @type {?string} */
    CompletionDate;
    /** @type {number} */
    NumberOfComments;
    /** @type {string} */
    ExtraField;
    /** @type {boolean} */
    HasPreview;
    /** @type {string} */
    Extension;
    /** @type {boolean} */
    IsInformative;
    /** @type {boolean} */
    HasPendingSideSteps;
    /** @type {WorkflowTaskAction[]} */
    Actions;
    /** @type {boolean} */
    CanAccept;
}
export class GetWorkflowTask {
    /** @param {{ID?:number,Version?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {number} */
    Version;
}

JavaScript GetWorkflowTask 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 /xml/reply/GetWorkflowTask HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetWorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow.Operations">
  <ID>0</ID>
  <Version>0</Version>
</GetWorkflowTask>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Workflow">
  <Actions>
    <WorkflowTaskAction>
      <ConnectionID>00000000-0000-0000-0000-000000000000</ConnectionID>
      <ID>0</ID>
      <Title>String</Title>
      <Type>String</Type>
      <UseDialog>false</UseDialog>
    </WorkflowTaskAction>
  </Actions>
  <AssignmentDate>0001-01-01T00:00:00</AssignmentDate>
  <CanAccept>false</CanAccept>
  <CompletionDate>0001-01-01T00:00:00</CompletionDate>
  <ContextTitle>String</ContextTitle>
  <Description>String</Description>
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <Extension>String</Extension>
  <ExtraField>String</ExtraField>
  <HasPendingSideSteps>false</HasPendingSideSteps>
  <HasPreview>false</HasPreview>
  <ID>0</ID>
  <ImageKey>String</ImageKey>
  <IsInformative>false</IsInformative>
  <IsRead>false</IsRead>
  <NumberOfComments>0</NumberOfComments>
  <Project>String</Project>
  <Relation>String</Relation>
  <Title>String</Title>
  <Urgent>false</Urgent>
</WorkflowTask>