DigiOffice API Services Services

<back to all web services

FinishTaskOperation

Requires Authentication
The following routes are available for this service:
POST/api/workflowtasks/finish
"use strict";
export class WorkflowTransitionDTO {
    /** @param {{ID?:string,Name?:string,AssignmentAtStartWorkflowIsAdHoc?:boolean,AssignmentIsAdHocRequired?:boolean,DeferAtStartWorkflowIsAdHoc?:boolean,IsNext?:boolean,UserIDs?:number[],GroupIDs?:number[],RoleIDs?:number[],DeferUntil?:string,DeferralNote?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    AssignmentAtStartWorkflowIsAdHoc;
    /** @type {boolean} */
    AssignmentIsAdHocRequired;
    /** @type {boolean} */
    DeferAtStartWorkflowIsAdHoc;
    /** @type {boolean} */
    IsNext;
    /** @type {number[]} */
    UserIDs;
    /** @type {number[]} */
    GroupIDs;
    /** @type {number[]} */
    RoleIDs;
    /** @type {?string} */
    DeferUntil;
    /** @type {string} */
    DeferralNote;
}
export class FinishTaskOperation {
    /** @param {{TaskIDs?:number[],WSVerbindingID?:string,Transitions?:WorkflowTransitionDTO[],DeferTo?:string,Reason?:string,Comment?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number[]} */
    TaskIDs;
    /** @type {?string} */
    WSVerbindingID;
    /** @type {WorkflowTransitionDTO[]} */
    Transitions;
    /** @type {?string} */
    DeferTo;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Comment;
}

JavaScript FinishTaskOperation 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 /api/workflowtasks/finish HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinishTaskOperation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.Operations">
  <Comment>String</Comment>
  <DeferTo>0001-01-01T00:00:00</DeferTo>
  <Reason>String</Reason>
  <TaskIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </TaskIDs>
  <Transitions xmlns:d2p1="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs" i:nil="true" />
  <WSVerbindingID>00000000-0000-0000-0000-000000000000</WSVerbindingID>
</FinishTaskOperation>