API routes (Click a route to expand it, click here to expand/collapse all)
Action API
GET/actions/{idREDSet} ⎘Authentication required
Returns applicable ActionSequences w.r.t. authenticated customer, department, user and given REDSet.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No Contextual REDSet ID
idGroups URI-Query int[] No Must contain at least the primary REDGroup, the other groups are irrelevant.
Response HTTP Type Description
Success 200 ActionSequence[] Array of ActionSequences
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
POST/actions/{name} ⎘Authentication required
Executes the referred ActionSequence. Only use this method for first time initiations. If input is missing, invalid or when there are exceptions, the ActionSequenceMultipleException will have an idRun property. Invoke to /action/{name}/{idRun} on subsequent calls/attempts.
Parameter Location Type Requirements Optional Default value Description
name URI-Path string No Name of the ActionSequence
input POST-body string
format: json
 No JSON-stringified input data
Response HTTP Type Description
Success 200 { name: string, result: any }[] Array of results corresponding to the Actions of the executed ActionSequence
ActionInputException 200 Some inputs are missing and/or invalid. Note that this exception is also used to merely communicate the expected inputs and their options/details.
ActionSequenceMultipleException 400 One or more exceptions occurred during execution. Details contains the idRun (to continue after fixing input) and a list of exceptions, each with 4 keys: code, description, details, httpCode.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
POST/actions/{name}/{idRun} ⎘Authentication required
Continues the execution of a priorly invoked ActionSequence that did not complete yet, due to either missing/invalid input or an exception.
Parameter Location Type Requirements Optional Default value Description
name URI-Path string No Name of the ActionSequence
idRun URI-Path string No idRun returned by a prior attempt. Can be found on the returned ActionSequenceMultipleException.
input POST-body string
format: json
 No JSON-stringified input data
Response HTTP Type Description
Success 200 { name: string, result: any }[] Array of results corresponding to the Actions of the executed ActionSequence
ActionInputException 200 Some inputs are missing and/or invalid. Note that this exception is also used to merely communicate the expected inputs and their options/details.
ActionSequenceMultipleException 400 One or more exceptions occurred during execution. Details contains the idRun (to continue after fixing input) and a list of exceptions, each with 4 keys: code, description, details, httpCode.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
POST/transitions/{idREDSet}/{idWorkflowTransition}/{idRun} ⎘Authentication required
Continues the execution of a priorly invoked ActionSequence that did not complete yet, due to either missing/invalid input or an exception.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No ID of the REDSet
idGroups POST-body int[] No Must contain at least the primary REDGroup, the other groups are irrelevant.
idWorkflowTransition URI-Path int No ID of the WorkflowTransition
input POST-body string
format: json
 Yes [] JSON-stringified input data
idRun URI-Path string No idRun returned by a prior attempt. Can be found on the returned ActionSequenceMultipleException.
Response HTTP Type Description
Success 200 REDSet Returns the updated REDSet, including new status and potentially applied mutations.
ActionInputException 200 Some inputs are missing and/or invalid. Note that this exception is also used to merely communicate the expected inputs and their options/details.
ActionSequenceMultipleException 400 One or more exceptions occurred during execution. Details contains the idRun (to continue after fixing input) and a list of exceptions, each with 4 keys: code, description, details, httpCode.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
Default APIs
GET/ ⎘
Provides the API-specification. Only enabled if API exposure is enabled.
Parameter Location Type Requirements Optional Default value Description
format URI-Query string
enum: [ "KateAPI", "InternalAPIMap", "OpenAPI", "Swagger" ]
 Yes "KateAPI" Documentation format. We support KateAPI documentation, Swagger/OpenAPI documentation and raw output of the internal API-map cache.
openApiVersion URI-Query int
enum: [ 2, 3 ]
 Yes 2 Version 3 is crappy with request bodies, so we prefer version 2 (which only sucks regarding Response definitions; hence we prefer KateAPI documentation).
