DigiOffice API Services Services

<back to all web services

GetTaskForEntityOperation

Get workflow tasks for entity.

Requires Authentication
The following routes are available for this service:
GET/api/workflowtasks/{EntityName}/{EntityID}
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

Namespace Global

    Namespace IDB.Workflow.API.Operations

        '''<Summary>
        '''Get workflow tasks for entity.
        '''</Summary>
        <Api(Description:="Get workflow tasks for entity.")>
        Public Partial Class GetTaskForEntityOperation
            '''<Summary>
            '''Name of the entity
            '''</Summary>
            <ApiMember(Description:="Name of the entity", IsRequired:=true)>
            Public Overridable Property EntityName As String

            '''<Summary>
            '''Primary key of the entity
            '''</Summary>
            <ApiMember(Description:="Primary key of the entity", IsRequired:=true)>
            Public Overridable Property EntityID As String
        End Class
    End Namespace
End Namespace

VB.NET GetTaskForEntityOperation 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/{EntityName}/{EntityID} 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"}]