DigiOffice Gateway Web Services

<back to all web services

SetWorkflowTaskFinished

Requires Authentication
"use strict";
export class UserOrGroup {
    /** @param {{ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {string} */
    Title;
    /** @type {boolean} */
    IsChecked;
    /** @type {string} */
    Image;
}
export class User extends UserOrGroup {
    /** @param {{Image?:string,ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Image;
}
export class Group extends UserOrGroup {
    /** @param {{Image?:string,ID?:number,Title?:string,IsChecked?:boolean,Image?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Image;
}
export class WorkflowTaskDelay {
    /** @param {{DelayDate?:string,Reason?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    DelayDate;
    /** @type {string} */
    Reason;
}
export class WorkflowTaskReason {
    /** @param {{Reason?:string,Required?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Reason;
    /** @type {boolean} */
    Required;
}
export class WorkflowTaskAdhocTransition {
    /** @param {{ID?:string,Title?:string,AssignmentAllowed?:boolean,AssignmentRequired?:boolean,UserEnvironment?:number,Users?:User[],Groups?:Group[],Delay?:WorkflowTaskDelay,Reason?:WorkflowTaskReason,UsersOrGroups?:UserOrGroup[],Value?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Title;
    /** @type {boolean} */
    AssignmentAllowed;
    /** @type {boolean} */
    AssignmentRequired;
    /** @type {number} */
    UserEnvironment;
    /** @type {User[]} */
    Users;
    /** @type {Group[]} */
    Groups;
    /** @type {WorkflowTaskDelay} */
    Delay;
    /** @type {WorkflowTaskReason} */
    Reason;
    /** @type {UserOrGroup[]} */
    UsersOrGroups;
    /** @type {string} */
    Value;
}
export class AdhocTransitionDetails {
    /** @param {{AdhocTransitions?:WorkflowTaskAdhocTransition[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WorkflowTaskAdhocTransition[]} */
    AdhocTransitions;
}
export class WorkflowTaskActionComment {
    /** @param {{Comment?:string,Required?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Comment;
    /** @type {boolean} */
    Required;
}
export class WorkflowTaskActionDetails extends AdhocTransitionDetails {
    /** @param {{Title?:string,Comment?:WorkflowTaskActionComment,Reason?:WorkflowTaskReason,AdhocTransitions?:WorkflowTaskAdhocTransition[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Title;
    /** @type {WorkflowTaskActionComment} */
    Comment;
    /** @type {WorkflowTaskReason} */
    Reason;
}
export class SetWorkflowTaskFinished {
    /** @param {{ID?:number,ConnectionID?:string,Details?:WorkflowTaskActionDetails}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ID;
    /** @type {?string} */
    ConnectionID;
    /** @type {WorkflowTaskActionDetails} */
    Details;
}

JavaScript SetWorkflowTaskFinished DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/oneway/SetWorkflowTaskFinished HTTP/1.1 
Host: test-dogw.klokgroep.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	ConnectionID: 00000000-0000-0000-0000-000000000000,
	Details: 
	{
		Title: String,
		Comment: 
		{
			Comment: String,
			Required: False
		},
		Reason: 
		{
			Reason: String,
			Required: False
		},
		AdhocTransitions: 
		[
			{
				Title: String,
				AssignmentAllowed: False,
				AssignmentRequired: False,
				UserEnvironment: 0,
				Users: 
				[
					{
						Image: Icons/User,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Groups: 
				[
					{
						Image: Icons/Group,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Delay: 
				{
					DelayDate: 0001-01-01,
					Reason: String
				},
				Reason: 
				{
					Reason: String,
					Required: False
				},
				UsersOrGroups: 
				[
					{
						__type: "IDB.API.DTO.User, IDB.API.DTO",
						Image: Icons/User,
						ID: 0,
						Title: String,
						IsChecked: False
					},
					{
						__type: "IDB.API.DTO.Group, IDB.API.DTO",
						Image: Icons/Group,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Value: "String
String"
			}
		]
	}
}