DigiOffice Gateway Web Services

<back to all web services

StartSideStep

Requires Authentication
StartSideStep Parameters:
NameParameterData TypeRequiredDescription
ProcessIDqueryintNo
WorkflowTaskIDqueryintNo
DetailsquerySideStepDetailsNo
SideStepDetails Parameters:
NameParameterData TypeRequiredDescription
CoordinatorformUserNo
CommentformWorkflowTaskActionCommentNo
UrgentformboolNo
AdhocTransitionDetails Parameters:
NameParameterData TypeRequiredDescription
AdhocTransitionsformList<WorkflowTaskAdhocTransition>No
WorkflowTaskAdhocTransition Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
TitleformstringNo
AssignmentAllowedformboolNo
AssignmentRequiredformboolNo
UserEnvironmentformintNo
UsersformList<User>No
GroupsformList<Group>No
DelayformWorkflowTaskDelayNo
ReasonformWorkflowTaskReasonNo
UsersOrGroupsformList<UserOrGroup>No
ValueformstringNo
User Parameters:
NameParameterData TypeRequiredDescription
ImageformstringNo
UserOrGroup Parameters:
NameParameterData TypeRequiredDescription
IDformintNo
TitleformstringNo
IsCheckedformboolNo
ImageformstringNo
Group Parameters:
NameParameterData TypeRequiredDescription
ImageformstringNo
WorkflowTaskDelay Parameters:
NameParameterData TypeRequiredDescription
DelayDateformDateTime?No
ReasonformstringNo
WorkflowTaskReason Parameters:
NameParameterData TypeRequiredDescription
ReasonformstringNo
RequiredformboolNo
WorkflowTaskActionComment Parameters:
NameParameterData TypeRequiredDescription
CommentformstringNo
RequiredformboolNo

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: doapigw.baasbv.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	__type: "IDB.API.DTO.Workflow.Operations.StartSideStep, IDB.API.DTO",
	ProcessID: 0,
	WorkflowTaskID: 0,
	Details: 
	{
		__type: "IDB.API.DTO.Workflow.SideStepDetails, IDB.API.DTO",
		Coordinator: 
		{
			__type: "IDB.API.DTO.User, IDB.API.DTO",
			Image: Icons/User,
			ID: 0,
			Title: String,
			IsChecked: False
		},
		Comment: 
		{
			__type: "IDB.API.DTO.Workflow.WorkflowTaskActionComment, IDB.API.DTO",
			Comment: String,
			Required: False
		},
		Urgent: False,
		AdhocTransitions: 
		[
			{
				__type: "IDB.API.DTO.Workflow.WorkflowTaskAdhocTransition, IDB.API.DTO",
				Title: String,
				AssignmentAllowed: False,
				AssignmentRequired: False,
				UserEnvironment: 0,
				Users: 
				[
					{
						__type: "IDB.API.DTO.User, IDB.API.DTO",
						Image: Icons/User,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Groups: 
				[
					{
						__type: "IDB.API.DTO.Group, IDB.API.DTO",
						Image: Icons/Group,
						ID: 0,
						Title: String,
						IsChecked: False
					}
				],
				Delay: 
				{
					__type: "IDB.API.DTO.Workflow.WorkflowTaskDelay, IDB.API.DTO",
					DelayDate: 0001-01-01,
					Reason: String
				},
				Reason: 
				{
					__type: "IDB.API.DTO.Workflow.WorkflowTaskReason, IDB.API.DTO",
					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"
			}
		]
	}
}