DigiOffice API Services Services

<back to all web services

StartSideStep

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


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

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

open class AdhocTransitionDetails
{
    open var AdhocTransitions:ArrayList<WorkflowTaskAdhocTransition>? = null
}

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

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

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

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

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

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

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

Kotlin 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: test-do-services.klokgroep.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"}]}}