| POST | /api/workflowmultitasks |
|---|
"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 WorkflowMultiTaskDTO {
/** @param {{MultiTask?:WorkflowTaskDTO,TaskIDs?:number[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {WorkflowTaskDTO} */
MultiTask;
/** @type {number[]} */
TaskIDs;
}
export class GetMultiTaskOperation {
/** @param {{TaskIDs?:number[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number[]}
* @description ID of the workflow task(s) to return */
TaskIDs = [];
}
JavaScript GetMultiTaskOperation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/workflowmultitasks HTTP/1.1
Host: test-do-services.klokgroep.nl
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
TaskIDs:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
MultiTask:
{
ID: 0,
Name: String,
WorkflowID: 0,
WorkflowDescription: String,
RootWorkflowID: 0,
TransitionName: String,
ActivationID: 00000000-0000-0000-0000-000000000000,
TypeID: 0,
TypeDescription: String,
StatusID: 0,
StatusDescription: String,
UserID: 0,
Active: False,
OfferedDate: 0001-01-01,
AssignedDate: 0001-01-01,
StartDate: 0001-01-01,
ExpirationDate: 0001-01-01,
Order: 0,
Progress: 0,
FinishedDate: 0001-01-01,
FinishedByUserID: 0,
FinishedDocumentID: 00000000-0000-0000-0000-000000000000,
Read: False,
DeferDate: 0001-01-01,
DeferReason: String,
Reason: String,
Urgent: False,
Status: String,
NumberOfComments: 0,
RelativeDetailLink: String,
FirstSideStepID: 0,
FirstSideStepOmschr: String,
FirstSideStepDetailLink: String,
IsSideStepOfWorkflowID: 0,
IsSideStepOfWorkflowOmschr: String,
IsSideStepOfWorkflowDetailLink: String,
IsSideStepOfTaskID: 0,
IsSideStepOfTaskOmschr: String,
IsSideStepOfTaskDetailLink: String,
IsObservedID: 0,
IsObservedOmschr: String,
IsObservedDetailLink: String
},
TaskIDs:
[
0
]
}