DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
GetWorkflowTask Parameters:
NameParameterData TypeRequiredDescription
IDqueryintNo
VersionqueryintNo
WorkflowTask Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
DocumentIDformGuidNo
TitleformstringNo
DescriptionformstringNo
ContextTitleformstringNo
ProjectformstringNo
RelationformstringNo
ImageKeyformstringNo
UrgentformboolNo
IsReadformboolNo
AssignmentDateformDateTime?No
CompletionDateformDateTime?No
NumberOfCommentsformintNo
ExtraFieldformstringNo
HasPreviewformboolNo
ExtensionformstringNo
IsInformativeformboolNo
HasPendingSideStepsformboolNo
ActionsformList<WorkflowTaskAction>No
CanAcceptformboolNo
WorkflowTaskAction Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
TypeformstringNo
UseDialogformboolNo
ConnectionIDformGuidNo

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/reply/GetWorkflowTask HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	Version: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0,
	Title: String,
	Description: String,
	ContextTitle: String,
	Project: String,
	Relation: String,
	ImageKey: String,
	Urgent: False,
	IsRead: False,
	AssignmentDate: 0001-01-01,
	CompletionDate: 0001-01-01,
	NumberOfComments: 0,
	ExtraField: String,
	HasPreview: False,
	Extension: String,
	IsInformative: False,
	HasPendingSideSteps: False,
	Actions: 
	[
		{
			ID: 0,
			Title: String,
			Type: String,
			UseDialog: False
		}
	],
	CanAccept: False
}