DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetWorkflowTask : IHasVersion
{
    var ID:Int? = null
    var Version:Int? = null
}

@DataContract
open class WorkflowTask
{
    @DataMember
    var ID:Int? = null

    @DataMember
    var DocumentID:UUID? = null

    @DataMember
    var Title:String? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var ContextTitle:String? = null

    @DataMember
    var Project:String? = null

    @DataMember
    var Relation:String? = null

    @DataMember
    var ImageKey:String? = null

    @DataMember
    var Urgent:Boolean? = null

    @DataMember
    var IsRead:Boolean? = null

    @DataMember
    var AssignmentDate:Date? = null

    @DataMember
    var CompletionDate:Date? = null

    @DataMember
    var NumberOfComments:Int? = null

    @DataMember
    var ExtraField:String? = null

    @DataMember
    var HasPreview:Boolean? = null

    @DataMember
    var Extension:String? = null

    @DataMember
    var IsInformative:Boolean? = null

    @DataMember
    var HasPendingSideSteps:Boolean? = null

    @DataMember
    var Actions:ArrayList<WorkflowTaskAction> = ArrayList<WorkflowTaskAction>()

    @DataMember
    var CanAccept:Boolean? = null
}

open class WorkflowTaskAction
{
    var ID:Int? = null
    var Title:String? = null
    var Type:String? = null
    var UseDialog:Boolean? = null
    var ConnectionID:UUID? = null
}

Kotlin GetWorkflowTask 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/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
}