DigiOffice Gateway Web Services

<back to all web services

GetWorkflowTask

Requires Authentication
namespace IDB.API.DTO.Workflow

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WorkflowTaskAction() = 
        member val ID:Int32 = new Int32() with get,set
        member val Title:String = null with get,set
        member val Type:String = null with get,set
        member val UseDialog:Boolean = new Boolean() with get,set
        member val ConnectionID:Guid = new Guid() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type WorkflowTask() = 
        [<DataMember>]
        member val ID:Int32 = new Int32() with get,set

        [<DataMember>]
        member val DocumentID:Guid = new Guid() with get,set

        [<DataMember>]
        member val Title:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val ContextTitle:String = null with get,set

        [<DataMember>]
        member val Project:String = null with get,set

        [<DataMember>]
        member val Relation:String = null with get,set

        [<DataMember>]
        member val ImageKey:String = null with get,set

        [<DataMember>]
        member val Urgent:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsRead:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val AssignmentDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val CompletionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val NumberOfComments:Int32 = new Int32() with get,set

        [<DataMember>]
        member val ExtraField:String = null with get,set

        [<DataMember>]
        member val HasPreview:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Extension:String = null with get,set

        [<DataMember>]
        member val IsInformative:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val HasPendingSideSteps:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Actions:ResizeArray<WorkflowTaskAction> = new ResizeArray<WorkflowTaskAction>() with get,set

        [<DataMember>]
        member val CanAccept:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type GetWorkflowTask() = 
        member val ID:Int32 = new Int32() with get,set
        member val Version:Int32 = new Int32() with get,set

F# 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}