DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.API.DTO.Workflow.Operations;
using IDB.API.DTO.Workflow;

namespace IDB.API.DTO.Workflow
{
    [DataContract]
    public partial class WorkflowTask
    {
        public WorkflowTask()
        {
            Actions = new List<WorkflowTaskAction>{};
        }

        [DataMember]
        public virtual int ID { get; set; }

        [DataMember]
        public virtual Guid DocumentID { get; set; }

        [DataMember]
        public virtual string Title { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual string ContextTitle { get; set; }

        [DataMember]
        public virtual string Project { get; set; }

        [DataMember]
        public virtual string Relation { get; set; }

        [DataMember]
        public virtual string ImageKey { get; set; }

        [DataMember]
        public virtual bool Urgent { get; set; }

        [DataMember]
        public virtual bool IsRead { get; set; }

        [DataMember]
        public virtual DateTime? AssignmentDate { get; set; }

        [DataMember]
        public virtual DateTime? CompletionDate { get; set; }

        [DataMember]
        public virtual int NumberOfComments { get; set; }

        [DataMember]
        public virtual string ExtraField { get; set; }

        [DataMember]
        public virtual bool HasPreview { get; set; }

        [DataMember]
        public virtual string Extension { get; set; }

        [DataMember]
        public virtual bool IsInformative { get; set; }

        [DataMember]
        public virtual bool HasPendingSideSteps { get; set; }

        [DataMember]
        public virtual List<WorkflowTaskAction> Actions { get; set; }

        [DataMember]
        public virtual bool CanAccept { get; set; }
    }

    public partial class WorkflowTaskAction
    {
        public virtual int ID { get; set; }
        public virtual string Title { get; set; }
        public virtual string Type { get; set; }
        public virtual bool UseDialog { get; set; }
        public virtual Guid ConnectionID { get; set; }
    }

}

namespace IDB.API.DTO.Workflow.Operations
{
    public partial class GetWorkflowTask
        : IHasVersion
    {
        public virtual int ID { get; set; }
        public virtual int Version { get; set; }
    }

}

C# 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
}