Response HTTP Type Description
Success 200 object The API-documentation.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Integrations
GET/integrations/xbrlSigningResultLanding ⎘
Return callback landing page (outputs HTML) for result of XBRL signing operation; presenting success or failure.
Parameter Location Type Requirements Optional Default value Description
error URI-Query string Yes null Null on success, exception class on error.
errorDetails URI-Query string
format: json
 Yes null Object of error details. The only relevant property for FE here is "details", which are optional and specific to the specified error.
lang URI-Query string Yes "nl" Desired user language for this result page. Currently never provided and always Dutch by current default, since signing XBRL is a Dutch integration.
Response HTTP Type Description
Success 200 html Directly outputs HTML, containing either a success message or an error message.
KVKException 200 Something went wrong connecting to the KVK, look in details for both the raw result and possible explanation. Depending on the error this can be either be an issue at our implementation or of the API of the KVK
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
POST/integrations/passthrough/kvk ⎘

Executes the call to the KVK API, it is a passthrough of https://developers.kvk.nl/nl/documentation, our wrapper is applied to the result.
Oddities:
basisprofielen takes "kvkNummer" inside of the input instead of in the path.
basisprofielen vestigingen also takes "kvkNummer" inside of the input instead of in the path.
Parameter Location Type Requirements Optional Default value Description
path POST-body string
enum: [ "\/api\/v2\/zoeken", "\/api\/v1\/basisprofielen", "\/api\/v1\/vestigingsprofielen", "\/api\/v1\/basisprofielen\/vestigingen", "\/api\/v1\/naamgevingen\/kvknummer" ]
 No The KVK API to call
input POST-body string
format: json
 No JSON-stringified input data
Response HTTP Type Description
Success 200 json Returns the raw output of the KVK endpoint.
KVKException 200 Something went wrong connecting to the KVK, look in details for both the raw result and possible explanation. Depending on the error this can be either be an issue at our implementation or of the API of the KVK
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
No
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
Management: ActionSequences
GET/mgmt/actionSequences ⎘Authentication required
Lists ActionSequences
Response HTTP Type Description
Success 200 ActionSequence[] Array of ActionSequences
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/actionSequenceLogs/cleanStaleInputLogs ⎘Authentication required
Cleanup stale INPUT-ActionSequenceLogs, i.e. actions invoked that are in an "awaiting more input" state but not completed with success or error yet. Note: this does PERMANENTLY delete logs, not archive them.
Parameter Location Type Requirements Optional Default value Description
minAgeSeconds POST-body int
min: 14400
 Yes 604800 Minimum age of the INPUT-log to delete. Input logs within this interval are kept. Logs of the last 4 hours cannot be deleted yet for support purposes.
Response HTTP Type Description
Success 200 int Amount of logs cleaned up.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('flow:mgmt' OR 'kate:devops') ⎘
POST/mgmt/actionSequences/{actionSequenceName}/attachCondition/{conditionName} ⎘Authentication required
Attach Condition to ActionSequence
Parameter Location Type Requirements Optional Default value Description
actionSequenceName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,31}$
 No Name of the ActionSequence to attach the condition to
conditionName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the Condition to attach to the ActionSequence
Response HTTP Type Description
Success 200 ActionSequence Updated ActionSequence
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/actionSequences/{actionSequenceName}/detachCondition/{conditionName} ⎘Authentication required
Detach Condition from ActionSequence
Parameter Location Type Requirements Optional Default value Description
actionSequenceName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,31}$
 No Name of the ActionSequence to detach the condition from
conditionName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the Condition to detach from the ActionSequence
Response HTTP Type Description
Success 200 ActionSequence Updated ActionSequence
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/actionSequences/{name} ⎘Authentication required
Create or update ActionSequence
Parameter Location Type Requirements Optional Default value Description
name URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,31}$
 No Name of the ActionSequence to create or update. If it exists, it will be updated; inserted otherwise.
