DigiOffice Gateway Web Services

<back to all web services

GetProcessDetailsRegistrationForm

Requires Authentication
The following routes are available for this service:
POST/api/processes/registrationform
GetProcessDetailsRegistrationForm Parameters:
NameParameterData TypeRequiredDescription
ProcessIDbodyintNo
RegistrationprofileIDbodyGuidNo
DocumentIDbodyGuid?No
CurrentRegistrationprofileFieldValuesbodyList<RegistrationProfileFieldValue>No
IsOffice365ContextbodyboolNo
RegistrationProfileFieldValue Parameters:
NameParameterData TypeRequiredDescription
DocumentFieldIDformGuidNo
ValueformstringNo
ShadowValueformstringNo
IsModifiedByUserformboolNo
ProcessDetails Parameters:
NameParameterData TypeRequiredDescription
ShowCoordinatorFieldformboolNo
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 .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 /api/processes/registrationform HTTP/1.1 
Host: doapigw.baasbv.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"__type":"IDB.API.DTO.Workflow.Operations.GetProcessDetailsRegistrationForm, IDB.API.DTO","ProcessID":0,"RegistrationprofileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","CurrentRegistrationprofileFieldValues":[{"__type":"IDB.API.DTO.Registrationprofile.RegistrationProfileFieldValue, IDB.API.DTO","DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IsOffice365Context":false}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"__type":"IDB.API.DTO.Workflow.ProcessDetails, IDB.API.DTO","ShowCoordinatorField":false,"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","ID":"00000000-0000-0000-0000-000000000000","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-01T00:00:00.0000000","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\r\nString"}]}