DigiOffice API Services Services

GetTaskOperation

Get workflow task.

The following routes are available for this service:
GET	/api/workflowtasks/{TaskID}

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using IDB.Workflow.API.Operations;
using IDB.Workflow.API.DTOs;

namespace IDB.Workflow.API.DTOs
{
    public partial class WorkflowTaskActionDTO
    {
        public virtual bool BeginGroup { get; set; }
        public virtual string DigiOfficeIcon { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual string FontAwesomeIcon { get; set; }
        public virtual string Hint { get; set; }
        public virtual string Name { get; set; }
        public virtual bool ShowTextForRootItems { get; set; }
        public virtual string Text { get; set; }
        public virtual string Url { get; set; }
        public virtual List<WorkflowTaskActionDTO> Items { get; set; }
    }

    public partial class WorkflowTaskDTO
    {
        public virtual int ID { get; set; }
        public virtual string Name { get; set; }
        public virtual int WorkflowID { get; set; }
        public virtual string WorkflowDescription { get; set; }
        public virtual int RootWorkflowID { get; set; }
        public virtual Guid TransitionID { get; set; }
        public virtual string TransitionName { get; set; }
        public virtual Guid? ActivationID { get; set; }
        public virtual int TypeID { get; set; }
        public virtual string TypeDescription { get; set; }
        public virtual int StatusID { get; set; }
        public virtual string StatusDescription { get; set; }
        public virtual int? UserID { get; set; }
        public virtual bool Active { get; set; }
        public virtual DateTime? OfferedDate { get; set; }
        public virtual DateTime? AssignedDate { get; set; }
        public virtual DateTime? StartDate { get; set; }
        public virtual DateTime? ExpirationDate { get; set; }
        public virtual int Order { get; set; }
        public virtual float? Progress { get; set; }
        public virtual DateTime? FinishedDate { get; set; }
        public virtual int? FinishedByUserID { get; set; }
        public virtual Guid? FinishedDocumentID { get; set; }
        public virtual bool Read { get; set; }
        public virtual DateTime? DeferDate { get; set; }
        public virtual string DeferReason { get; set; }
        public virtual string Reason { get; set; }
        public virtual bool Urgent { get; set; }
        public virtual string Status { get; set; }
        public virtual IEnumerable<WorkflowTaskActionDTO> AvailableActions { get; set; }
        public virtual IEnumerable<WorkflowTaskActionDTO> FinishActions { get; set; }
        public virtual IEnumerable<WorkflowTaskActionDTO> CommentActions { get; set; }
        public virtual IEnumerable<WorkflowTaskActionDTO> DocumentActions { get; set; }
        public virtual int NumberOfComments { get; set; }
        public virtual string RelativeDetailLink { get; set; }
        public virtual int FirstSideStepID { get; set; }
        public virtual string FirstSideStepOmschr { get; set; }
        public virtual string FirstSideStepDetailLink { get; set; }
        public virtual int? IsSideStepOfWorkflowID { get; set; }
        public virtual string IsSideStepOfWorkflowOmschr { get; set; }
        public virtual string IsSideStepOfWorkflowDetailLink { get; set; }
        public virtual int? IsSideStepOfTaskID { get; set; }
        public virtual string IsSideStepOfTaskOmschr { get; set; }
        public virtual string IsSideStepOfTaskDetailLink { get; set; }
        public virtual int? IsObservedID { get; set; }
        public virtual string IsObservedOmschr { get; set; }
        public virtual string IsObservedDetailLink { get; set; }
    }

}

namespace IDB.Workflow.API.Operations
{
    ///<summary>
    ///Get workflow task.
    ///</summary>
    [Api(Description="Get workflow task.")]
    public partial class GetTaskOperation
    {
        ///<summary>
        ///ID of the workflow task(s) to return
        ///</summary>
        [ApiMember(Description="ID of the workflow task(s) to return", IsRequired=true)]
        public virtual int TaskID { get; set; }
    }

}

C# GetTaskOperation DTOs

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

HTTP + OTHER

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

GET /api/workflowtasks/{TaskID} HTTP/1.1 
Host: test-do-services.klokgroep.nl 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ID":0,"Name":"String","WorkflowID":0,"WorkflowDescription":"String","RootWorkflowID":0,"TransitionID":"00000000-0000-0000-0000-000000000000","TransitionName":"String","ActivationID":"00000000-0000-0000-0000-000000000000","TypeID":0,"TypeDescription":"String","StatusID":0,"StatusDescription":"String","UserID":0,"Active":false,"OfferedDate":"0001-01-01T00:00:00.0000000","AssignedDate":"0001-01-01T00:00:00.0000000","StartDate":"0001-01-01T00:00:00.0000000","ExpirationDate":"0001-01-01T00:00:00.0000000","Order":0,"Progress":0,"FinishedDate":"0001-01-01T00:00:00.0000000","FinishedByUserID":0,"FinishedDocumentID":"00000000-0000-0000-0000-000000000000","Read":false,"DeferDate":"0001-01-01T00:00:00.0000000","DeferReason":"String","Reason":"String","Urgent":false,"Status":"String","AvailableActions":null,"FinishActions":null,"CommentActions":null,"DocumentActions":null,"NumberOfComments":0,"RelativeDetailLink":"String","FirstSideStepID":0,"FirstSideStepOmschr":"String","FirstSideStepDetailLink":"String","IsSideStepOfWorkflowID":0,"IsSideStepOfWorkflowOmschr":"String","IsSideStepOfWorkflowDetailLink":"String","IsSideStepOfTaskID":0,"IsSideStepOfTaskOmschr":"String","IsSideStepOfTaskDetailLink":"String","IsObservedID":0,"IsObservedOmschr":"String","IsObservedDetailLink":"String"}