API routes (Click a route to expand it, click here to expand/collapse all)
1. REDDefinition APIs
GET/definition ⎘Authentication required
Get all the definitions needed for the given REDDefinition Specification.
Parameter Location Type Requirements Optional Default value Description
idGroups URI-Query int[] No ID's of the groups for the REDDefinition.
wfStatus URI-Query int No ID of the workflow-status of the REDDefinition.
idCustomer URI-Query string Yes null ID of the current customer, override for signed requests only.
idDepartment URI-Query string Yes null ID of the current department, override for signed requests only.
idUser URI-Query string Yes null ID of the current user, override for signed requests only.
resolveUserLiterals URI-Query bool Yes true Simplify conditions by resolving the user-based OperandValue(s).
resolveCustomerDepartmentLiterals URI-Query bool Yes true Simplify conditions by resolving the customer- and department-based OperandValue(s).
includePresentationDetails URI-Query bool Yes true Include for each REDPointDef in which category to display it.
includeFrontendDataDepMatrix URI-Query bool Yes true Include the dependency matrix (front-end version), i.e. which SJAQuery paths are relevant.
includeBackendDataDepMatrix URI-Query bool Yes false Include the dependency matrix (back-end version), i.e. which SJAQuery paths are relevant.
Response HTTP Type Description
Success 200 REDDefinition[] REDDefinition
ImplementationException 500 Using a currently unimplemented part of this api (using the override for signed requests)
InvalidModelOperationException 500 An operation is performed that is not supported (yet/anymore), corresponding configuration should be altered or this API should be updated.
InvalidREDDefinitionException 500 Given specification of the REDDefinition is invalid, check details for more information.
UnevaluatableException 500 Attempted to evaluate something that it can not evaluate with given information.
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:
('red-config:*' OR 'red-config:mgmt' OR 'kate:migration') ⎘
GET/pointDefinition/{redPath} ⎘Authentication required
Get a single point definition for the given REDDefinition Specification.
Parameter Location Type Requirements Optional Default value Description
redPath URI-Path string No REDPath of the datapoint to get definition for.
wfStatus URI-Query int No ID of the workflow-status of the REDDefinition.
idGroups URI-Query int[] Yes [] ID's of the groups for the REDDefinition.
idCustomer URI-Query string Yes null ID of the current customer, override for signed requests only.
idDepartment URI-Query string Yes null ID of the current department, override for signed requests only.
idUser URI-Query string Yes null ID of the current user, override for signed requests only.
resolveUserLiterals URI-Query bool Yes true Simplify conditions by resolving the user-based OperandValue(s).
resolveCustomerDepartmentLiterals URI-Query bool Yes true Simplify conditions by resolving the customer- and department-based OperandValue(s).
Response HTTP Type Description
Success 200 REDPointDef REDPointDef
InvalidREDDefinitionException 500 Given specification of the REDDefinition is invalid, check details for more information.
UnevaluatableException 500 Attempted to evaluate something that it can not evaluate with given information.
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:
('red-config:*' OR 'red-config:mgmt' OR 'kate:migration') ⎘
POST/definition/publishUpdate ⎘Authentication required
Publish the changes to definitions
Parameter Location Type Requirements Optional Default value Description
idGroups POST-body int[] Yes [] ID's of the groups for the REDDefinitions that have been updated, if not given checks automatically for changes of the past hour.
Response HTTP Type Description
Success 200 bool true if a success, false if not
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:
red-config:* ⎘
POST/mgmt/definition/clearPluginCaches ⎘Authentication required
Clears the remote REDDefinition-plugin caches of all services that utilize it.
Response HTTP Type Description
Success 200 bool True
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:
kate:devops ⎘
2. REDGroup APIs
GET/group/getById ⎘Authentication required
Returns a REDGroup by its id.
Parameter Location Type Requirements Optional Default value Description
id URI-Query int
minimum: 1
 No ID of the REDGroup.
