DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

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

Namespace Global

    Namespace IDB.API.DTO.Workflow

        <DataContract>
        Public Partial Class WorkflowTask
            Public Sub New()
                Actions = New List(Of WorkflowTaskAction)
            End Sub

            <DataMember>
            Public Overridable Property ID As Integer

            <DataMember>
            Public Overridable Property DocumentID As Guid

            <DataMember>
            Public Overridable Property Title As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property ContextTitle As String

            <DataMember>
            Public Overridable Property Project As String

            <DataMember>
            Public Overridable Property Relation As String

            <DataMember>
            Public Overridable Property ImageKey As String

            <DataMember>
            Public Overridable Property Urgent As Boolean

            <DataMember>
            Public Overridable Property IsRead As Boolean

            <DataMember>
            Public Overridable Property AssignmentDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property CompletionDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property NumberOfComments As Integer

            <DataMember>
            Public Overridable Property ExtraField As String

            <DataMember>
            Public Overridable Property HasPreview As Boolean

            <DataMember>
            Public Overridable Property Extension As String

            <DataMember>
            Public Overridable Property IsInformative As Boolean

            <DataMember>
            Public Overridable Property HasPendingSideSteps As Boolean

            <DataMember>
            Public Overridable Property Actions As List(Of WorkflowTaskAction)

            <DataMember>
            Public Overridable Property CanAccept As Boolean
        End Class

        Public Partial Class WorkflowTaskAction
            Public Overridable Property ID As Integer
            Public Overridable Property Title As String
            Public Overridable Property Type As String
            Public Overridable Property UseDialog As Boolean
            Public Overridable Property ConnectionID As Guid
        End Class
    End Namespace

    Namespace IDB.API.DTO.Workflow.Operations

        Public Partial Class GetWorkflowTask
            Implements IHasVersion
            Public Overridable Property ID As Integer
            Public Overridable Property Version As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetWorkflowTask DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/GetWorkflowTask HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ID":0,"Version":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ID":0,"DocumentID":"00000000-0000-0000-0000-000000000000","Title":"String","Description":"String","ContextTitle":"String","Project":"String","Relation":"String","ImageKey":"String","Urgent":false,"IsRead":false,"AssignmentDate":"0001-01-01T00:00:00.0000000","CompletionDate":"0001-01-01T00:00:00.0000000","NumberOfComments":0,"ExtraField":"String","HasPreview":false,"Extension":"String","IsInformative":false,"HasPendingSideSteps":false,"Actions":[{"ID":0,"Title":"String","Type":"String","UseDialog":false,"ConnectionID":"00000000-0000-0000-0000-000000000000"}],"CanAccept":false}