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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/oneway/StartSideStep HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
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: 
		[
			{
				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-01,
					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
String"
			}
		]
	}
}