format URI-Query string
enum: [ "nested", "flat" ]
 Yes "flat" nested will return the group-subgroup hierarchy with their respective points. flat will collect all points from all child-groups, and put them into a single REDGroup response
Response HTTP Type Description
Success 200 REDGroup REDGroup
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:*' OR 'red-config:mgmt') ⎘
GET/group/search ⎘Authentication required
Returns REDGroups where the label contains the search-key.
Parameter Location Type Requirements Optional Default value Description
search URI-Query string No Partial label of the REDGroup name to look for.
format URI-Query string
enum: [ "nested", "flat" ]
 Yes "flat" nested will return the group-subgroup hierarchy with their respective points. flat will collect all points from all child-groups, and put them into a single REDGroup response
Response HTTP Type Description
Success 200 REDGroup[] Array of REDGroups
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:
('red-config:*' OR 'red-config:mgmt') ⎘
GET/mgmt/group ⎘Authentication required
List available groups
Response HTTP Type Description
Success 200 REDGroup REDGroup
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt' OR 'kate:migration') ⎘
POST/group/addMultiplePointDefs ⎘Authentication required
Add multiple REDPointDefs to a REDGroup
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idREDPointBaseDefs POST-body int[]
minimum: 1
 No ID's of the REDPointBaseDefs.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously added already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt' OR 'kate:migration') ⎘
POST/group/addPointDef ⎘Authentication required
Add a REDPointDef to a REDGroup
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idREDPointBaseDef POST-body int
minimum: 1
 No ID of the REDPointBaseDef.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously added already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt') ⎘
POST/group/addSubGroup ⎘Authentication required
Add a REDGroup as subgroup to a REDGroup
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idSubGroup POST-body int
minimum: 1
 No ID of the sub REDGroup.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously added already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt') ⎘
POST/group/create ⎘Authentication required
Create a new REDGroup.
Parameter Location Type Requirements Optional Default value Description
label POST-body string No Label of the new REDGroup.
format POST-body string
enum: [ "nested", "flat" ]
 Yes "flat" nested will return the group-subgroup hierarchy with their respective points. flat will collect all points from all child-groups, and put them into a single REDGroup response
Response HTTP Type Description
Success 201 REDGroup REDGroup
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt') ⎘
POST/group/removeMultiplePointDefs ⎘Authentication required
Remove multiple REDPointDefs from a REDGroup
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idREDPointBaseDefs POST-body int[]
minimum: 1
 No ID's of the REDPointBaseDefs.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously removed already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt') ⎘
POST/group/removePointDef ⎘Authentication required
Remove a REDPointDef from a REDGroup
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idREDPointBaseDef POST-body int
minimum: 1
 No ID of the REDPointBaseDef.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously removed already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt') ⎘
POST/group/removeSubGroup ⎘Authentication required
Add a REDGroup as subgroup to a REDGroup
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idSubGroup POST-body int
minimum: 1
 No ID of the sub REDGroup.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously removed already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt') ⎘
POST/group/temp/addMultiplePointDefs ⎘Authentication required
Add multiple REDPointDefs to a REDGroup, used by the migration to auto-link missing dependencies
Parameter Location Type Requirements Optional Default value Description
idGroup POST-body int
minimum: 1
 No ID of the REDGroup.
idREDPointBaseDefs POST-body int[]
minimum: 1
 No ID's of the REDPointBaseDefs.
