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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports IDB.Workflow.API.Operations
Imports IDB.Workflow.API.DTOs

Namespace Global

    Namespace IDB.Workflow.API.DTOs

        Public Partial Class WorkflowTaskActionDTO
            Public Overridable Property BeginGroup As Boolean
            Public Overridable Property DigiOfficeIcon As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property FontAwesomeIcon As String
            Public Overridable Property Hint As String
            Public Overridable Property Name As String
            Public Overridable Property ShowTextForRootItems As Boolean
            Public Overridable Property Text As String
            Public Overridable Property Url As String
            Public Overridable Property Items As List(Of WorkflowTaskActionDTO)
        End Class

        Public Partial Class WorkflowTaskDTO
            Public Overridable Property ID As Integer
            Public Overridable Property Name As String
            Public Overridable Property WorkflowID As Integer
            Public Overridable Property WorkflowDescription As String
            Public Overridable Property RootWorkflowID As Integer
            Public Overridable Property TransitionID As Guid
            Public Overridable Property TransitionName As String
            Public Overridable Property ActivationID As Guid?
            Public Overridable Property TypeID As Integer
            Public Overridable Property TypeDescription As String
            Public Overridable Property StatusID As Integer
            Public Overridable Property StatusDescription As String
            Public Overridable Property UserID As Integer?
            Public Overridable Property Active As Boolean
            Public Overridable Property OfferedDate As Date?
            Public Overridable Property AssignedDate As Date?
            Public Overridable Property StartDate As Date?
            Public Overridable Property ExpirationDate As Date?
            Public Overridable Property Order As Integer
            Public Overridable Property Progress As Single?
            Public Overridable Property FinishedDate As Date?
            Public Overridable Property FinishedByUserID As Integer?
            Public Overridable Property FinishedDocumentID As Guid?
            Public Overridable Property Read As Boolean
            Public Overridable Property DeferDate As Date?
            Public Overridable Property DeferReason As String
            Public Overridable Property Reason As String
            Public Overridable Property Urgent As Boolean
            Public Overridable Property Status As String
            Public Overridable Property AvailableActions As IEnumerable(Of WorkflowTaskActionDTO)
            Public Overridable Property FinishActions As IEnumerable(Of WorkflowTaskActionDTO)
            Public Overridable Property CommentActions As IEnumerable(Of WorkflowTaskActionDTO)
            Public Overridable Property DocumentActions As IEnumerable(Of WorkflowTaskActionDTO)
            Public Overridable Property NumberOfComments As Integer
            Public Overridable Property RelativeDetailLink As String
            Public Overridable Property FirstSideStepID As Integer
            Public Overridable Property FirstSideStepOmschr As String
            Public Overridable Property FirstSideStepDetailLink As String
            Public Overridable Property IsSideStepOfWorkflowID As Integer?
            Public Overridable Property IsSideStepOfWorkflowOmschr As String
            Public Overridable Property IsSideStepOfWorkflowDetailLink As String
            Public Overridable Property IsSideStepOfTaskID As Integer?
            Public Overridable Property IsSideStepOfTaskOmschr As String
            Public Overridable Property IsSideStepOfTaskDetailLink As String
            Public Overridable Property IsObservedID As Integer?
            Public Overridable Property IsObservedOmschr As String
            Public Overridable Property IsObservedDetailLink As String
        End Class
    End Namespace

    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 Overridable Property TaskID As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetTaskOperation DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}