idCustomer POST-body string
pattern: ^(:?[a-z][a-z0-9\-]{2,13}[a-z0-9]|\*)$
 Yes "*" idCustomer to restrict to, or '*' to allow for all customers.
idDepartment POST-body string
pattern: ^(:?[a-z][a-z0-9\-]{2,13}[a-z0-9]|\*)$
 Yes "*" idDepartment to restrict to, or '*' to allow for all departments.
actionConfig POST-body string
format: json
 No JSON-stringified actionConfig: an array of objects { name: string, config: object }, with names representing Action-names and config their corresponding configuration objects.
isHidden POST-body bool Yes false True if this should not be listed on the REDEdit ActionSequence-list, but still should remain invocable. For example, actions attached to REDSetTable, actions with a specific custom trigger (Create Valuation), etc.
dryRun POST-body bool Yes false True if this is a dry-run that should not have and side-effects/consequences.
internalDescription POST-body string
pattern: ^[a-zA-Z0-9 -]*$
maxLength: 255
 Yes "" Description for internal use
Response HTTP Type Description
Success 200 ActionSequence Created or updated ActionSequence
InvalidModelException 200 The model is in an invalid state (validation failed).
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/actionSequences/{name}/delete ⎘Authentication required
Delete ActionSequence
Parameter Location Type Requirements Optional Default value Description
name URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,31}$
 No Name of the ActionSequence to delete
Response HTTP Type Description
Success 200 true True if deleted
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
Management: Actions
GET/mgmt/actions ⎘Authentication required
Lists available actions
Response HTTP Type Description
Success 200 { name: string, summary: string, description: string }[] Array of Action DTOs
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
Management: Condition
POST/mgmt/conditions/{name} ⎘Authentication required
Create or update Condition
Parameter Location Type Requirements Optional Default value Description
name URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the Condition to create or update. If it exists, it will be updated; inserted otherwise.
conditionCNF POST-body string
format: json
 No JSON-stringified / associative ConditionCNF.
dryRun POST-body bool Yes false True if this is a dry-run that should not have and side-effects/consequences.
Response HTTP Type Description
Success 200 ActionSequence Created or updated Condition
InvalidModelException 200 The model is in an invalid state (validation failed).
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/conditions/{name}/delete ⎘Authentication required
Delete Condition
Parameter Location Type Requirements Optional Default value Description
name URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the Condition to delete
Response HTTP Type Description
Success 200 true True if deleted
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
Management: Conditions
GET/mgmt/conditions ⎘Authentication required
Lists Conditions
Response HTTP Type Description
Success 200 Condition[] Array of Conditions
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
Management: WorkflowTransitions
GET/mgmt/workflowStatuses ⎘Authentication required
Lists WorkflowStatuses
Response HTTP Type Description
Success 200 WorkflowStatus[] Array of WorkflowStatus
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
GET/mgmt/workflowTransitions ⎘Authentication required
Lists WorkflowTransitions
Response HTTP Type Description
Success 200 WorkflowTransition[] Array of WorkflowTransitions
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/workflowTransitions/{name} ⎘Authentication required
Create or update WorkflowTransition
Parameter Location Type Requirements Optional Default value Description
name URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the WorkflowTransition to create or update. If it exists, it will be updated; inserted otherwise.
idCustomer POST-body string
pattern: ^(:?[a-z][a-z0-9\-]{2,13}[a-z0-9]|\*)$
 Yes "*" idCustomer to restrict to, or '*' to allow for all customers.
idDepartment POST-body string
pattern: ^(:?[a-z][a-z0-9\-]{2,13}[a-z0-9]|\*)$
 Yes "*" idDepartment to restrict to, or '*' to allow for all departments.
