DigiOffice Gateway Web Services

<back to all web services

StartSideStep

Requires Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class StartSideStep
{
    var ProcessID:Int? = null
    var WorkflowTaskID:Int? = null
    var Details:SideStepDetails? = null
}

open class SideStepDetails : AdhocTransitionDetails()
{
    var Coordinator:User? = null
    var Comment:WorkflowTaskActionComment? = null
    var Urgent:Boolean? = null
}

open class AdhocTransitionDetails
{
    var AdhocTransitions:ArrayList<WorkflowTaskAdhocTransition> = ArrayList<WorkflowTaskAdhocTransition>()
}

open class WorkflowTaskAdhocTransition
{
    var ID:UUID? = null
    var Title:String? = null
    var AssignmentAllowed:Boolean? = null
    var AssignmentRequired:Boolean? = null
    var UserEnvironment:Int? = null
    var Users:ArrayList<User> = ArrayList<User>()
    var Groups:ArrayList<Group> = ArrayList<Group>()
    var Delay:WorkflowTaskDelay? = null
    var Reason:WorkflowTaskReason? = null
    var UsersOrGroups:ArrayList<UserOrGroup> = ArrayList<UserOrGroup>()
    var Value:String? = null
}

open class User : UserOrGroup()
{
    var Image:String? = null
}

open class UserOrGroup
{
    var ID:Int? = null
    var Title:String? = null
    var IsChecked:Boolean? = null
    var Image:String? = null
}

open class Group : UserOrGroup()
{
    var Image:String? = null
}

open class WorkflowTaskDelay
{
    var DelayDate:Date? = null
    var Reason:String? = null
}

open class WorkflowTaskReason
{
    var Reason:String? = null
    var Required:Boolean? = null
}

open class WorkflowTaskActionComment
{
    var Comment:String? = null
    var Required:Boolean? = null
}

Kotlin StartSideStep 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.

POST /csv/oneway/StartSideStep HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
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"}]}}