DigiOffice API Services Services

<back to all web services

GetTaskOperation

Get workflow task.

Requires Authentication
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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkflowTaskDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.Workflow.API.DTOs">
  <ActivationID>00000000-0000-0000-0000-000000000000</ActivationID>
  <Active>false</Active>
  <AssignedDate>0001-01-01T00:00:00</AssignedDate>
  <AvailableActions i:nil="true" />
  <CommentActions i:nil="true" />
  <DeferDate>0001-01-01T00:00:00</DeferDate>
  <DeferReason>String</DeferReason>
  <DocumentActions i:nil="true" />
  <ExpirationDate>0001-01-01T00:00:00</ExpirationDate>
  <FinishActions i:nil="true" />
  <FinishedByUserID>0</FinishedByUserID>
  <FinishedDate>0001-01-01T00:00:00</FinishedDate>
  <FinishedDocumentID>00000000-0000-0000-0000-000000000000</FinishedDocumentID>
  <FirstSideStepDetailLink>String</FirstSideStepDetailLink>
  <FirstSideStepID>0</FirstSideStepID>
  <FirstSideStepOmschr>String</FirstSideStepOmschr>
  <ID>0</ID>
  <IsObservedDetailLink>String</IsObservedDetailLink>
  <IsObservedID>0</IsObservedID>
  <IsObservedOmschr>String</IsObservedOmschr>
  <IsSideStepOfTaskDetailLink>String</IsSideStepOfTaskDetailLink>
  <IsSideStepOfTaskID>0</IsSideStepOfTaskID>
  <IsSideStepOfTaskOmschr>String</IsSideStepOfTaskOmschr>
  <IsSideStepOfWorkflowDetailLink>String</IsSideStepOfWorkflowDetailLink>
  <IsSideStepOfWorkflowID>0</IsSideStepOfWorkflowID>
  <IsSideStepOfWorkflowOmschr>String</IsSideStepOfWorkflowOmschr>
  <Name>String</Name>
  <NumberOfComments>0</NumberOfComments>
  <OfferedDate>0001-01-01T00:00:00</OfferedDate>
  <Order>0</Order>
  <Progress>0</Progress>
  <Read>false</Read>
  <Reason>String</Reason>
  <RelativeDetailLink>String</RelativeDetailLink>
  <RootWorkflowID>0</RootWorkflowID>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <Status>String</Status>
  <StatusDescription>String</StatusDescription>
  <StatusID>0</StatusID>
  <TransitionID>00000000-0000-0000-0000-000000000000</TransitionID>
  <TransitionName>String</TransitionName>
  <TypeDescription>String</TypeDescription>
  <TypeID>0</TypeID>
  <Urgent>false</Urgent>
  <UserID>0</UserID>
  <WorkflowDescription>String</WorkflowDescription>
  <WorkflowID>0</WorkflowID>
</WorkflowTaskDTO>