API routes (Click a route to expand it, click here to expand/collapse all)
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
Delivery API
POST/delivery/sourcing ⎘
Callback endpoint where requested sourcing data should be delivered by InboundPort.
Parameter Location Type Requirements Optional Default value Description
customer POST-body string No idCustomer originally passed to Sourcing
department POST-body string No idDepartment originally passed to Sourcing
reference POST-body string No Reference originally passed to Sourcing
content POST-body string No InboundPort Processed Message content from Sourcing. Map of { [REDPath: string]: { s: REDPoint }[] } <-- NOTE the ARRAY of suggestions!
Response HTTP Type Description
Success 200 true Returns true if successful
SourcingDeliveryDeclinedException 200 The sourcing delivery was declined, because the supplied reference was invalid. Besides a security feature, this could be perfectly normal behavior: the REDSet might not be awaiting delivery, or a newer request has been performed that will be delivered soon after this.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
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.
Authentication required:
No
Provider API
GET/autofill/sourcing/{idREDSet} ⎘Authentication required
Provides sourcing suggestions for auto-filling during REDFlow actions. Only 1 suggestion per datapoint is returned. Can only be invoked by REDFlow.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No REDSet ID to obtain suggestions for.
Response HTTP Type Description
Success 200 { [redPath: string]: Suggestion } Single REDPoint per REDPath.
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 AND s:* ⎘
GET/autofill/userDefined/{internalCode} ⎘Authentication required
Provides user-defined suggestions in provided group for auto-filling during REDFlow actions. Only 1 suggestion per datapoint is returned. Can only be invoked by REDFlow.
Parameter Location Type Requirements Optional Default value Description
internalCode URI-Path string
pattern: ^[a-zA-Z][a-zA-Z0-9_-]{1,49}$
 No InternalCode of the SuggestionGroup. Only suggestions in the provided group are returned; unknown groups yield an empty result.
