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 .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/reply/GetSideStepDetails HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

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

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