statusFrom POST-body int No ID of the WorkflowStatus before transition
statusTo POST-body int No ID of the WorkflowStatus after transition. Cannot be the same as statusFrom.
isForward POST-body bool Yes true True if this is considered a forward transition, false it this is a backward transition.
actionSequence POST-body string
pattern: ^[a-z][A-Za-z0-9]{1,31}$
 No Name of the ActionSequence associated to this WorkflowTransition to execute before the transition is performed. If execution fails, the transition is not performed. Must contain "Workflow\Transition" in its ActionSequence
internalDescription POST-body string
pattern: ^[a-zA-Z0-9 -]*$
maxLength: 255
 Yes "" Description for internal use
isHidden POST-body bool Yes false True if this should not be listed on the REDEdit Workflow-lists, but still should remain invocable. For example, transitions attached to REDSetTable, transitions with a specific custom trigger (delete buttons), etc.
dryRun POST-body bool Yes false True if this is a dry-run that should not have and side-effects/consequences.
Response HTTP Type Description
Success 200 WorkflowTransition Created or updated WorkflowTransition
InvalidModelException 200 The model is in an invalid state (validation failed).
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/workflowTransitions/{name}/delete ⎘Authentication required
Delete WorkflowTransition
Parameter Location Type Requirements Optional Default value Description
name URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the WorkflowTransition to delete
Response HTTP Type Description
Success 200 true True if deleted
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/workflowTransitions/{workflowTransitionName}/attachCondition/{conditionName} ⎘Authentication required
Attach Condition to WorkflowTransition
Parameter Location Type Requirements Optional Default value Description
workflowTransitionName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the WorkflowTransition to attach the condition to
conditionName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the Condition to attach to the WorkflowTransition
Response HTTP Type Description
Success 200 WorkflowTransition Updated WorkflowTransition
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
POST/mgmt/workflowTransitions/{workflowTransitionName}/detachCondition/{conditionName} ⎘Authentication required
Detach Condition from WorkflowTransition
Parameter Location Type Requirements Optional Default value Description
workflowTransitionName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the WorkflowTransition to detach the condition from
conditionName URI-Path string
pattern: ^[a-z][A-Za-z0-9]{1,63}$
 No Name of the Condition to detach from the WorkflowTransition
Response HTTP Type Description
Success 200 WorkflowTransition Updated WorkflowTransition
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:mgmt ⎘
Transition API
GET/transitions/{idREDSet} ⎘Authentication required
Returns applicable WorkflowTransitions w.r.t. authenticated customer, department, user and given REDSet.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No Contextual REDSet ID
idGroups URI-Query int[] No Must contain at least the primary REDGroup, the other groups are irrelevant.
Response HTTP Type Description
Success 200 WorkflowTransition[] Array of WorkflowTransitions
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
POST/transitions/{idREDSet}/{idWorkflowTransition} ⎘Authentication required
Executes the referred WorkflowTransition. Only use this method for first time initiations. If input is missing, invalid or when there are exceptions, the ActionSequenceMultipleException will have an idRun property. Invoke to /transition/{idREDSet}/{idWorkflowTransition}/{idRun} on subsequent calls/attempts.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No ID of the REDSet
idGroups POST-body int[] No Must contain at least the primary REDGroup, the other groups are irrelevant.
idWorkflowTransition URI-Path int No ID of the WorkflowTransition
input POST-body string
format: json
 Yes [] JSON-stringified input data
Response HTTP Type Description
Success 200 REDSet Returns the updated REDSet, including new status and potentially applied mutations.
ActionInputException 200 Some inputs are missing and/or invalid. Note that this exception is also used to merely communicate the expected inputs and their options/details.
ActionSequenceMultipleException 400 One or more exceptions occurred during execution. Details contains the idRun (to continue after fixing input) and a list of exceptions, each with 4 keys: code, description, details, httpCode.
MissingRequiredParameterException 400 The request is missing a required input parameter. See details for involved parameter.
InvalidParameterException 400 The request has an invalid argument. See details for involved parameter and invalidation.
AuthenticationFailedException 401 Authentication failed. Re-authenticate and retry. See error details for details.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
flow:* ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error