Response HTTP Type Description
Success 200 bool Whether the operation succeeded, if it was previously added already it is considered a success.
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
kate:migration ⎘
POST/group/updated ⎘Authentication required
Informs the SSE service that a REDGroup is updated.
Response HTTP Type Description
Success 200 bool Whether the SSE service is informed successfully (false if there is nothing to report).
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:
('red-config:mgmt' OR 'kate:admin') ⎘
3. REDCategory APIs
GET/category/getSubCategories ⎘Authentication required
Get subcategories
Parameter Location Type Requirements Optional Default value Description
id URI-Query int No id of the existing Category
Response HTTP Type Description
Success 200 Category[] Category
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
red-config:mgmt ⎘
GET/category/{id} ⎘Authentication required
Show an existing Category.
Parameter Location Type Requirements Optional Default value Description
id URI-Path int No id of the existing Category
Response HTTP Type Description
Success 200 Category Category
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
red-config:mgmt ⎘
GET/mgmt/category ⎘Authentication required
List available categories
Response HTTP Type Description
Success 200 Category Category
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
red-config:mgmt ⎘
POST/category/clone ⎘Authentication required
Clone an existing Category..
Parameter Location Type Requirements Optional Default value Description
id POST-body int No id of the existing Category
Response HTTP Type Description
Success 201 Category Category
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
red-config:mgmt ⎘
POST/category/create ⎘Authentication required
Create a new Category.
Parameter Location Type Requirements Optional Default value Description
orderPriority POST-body int No the priority of the Category (with the same parent Category
idParent POST-body int No the id of the Category that should be its parent, set to 0 if there should be no parent.
description POST-body string Yes null the description for the Category.
Response HTTP Type Description
Success 201 Category Category
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt' OR 'kate:migration') ⎘
POST/category/delete ⎘Authentication required
Get subcategories
Parameter Location Type Requirements Optional Default value Description
id POST-body int No id of the existing Category
deleteSubCategories POST-body bool Yes false Also delete all subCategories.
Response HTTP Type Description
Success 200 bool success
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
red-config:mgmt ⎘
POST/category/update ⎘Authentication required
Edit an existing Category for ALL Customer/Departments.
Parameter Location Type Requirements Optional Default value Description
id POST-body int No id of the existing Category
orderPriority POST-body int Yes null the priority of the Category (with the same parent Category), to change provide a value
idParent POST-body int Yes null the id of the Category that should be its parent, if not given it is unchanged, to set to null provide 0.
description POST-body string Yes null provide a value to change the description of the Category.
Response HTTP Type Description
Success 200 Category Category
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
red-config:mgmt ⎘
4. BaseDef APIs
GET/basePointDef/getById ⎘Authentication required
Returns a base REDPoint-definition by its id.
Parameter Location Type Requirements Optional Default value Description
id URI-Query int
minimum: 1
 No ID of the base REDPointDef.
Response HTTP Type Description
Success 200 REDPointDef Base REDPointDef
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:propose' OR 'red-config:mgmt') ⎘
GET/basePointDef/getByName ⎘Authentication required
Returns a base REDPoint-definition by its exact name.
Parameter Location Type Requirements Optional Default value Description
name URI-Query string
minLength: 1
pattern: ^[a-zA-Z0-9]+$
 No Name of the base REDPointDef.
includeGroups URI-Query bool Yes false Include the associated groups in the output.
Response HTTP Type Description
Success 200 REDPointDef Base REDPointDef
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:propose' OR 'red-config:mgmt' OR 'kate:migration') ⎘
GET/basePointDef/proposals ⎘Authentication required
Returns all REDPointBaseDef proposals
Response HTTP Type Description
Success 200 REDPointBaseDefProposal[] Proposals for Base REDPointBaseDefs
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:propose' OR 'red-config:mgmt') ⎘
GET/basePointDef/proposals/getById ⎘Authentication required
Returns a proposed base REDPoint-definition by its id.
Parameter Location Type Requirements Optional Default value Description
id URI-Query int
minimum: 1
 No ID of the REDBasePointDefProposal.
Response HTTP Type Description
Success 200 REDPointBaseDefProposal The proposal of base REDPointDef
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:propose' OR 'red-config:mgmt') ⎘
GET/basePointDef/proposals/getByName ⎘Authentication required
Returns a proposed base REDPoint-definition by its exact name.
Parameter Location Type Requirements Optional Default value Description
name URI-Query string
minLength: 1
pattern: ^[a-zA-Z0-9]+$
 No Name of the base REDPointDef.
Response HTTP Type Description
Success 200 REDPointBaseDefProposal The proposal of base REDPointDef
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:propose' OR 'red-config:mgmt') ⎘
GET/basePointDef/search ⎘Authentication required
Returns base REDPoint-definitions where name contains the search-key.
Parameter Location Type Requirements Optional Default value Description
search URI-Query string
maxLength: 80
 No Partial name of the REDPointDef name to look for.
minimal URI-Query bool Yes false if true, change the output to [{"id": "id", "name": "name", "def": {"type":"type"}}]
limit URI-Query int
max: 100
 Yes 100 Only applies if minimal is not given.
Response HTTP Type Description
Success 200 REDPointDef[] Array of base REDPointDef
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:
('red-config:propose' OR 'red-config:mgmt' OR 'kate:migration') ⎘
POST/basePointDef/proposals/propose ⎘Authentication required
Propose a new base REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
name POST-body string
minLength: 1
maxLength: 36
pattern: ^[a-zA-Z0-9]+$
 No Name of the REDPointDef name to create.
type POST-body string
enum: [ "PlainText", "HtmlText", "Number", "Date", "Timestamp", "File", "MapFile", "ValueSelect", "REDSetSelect", "EntitySelect", "FixedTable", "MultiTable", "REDSetTable", "GeoPoint", "GeoPolygon", "GeoMultiPolygon", "LandRegisterSelect" ]
 No type of the REDPointDef
idCategory POST-body int No The id of the OrderedCategory to add this point to
orderPriority POST-body int No The order priority of the said Point within the category.
options POST-body string
format: json
 No JSON containing all options of the REDPointDef.
hiddenIf POST-body string No ConditionCNF to determine visibility
editableIf POST-body string No ConditionCNF to determine editability
optionalIf POST-body string No ConditionCNF to determine whether it is mandatory
shownIf POST-body string No ConditionCNF to determine whether it is shown (but still rendered)
generator POST-body string
format: json
 Yes null String that indicates how to generate this value, if null will not generate.
prefill POST-body string
format: json
 Yes null String that indicates how to prefill this value, if null will not have a prefill.
presentation POST-body string
format: json
 Yes null Set stuff purely related for visual presentation
comments POST-body string[] Yes [] Add comments relevant for the approval.
dryRun POST-body bool Yes true In case of dry-run, no modifications are performed, but only their queries are generated.
update POST-body bool Yes false Send whether if you want to update an existing base REDPointDef, you can only extend. Failing to do so results in a failed request
Response HTTP Type Description
Success 200 REDPointBaseDefProposal The proposal of base REDPointDef
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
InvalidREDDefinitionException 500 Invalid RED-Definition.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:propose' OR 'red-config:mgmt') ⎘
POST/basePointDef/proposals/{idProposal}/accept ⎘Authentication required
Accept a REDPointBaseDef proposal.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the REDBasePointDefProposal.
dryRun POST-body bool Yes false If set to true, only tests whether it can validly be applied without performing any actions.
Response HTTP Type Description
Success 200 REDPointBaseDefProposal The proposal of base REDPointDef
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
POST/basePointDef/proposals/{idProposal}/reject ⎘Authentication required
Reject a REDPointBaseDef proposal.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int No ID of the REDBasePointDefProposal.
reason POST-body string Yes null Optional rejection reason.
Response HTTP Type Description
Success 200 REDPointBaseDefProposal The proposal of base REDPointDef
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
POST/basePointDef/proposals/{idProposal}/update ⎘Authentication required
Update the proposal for a new base REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idProposal URI-Path int
minimum: 1
 No ID of the base REDPointDef.
name POST-body string
minLength: 1
maxLength: 36
pattern: ^[a-zA-Z0-9]+$
 No Name of the REDPointDef name to create.
type POST-body string
enum: [ "PlainText", "HtmlText", "Number", "Date", "Timestamp", "File", "MapFile", "ValueSelect", "REDSetSelect", "EntitySelect", "FixedTable", "MultiTable", "REDSetTable", "GeoPoint", "GeoPolygon", "GeoMultiPolygon", "LandRegisterSelect" ]
 No type of the REDPointDef
idCategory POST-body int No The id of the OrderedCategory to add this point to
orderPriority POST-body int No The order priority of the said Point within the category.
options POST-body string
format: json
 No JSON containing all options of the REDPointDef.
hiddenIf POST-body string No ConditionCNF to determine visibility
editableIf POST-body string No ConditionCNF to determine editability
optionalIf POST-body string No ConditionCNF to determine whether it is mandatory
shownIf POST-body string No ConditionCNF to determine whether it is shown (but still rendered)
generator POST-body string
format: json
 Yes null String that indicates how to generate this value, if null will not generate.
prefill POST-body string
format: json
 Yes null String that indicates how to prefill this value, if null will not have a prefill.
presentation POST-body string
format: json
 Yes null Set stuff purely related for visual presentation
comments POST-body string[] Yes [] Add comments relevant for the approval.
dryRun POST-body bool Yes true In case of dry-run, no modifications are performed, but only their queries are generated.
Response HTTP Type Description
Success 200 REDPointBaseDefProposal The proposal of base REDPointDef
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
InvalidREDDefinitionException 500 Invalid RED-Definition.
MySQLException 500 MySQL related exception. See details for specific exception details.
InvalidModelOperationException 500 An operation on a model was requested that was not valid/allowed.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('red-config:propose' OR 'red-config:mgmt') ⎘
5. OverrideDef APIs
GET/conditionalOverridePointDef/getForPointBaseDefId/{idREDPointBaseDef} ⎘Authentication required
Get the conditional overrides for REDPoint-definition by idREDPointBaseDef.
Parameter Location Type Requirements Optional Default value Description
idREDPointBaseDef URI-Path int
minimum: 1
 No ID of the idREDPointBaseDef to get conditional overrides for.
Response HTTP Type Description
Success 200 ConditionalREDPointOverrideDef[] Array of ConditionalREDPointOverrideDef.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
GET/conditionalOverridePointDef/{idConditionalREDPointOverrideDef} ⎘Authentication required
Get the conditional override for REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idConditionalREDPointOverrideDef URI-Path int
minimum: 1
 No ID of the ConditionalREDPointOverrideDef.
Response HTTP Type Description
Success 200 ConditionalREDPointOverrideDef ConditionalREDPointOverrideDef.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('kate:admin') AND ('red-config:*') ⎘
GET/overridePointDef/getForPointBaseDefId/{id} ⎘Authentication required
Returns all overrides related to a REDPointBaseDef by its id.
Parameter Location Type Requirements Optional Default value Description
id URI-Path int
minimum: 0
 No ID of the base REDPointDef.
withConditionals URI-Query bool Yes true When true, an array of ConditionalREDPointOverrideDefs with embedded REDPointOverrideDefs is returned (meaning only overrides that have at least 1 conditional). When false, only the REDPointOverrideDe are returned, even without conditionals that trigger them.
Response HTTP Type Description
Success 200 ConditionalREDPointOverrideDef[] | REDPointOverrideDef[] Array of ConditionalREDPointOverrideDefs or REDPointOverrideDefs, based on withConditionals
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:
red-config:mgmt ⎘
GET/overridePointDef/{idREDPointOverrideDef} ⎘Authentication required
Get override REDPoint-definition by Id.
Parameter Location Type Requirements Optional Default value Description
idREDPointOverrideDef URI-Path int
minimum: 1
 No ID of the REDPointOverrideDef.
Response HTTP Type Description
Success 200 REDPointOverrideDef REDPointOverrideDef.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('kate:admin') AND ('red-config:*') ⎘
POST/conditionalOverridePointDef/create ⎘Authentication required
Create a new conditional override for REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idREDPointOverrideDef POST-body int
minimum: 1
 No ID of the REDPointOverrideDef for the condition to apply to.
idCustomer POST-body string Yes null ID of the customer for the override to apply conditionally.
idDepartment POST-body string Yes null ID of the department for the override to apply conditionally.
idREDGroup POST-body int Yes null ID of the REDGroup for the override to apply conditionally.
notIdREDGroup POST-body int Yes null ID of the REDGroup for the override will not apply to.
idWorkflowStatus POST-body int Yes null ID of the WorkflowStatus for the override to apply conditionally.
priority POST-body int Yes 10 Higher numbers are applied last, and thus are overruling lower priorities.
Response HTTP Type Description
Success 200 ConditionalREDPointOverrideDef ConditionalREDPointOverrideDef which was created.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
POST/conditionalOverridePointDef/delete ⎘Authentication required
Delete an existing conditional override for REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idConditionalREDPointOverrideDef POST-body int
minimum: 1
 No ID of the ConditionalREDPointOverrideDef to delete.
Response HTTP Type Description
Success 200 bool Whether the conditional override was deleted.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
POST/overridePointDef/create ⎘Authentication required
Create a new override for a REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idREDPointBaseDef POST-body int
minimum: 0
 No ID of the base REDPointBaseDef, if provided 0 the overrideDef applies to all REDPoints but with the limitation of allowing overriding only uneditableWhen and overrideShownIf.
options POST-body string
format: json
 Yes null JSON containing all override options of the REDPointDef.
visibleWhen POST-body string Yes null ConditionDNF to determine visibility.
uneditableWhen POST-body string Yes null ConditionDNF to determine editability.
requiredWhen POST-body string Yes null ConditionDNF to determine whether it is mandatory.
overrideShownIf POST-body string Yes null ConditionCNF to determine whether it is shown (but still rendered).
overrideGenerator POST-body string
format: json
 Yes null String that indicates how to generate this value, if null it will not override.
overridePrefill POST-body string
format: json
 Yes null String that indicates how to prefill this value, if null it will not override.
overridePresentation POST-body string
format: json
 Yes null String that indicates how to present the PointDefinition, if null it will not override, note, any options that are NOT present in this override are set to their defaults regardless of other overrides and the BasePointDefinition.
idCategory POST-body int Yes 0 ID of the existing Category, 0 will not be set.
overrideCategoryOrderPriority POST-body int Yes 0 The override priority of the Category with the same parent Category, 0 will not be set.
description POST-body string Yes null the description for the override.
Response HTTP Type Description
Success 200 REDPointOverrideDef REDPointOverrideDef which was created.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
POST/overridePointDef/delete ⎘Authentication required
Delete an existing override REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idREDPointOverrideDef POST-body int
minimum: 1
 No ID of the base REDPointOverrideDef to delete.
Response HTTP Type Description
Success 200 bool Whether the override was deleted.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
('kate:admin') AND ('red-config:*') ⎘
POST/overridePointDef/update ⎘Authentication required
Update existing override REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idREDPointOverrideDef POST-body int
minimum: 1
 No ID of the REDPointOverrideDef.
options POST-body string
format: json
 Yes null JSON containing all override options of the REDPointDef.
visibleWhen POST-body string Yes null ConditionDNF to determine visibility.
uneditableWhen POST-body string Yes null ConditionDNF to determine editability.
requiredWhen POST-body string Yes null ConditionDNF to determine whether it is mandatory.
overrideShownIf POST-body string Yes null ConditionCNF to determine whether it is shown (but still rendered).
overrideGenerator POST-body string
format: json
 Yes null String that indicates how to generate this value, if null it will not override.
overridePrefill POST-body string
format: json
 Yes null String that indicates how to prefill this value, if null it will not override.
overridePresentation POST-body string
format: json
 Yes null String that indicates how to present the PointDefinition, if null it will not override, note, any options that are NOT present in this override are set to their defaults regardless of other overrides and the BasePointDefinition.
idCategory POST-body int Yes 0 id of the existing Category, id: 0 will not be set.
overrideCategoryOrderPriority POST-body int Yes 0 the override priority of the Category with the same parent Category, id: 0 will not be set.
description POST-body string Yes null the description for the override.
Response HTTP Type Description
Success 200 REDPointOverrideDef REDPointOverrideDef which was updated.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
red-config:mgmt ⎘
6. Setup APIs
POST/genericOverrides/syncConfig ⎘Authentication required
Sync some predefined generic overrides for all datapoints
Response HTTP Type Description
Success 200 array Messages of what was done, or messages what went wrong.
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:
None ⎘
POST/party/syncConfig ⎘Authentication required
Adds predefined hardcoded datapoints and Party REDSet
Response HTTP Type Description
Success 200 array Messages of what was done, or messages what went wrong.
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:
None ⎘
POST/partyContactPerson/syncConfig ⎘Authentication required
Adds/updates predefined hardcoded datapoints and PartyContactPerson REDSet
Response HTTP Type Description
Success 200 array Messages of what was done, or messages what went wrong.
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:
None ⎘
POST/partyOffice/syncConfig ⎘Authentication required
Adds/updates predefined hardcoded datapoints and PartyOffice REDSet
Response HTTP Type Description
Success 200 bool True
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:
None ⎘
POST/portfolio/syncConfig ⎘Authentication required
Sync some predefined hardcoded datapoints and ValuationPortfolio REDSet
Response HTTP Type Description
Success 200 array Messages of what was done, or messages what went wrong.
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:
None ⎘
POST/redGroup/syncConfig ⎘Authentication required
Adds the predefined REDGroups
Response HTTP Type Description
Success 200 array Messages of what was done, or messages what went wrong.
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:
None ⎘
POST/transaction/syncConfig ⎘Authentication required
Sync some predefined hardcoded datapoints and Transaction REDSet
Response HTTP Type Description
Success 200 array Messages of what was done, or messages what went wrong.
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:
None ⎘
7. TestCase APIs
GET/tests/generators ⎘
Adds the needed testcases in a systematic way
Parameter Location Type Requirements Optional Default value Description
generatorName URI-Query string Yes null The name of the generator to test, null will test all generators.
outputVerbosity URI-Query int
enum: [ 0, 1, 2 ]
 Yes 2 Limit the amount of information of the test output. Options: 0 = only the final test output/summary | 1 = any failed test with their outputs | 2 = success and failed tests with their outputs.
clearTranslationsCache URI-Query bool Yes false True to clear the translations cache.
Response HTTP Type Description
Success 200 string Summary of the generator test results.
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
GET/tests/setNickTableTests ⎘
Adds/updates predefined hardcoded table datapoints
Response HTTP Type Description
Success 200 bool True
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
GET/tests/setNielsTableTests ⎘
Adds/updates predefined hardcoded
Response HTTP Type Description
Success 200 bool True
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
GET/tests/setPrefillTests ⎘
Adds/updates predefined hardcoded prefill datapoints
Response HTTP Type Description
Success 200 bool True
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/tests/addTests ⎘Authentication required
Adds the needed testcases in a systematic way
Parameter Location Type Requirements Optional Default value Description
type POST-body string
enum: [ "PlainText", "HtmlText", "Number", "Date", "Timestamp", "File", "MapFile", "ValueSelect", "REDSetSelect", "EntitySelect", "FixedTable", "MultiTable", "REDSetTable", "GeoPoint", "GeoPolygon", "GeoMultiPolygon", "LandRegisterSelect" ]
 Yes null The name of the type that you want to update, if not provided, update all types.
specificPoint POST-body string Yes null The name of the specific Base REDPointDef to update, if given will skip all others, e.g. "baseDate".
Response HTTP Type Description
Success 200 REDPointDef Base REDPointDef
InvalidREDDefinitionException 500 Invalid RED-Definition.
InvalidModelException 200 The model is in an invalid state (validation failed).
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:
red-config:mgmt ⎘
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
Temp APIs
POST/basePointDef/create ⎘Authentication required
DEPRECATED, only for migration, please use the proposal system. Create a new base REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
name POST-body string
minLength: 1
maxLength: 36
pattern: ^[a-zA-Z0-9]+$
 No Name of the REDPointDef name to create.
type POST-body string
enum: [ "PlainText", "HtmlText", "Number", "Date", "Timestamp", "File", "MapFile", "ValueSelect", "REDSetSelect", "EntitySelect", "FixedTable", "MultiTable", "REDSetTable", "GeoPoint", "GeoPolygon", "GeoMultiPolygon", "LandRegisterSelect" ]
 No type of the REDPointDef
idCategory POST-body int No The id of the OrderedCategory to add this point to
orderPriority POST-body int No The order priority of the said Point within the category.
options POST-body string
format: json
 No JSON containing all options of the REDPointDef.
hiddenIf POST-body string No ConditionCNF to determine visibility
editableIf POST-body string No ConditionCNF to determine editability
optionalIf POST-body string No ConditionCNF to determine whether it is mandatory
shownIf POST-body string No ConditionCNF to determine whether it is shown (but still rendered)
generator POST-body string
format: json
 Yes null String that indicates how to generate this value, if null will not generate
prefill POST-body string
format: json
 Yes null String that indicates how to prefill this value, if null will not have a prefill
presentation POST-body string
format: json
 Yes null Set stuff purely related for visual presentation
dryRun POST-body bool Yes true In case of dry-run, no modifications are performed, but only their queries are generated.
Response HTTP Type Description
Success 200 REDPointDef[] Array of base REDPointDef
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
InvalidREDDefinitionException 500 Invalid RED-Definition.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
('red-config:mgmt' OR 'kate:migration') ⎘
POST/basePointDef/temp/replace ⎘Authentication required
Create or replace a base REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
name POST-body string
minLength: 1
maxLength: 36
pattern: ^[a-zA-Z0-9]+$
 No Name of the REDPointDef name to create.
type POST-body string
enum: [ "PlainText", "HtmlText", "Number", "Date", "Timestamp", "File", "MapFile", "ValueSelect", "REDSetSelect", "EntitySelect", "FixedTable", "MultiTable", "REDSetTable", "GeoPoint", "GeoPolygon", "GeoMultiPolygon", "LandRegisterSelect" ]
 No type of the REDPointDef
idCategory POST-body int No The id of the OrderedCategory to add this point to
orderPriority POST-body int No The order priority of the said Point within the category.
options POST-body string
format: json
 No JSON containing all options of the REDPointDef.
hiddenIf POST-body string No ConditionCNF to determine visibility
editableIf POST-body string No ConditionCNF to determine editability
optionalIf POST-body string No ConditionCNF to determine whether it is mandatory
shownIf POST-body string No ConditionCNF to determine whether it is shown (but still rendered)
idGroups POST-body int[] No ID's of the REDGroups to link the REDPointDef to.
generator POST-body string
format: json
 Yes null String that indicates how to generate this value, if null will not generate
prefill POST-body string
format: json
 Yes null String that indicates how to prefill this value, if null will not have a prefill
presentation POST-body string
format: json
 Yes null Set stuff purely related for visual presentation
Response HTTP Type Description
Success 200 REDPointDef[] Array of base REDPointDef
AlreadyExistsException 409 The object you are attempting to create already exists and therefore can not be created, check details for the object and type in question.
InvalidREDDefinitionException 500 Invalid RED-Definition.
MySQLException 500 MySQL related exception. See details for specific exception details.
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:
kate:migration ⎘
POST/overridePointDef/temp/addMultiple ⎘Authentication required
Create multiple override with conditions for a REDPoint-definition.
Parameter Location Type Requirements Optional Default value Description
idREDPointBaseDef POST-body int
minimum: 1
 No ID of the base REDPointBaseDef.
overridePointDefs POST-body string
format: json
 No JSON containing array with multiple OverridePointDefs and all options with additional key for conditionalOverridePointDefs.
Response HTTP Type Description
Success 200 array REDPointOverrideDefs which are created with additional key for the created conditionalOverridePointDefs.
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
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:
kate:migration ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error