DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication

export class WorkflowTaskAction
{
    public ID?: number;
    public Title?: string;
    public Type?: string;
    public UseDialog?: boolean;
    public ConnectionID?: string;

    public constructor(init?: Partial<WorkflowTaskAction>) { (Object as any).assign(this, init); }
}

// @DataContract
export class WorkflowTask
{
    // @DataMember
    public ID?: number;

    // @DataMember
    public DocumentID?: string;

    // @DataMember
    public Title?: string;

    // @DataMember
    public Description?: string;

    // @DataMember
    public ContextTitle?: string;

    // @DataMember
    public Project?: string;

    // @DataMember
    public Relation?: string;

    // @DataMember
    public ImageKey?: string;

    // @DataMember
    public Urgent?: boolean;

    // @DataMember
    public IsRead?: boolean;

    // @DataMember
    public AssignmentDate?: string;

    // @DataMember
    public CompletionDate?: string;

    // @DataMember
    public NumberOfComments?: number;

    // @DataMember
    public ExtraField?: string;

    // @DataMember
    public HasPreview?: boolean;

    // @DataMember
    public Extension?: string;

    // @DataMember
    public IsInformative?: boolean;

    // @DataMember
    public HasPendingSideSteps?: boolean;

    // @DataMember
    public Actions?: WorkflowTaskAction[];

    // @DataMember
    public CanAccept?: boolean;

    public constructor(init?: Partial<WorkflowTask>) { (Object as any).assign(this, init); }
}

export class GetWorkflowTask implements IHasVersion
{
    public ID?: number;
    public Version?: number;

    public constructor(init?: Partial<GetWorkflowTask>) { (Object as any).assign(this, init); }
}

TypeScript 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
}