DigiOffice Gateway Web Services

<back to all web services

StartSideStep

Requires Authentication
namespace IDB.API.DTO

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

    [<AllowNullLiteral>]
    type UserOrGroup() = 
        member val ID:Int32 = new Int32() with get,set
        member val Title:String = null with get,set
        member val IsChecked:Boolean = new Boolean() with get,set
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type User() = 
        inherit UserOrGroup()
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type Group() = 
        inherit UserOrGroup()
        member val Image:String = null with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskDelay() = 
        member val DelayDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Reason:String = null with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskReason() = 
        member val Reason:String = null with get,set
        member val Required:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskAdhocTransition() = 
        member val ID:Guid = new Guid() with get,set
        member val Title:String = null with get,set
        member val AssignmentAllowed:Boolean = new Boolean() with get,set
        member val AssignmentRequired:Boolean = new Boolean() with get,set
        member val UserEnvironment:Int32 = new Int32() with get,set
        member val Users:ResizeArray<User> = new ResizeArray<User>() with get,set
        member val Groups:ResizeArray<Group> = new ResizeArray<Group>() with get,set
        member val Delay:WorkflowTaskDelay = null with get,set
        member val Reason:WorkflowTaskReason = null with get,set
        member val UsersOrGroups:ResizeArray<UserOrGroup> = new ResizeArray<UserOrGroup>() with get,set
        member val Value:String = null with get,set

    [<AllowNullLiteral>]
    type AdhocTransitionDetails() = 
        member val AdhocTransitions:ResizeArray<WorkflowTaskAdhocTransition> = new ResizeArray<WorkflowTaskAdhocTransition>() with get,set

    [<AllowNullLiteral>]
    type WorkflowTaskActionComment() = 
        member val Comment:String = null with get,set
        member val Required:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type SideStepDetails() = 
        inherit AdhocTransitionDetails()
        member val Coordinator:User = null with get,set
        member val Comment:WorkflowTaskActionComment = null with get,set
        member val Urgent:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type StartSideStep() = 
        member val ProcessID:Int32 = new Int32() with get,set
        member val WorkflowTaskID:Int32 = new Int32() with get,set
        member val Details:SideStepDetails = null with get,set

F# StartSideStep 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/oneway/StartSideStep HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ProcessID":0,"WorkflowTaskID":0,"Details":{"Coordinator":{"Image":"Icons/User","ID":0,"Title":"String","IsChecked":false},"Comment":{"Comment":"String","Required":false},"Urgent":false,"AdhocTransitions":[{"ID":"00000000-0000-0000-0000-000000000000","Title":"String","AssignmentAllowed":false,"AssignmentRequired":false,"UserEnvironment":0,"Users":[{"Image":"Icons/User","ID":0,"Title":"String","IsChecked":false}],"Groups":[{"Image":"Icons/Group","ID":0,"Title":"String","IsChecked":false}],"Delay":{"DelayDate":"0001-01-01T00:00:00.0000000","Reason":"String"},"Reason":{"Reason":"String","Required":false},"UsersOrGroups":[{"__type":"IDB.API.DTO.User, IDB.API.DTO","Image":"Icons/User","ID":0,"Title":"String","IsChecked":false},{"__type":"IDB.API.DTO.Group, IDB.API.DTO","Image":"Icons/Group","ID":0,"Title":"String","IsChecked":false}],"Value":"String\r\nString"}]}}