Response HTTP Type Description
Success 200 { [redPath: string]: Suggestion } Single REDPoint per REDPath.
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 AND ('sugg:*' OR 'sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
GET/{idREDSet} ⎘Authentication required
Provides suggestions for given REDSet.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No REDSet ID to obtain suggestions for.
Response HTTP Type Description
Success 200 { [redPath: string]: Suggestion[] } Arrays of suggestions (in USE-DTO format) grouped by REDPath.
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 AND ('sugg:*' OR 's:*' OR 'sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
Request API
POST/request/sourcing ⎘Authentication required
Triggers a call to the Sourcing service to request suggestions based on external sources; which provides the result back to Inbound Port, which passes the mapped result to the Delivery API, which triggers an SSE event that suggestions can be obtained from Provider API.
Parameter Location Type Requirements Optional Default value Description
idREDSet POST-body string
pattern: ^[a-z0-9]{24}$
 No REDSet ID to request suggestions for.
idGroups POST-body int[] No REDGroups of the REDSet.
sourceGroups POST-body string[] No Sourcing source group IDs requested.
landRegisters POST-body string
format: json
 Yes null Optional. JSON-string with landRegisters-table data of the REDSet. If not provided, REDSet will be fetched and it is retrieved from there.
Response HTTP Type Description
Success 200 true Always returns true immediately after authentication is successful
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 AND s:* ⎘
Suggestion group management API
GET/groups ⎘Authentication required
Returns all suggestion groups of the department. Suggestions without group are in "no group" (idGroup null).
Response HTTP Type Description
Success 200 SuggestionGroup[] Array of suggestion groups (in EDIT-DTO format)
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 AND ('sugg:*' OR 'sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
POST/groups ⎘Authentication required
Creates a suggestion group
Parameter Location Type Requirements Optional Default value Description
internalCode POST-body string
pattern: ^[a-zA-Z][a-zA-Z0-9_-]{1,49}$
 No Unique internal code, used to reference this group (e.g. from REDFlow actions).
name POST-body string
maxLength: 100
 No Display name of the group.
locked POST-body bool Yes false True if the group cannot be removed (and its internalCode cannot be changed).
Response HTTP Type Description
Success 200 SuggestionGroup Created suggestion group (in EDIT-DTO format)
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 AND ('sugg:mgmt') ⎘
POST/groups/{id}/delete ⎘Authentication required
Deletes a suggestion group. Locked groups cannot be deleted.
Parameter Location Type Requirements Optional Default value Description
id URI-Path int No ID of the suggestion group.
cascade POST-body bool Yes false If true, all suggestions in this group are deleted as well. If false, they are moved to "no group".
Response HTTP Type Description
Success 200 bool True if deleted
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 AND ('sugg:mgmt') ⎘
POST/groups/{id}/update ⎘Authentication required
Updates a suggestion group. The internalCode of a locked group cannot be changed.
Parameter Location Type Requirements Optional Default value Description
id URI-Path int No ID of the suggestion group.
internalCode POST-body string
pattern: ^[a-zA-Z][a-zA-Z0-9_-]{1,49}$
 Yes null Optional. Null to keep current value. Unique internal code.
name POST-body string
maxLength: 100
 Yes null Optional. Null to keep current value. Display name of the group.
locked POST-body bool Yes null Optional. Null to keep current value. True if the group cannot be removed.
Response HTTP Type Description
Success 200 SuggestionGroup Updated suggestion group (in EDIT-DTO format)
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 AND ('sugg:mgmt') ⎘
User-defined suggestion management API
GET/userDefined ⎘Authentication required
Returns all global user-defined suggestions (not limited to a REDSet) of the department, plus those owned by the current user. Their EDIT-DTOs are an extended version of the USE-DTOs.
Parameter Location Type Requirements Optional Default value Description
idSuggestionGroup URI-Query int Yes null Optional. Null for all suggestions; -1 for only suggestions without group ("no group"); otherwise only suggestions in given SuggestionGroup.
Response HTTP Type Description
Success 200 Suggestion[] Arrays of suggestions (in extended EDIT-DTO format)
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 AND ('sugg:*' OR 'sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
GET/userDefined/{redPath} ⎘Authentication required
Returns manageable user-defined suggestions. Their EDIT-DTOs are an extended version of the USE-DTOs.
Parameter Location Type Requirements Optional Default value Description
redPath URI-Path string
pattern: ^[^\/\\]{2,256}$
 No REDPath of the suggestions to obtain manageable suggestions. Must be a generic REDPath.
onlyEditable URI-Query bool Yes true If true, only suggestions editable by the current user are returned. If false, all accessible user-defined suggestions are returned, including those read-only for current user.
Response HTTP Type Description
Success 200 Suggestion[] Arrays of suggestions (in extended EDIT-DTO format)
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 AND ('sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
POST/userDefined/{id}/delete ⎘Authentication required
Deletes a user-defined suggestion
Parameter Location Type Requirements Optional Default value Description
id URI-Path int No ID of the user-defined suggestion.
Response HTTP Type Description
Success 200 bool True if deleted
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 AND ('sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
POST/userDefined/{id}/update ⎘Authentication required
Updates a user-defined suggestion
Parameter Location Type Requirements Optional Default value Description
id URI-Path int No ID of the user-defined suggestion.
jsonValue POST-body string No JSON-stringified JSON-value.
idGroups POST-body int[] No REDGroups of the REDSet.
isUserOwned POST-body bool Yes null Optional. Null to keep current value. True if this is a personal user suggestion; false if department wide.
title POST-body string
maxLength: 50
 Yes null Optional. Null to keep current value. Short descriptive title for the suggestion.
idSuggestionGroup POST-body int Yes null Optional. Null to keep current value; 0 to clear (no group). ID of the SuggestionGroup, e.g. for REDFlow action prefills.
availableIf POST-body string
format: json
 Yes null Null to keep current value. ConditionCNF to determine whether this suggestion is shown.
Response HTTP Type Description
Success 200 Suggestion Updated suggestion (in EDIT-DTO format)
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 AND ('sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
POST/userDefined/{redPath} ⎘Authentication required
Creates a user-defined suggestion
Parameter Location Type Requirements Optional Default value Description
redPath URI-Path string
pattern: ^[^\/\\]{2,256}$
 No Generic REDPath to which this suggestion should apply. Must be a generic REDPath (or will be automatically converted to it).
title POST-body string
maxLength: 50
 No Short descriptive title for the suggestion.
jsonValue POST-body string No JSON-stringified JSON-value.
idGroups POST-body int[] No REDGroups of the REDSet.
isUserOwned POST-body bool Yes false True if this is a personal user suggestion; false if department wide.
idSuggestionGroup POST-body int Yes null Optional. ID of the SuggestionGroup, e.g. for REDFlow action prefills. Null or 0 for no group.
availableIf POST-body string
format: json
 Yes null ConditionCNF to determine whether this suggestion is shown.
Response HTTP Type Description
Success 200 Suggestion Created suggestion (in EDIT-DTO format)
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 AND ('sugg:edit' OR 'sugg:edit:own' OR 'sugg:mgmt') ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error