DigiOffice Gateway Web Services

<back to all web services

GetSideStepDetails

Requires Authentication
GetSideStepDetails Parameters:
NameParameterData TypeRequiredDescription
ProcessIDqueryintNo
WorkflowTaskIDqueryintNo
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/reply/GetSideStepDetails HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProcessID: 0,
	WorkflowTaskID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	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"
		}
	]
}