API routes (Click a route to expand it, click here to expand/collapse all)
Compview API
GET/compview/search/map/{category} ⎘Authentication required
Search the compview map with a given category, applied filters and the GeoBox coordinates.
Parameter Location Type Requirements Optional Default value Description
category URI-Path string
enum: [ "sales", "rentals", "valuations" ]
 No Type of the REDSets. Used to determine the data-collection this dataset and presentation-settings.
geoBoxCoordinates URI-Query string
format: json
 No Specify the GeoBox coordinates for the bottom-left and top-right corners. The order of coordinates for each corner is first longitude then latitude as floats. Example: [[5.01, 52.31],[5.45, 51.95]].
filters URI-Query string
format: json
 Yes [] JSON-string of key-value map where keys represent the filter key and for values their respective filter criteria. Filter example for "number" and "date" types: {"filterKey": [min, max]}, and for "select" type: {"filterKey": {set": ["selectedValue"], "mode": "or"}}
zoomLevel URI-Query int
minimum: 1
maximum: 20
 Yes 8 The current map zoom level. Used to dynamically adjust clustering precision. For example a low `zoomLevel` results in more but smaller clusters, while a larger value in less broader clusters
Response HTTP Type Description
Success 200 CompviewREDSetMarker[] Returns an array of compview REDSets markers which contain the REDSet ID and the location coordinates [longitude, latitude].
ModelNotFoundException 404 Instance of this model with provided ID could not be found.
InvalidFilterException 400 The provided filter is invalid, see error 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.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('red:read' OR 'red:*') ⎘
GET/compview/setup ⎘Authentication required
Gives all the config needed to set up Compview.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Query string
pattern: ^[a-z0-9]{24}$
 Yes null ID of the contextual REDSet, if provided it is used to determine the filter specifications like suggestions.
Response HTTP Type Description
Success 200 CompviewSetup The setup for the filters ranges, suggestions and histograms.
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:read' OR 'red:*') ⎘
Dashboard API
GET/dashboard/active/{dashboardType} ⎘Authentication required
Get the active DashboardREDSets based on the given dashboard type.
Parameter Location Type Requirements Optional Default value Description
dashboardType URI-Path string
enum: [ "sales", "rentals", "valuationPortfolios", "parties" ]
 No The dashboard type so that the correct DashboardDefinition is used.
rfc5646languageTag URI-Query string
format: [A-Za-z0-9-]+
 No Active language to use for translations, for example "en", "en-US" or "en-US-x-cw".
Response HTTP Type Description
Success 200 array Returns an array of the active DashboardREDSets.
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:read' OR 'red:*') ⎘
GET/dashboard/active/{dashboardType}/{idREDSet} ⎘Authentication required
Get a single active DashboardREDSet based on the given dashboard type.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No ID of the parent dataset.
dashboardType URI-Path string
enum: [ "sales", "rentals", "valuationPortfolios", "parties" ]
 No The dashboard type so that the correct DashboardDefinition is used.
rfc5646languageTag URI-Query string
format: [A-Za-z0-9-]+
 No Active language to use for translations, for example "en", "en-US" or "en-US-x-cw".
Response HTTP Type Description
Success 200 DashboardREDSet Returns an active DashboardREDSet.
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:read' OR 'red:*') ⎘
GET/dashboard/config/{dashboardType} ⎘Authentication required
Get the config of the table for the given dashboard type.
Parameter Location Type Requirements Optional Default value Description
dashboardType URI-Path string
enum: [ "sales", "rentals", "valuationPortfolios", "parties" ]
 No The dashboard type of the DashboardDefinition.
Response HTTP Type Description
Success 200 DashboardDefinition Returns the configuration you can use for displaying DashboardREDSets.
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:read' OR 'red:*') ⎘
GET/dashboard/inactive/{dashboardType} ⎘Authentication required
Get the inactive DashboardREDSets based on the given dashboard type and filters.
Parameter Location Type Requirements Optional Default value Description
dashboardType URI-Path string
enum: [ "sales", "rentals", "valuationPortfolios", "parties" ]
 No The dashboard type so that the correct DashboardDefinition is used.
filters URI-Query string
format: json
 No Given filters with a key -> value pairs where the key represents the column name and the value is the filter.
sortColumn URI-Query int No Index of the column to sort on.
sortDirection URI-Query int
enum: [ -1, 1 ]
0: -1
 No Sort direction, -1 for descending first and 1 ascending.
limit URI-Query int
min: 1
max: 200
 No Maximum amount of results to return, for example: 20.
rfc5646languageTag URI-Query string
format: [A-Za-z0-9-]+
 No Active language to use for translations, for example "en", "en-US" or "en-US-x-cw".
includeRanges URI-Query bool Yes false Include the ranges in the response (for dates, numbers and selects).
Response HTTP Type Description
Success 200 array Returns an object: items which contains the inactive DashboardREDSets and if includeRanges the object includes the ranges.
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:read' OR 'red:*') ⎘
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
Maintenance APIs
GET/mgmt/performCollisionScan ⎘Authentication required
Performs an ID collision scan for two given customer/departments. This might be useful to see if data can be safely merged.
Response HTTP Type Description
Success 200 TODO TODO
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 ⎘
Read API
GET/dataset ⎘Authentication required
Get multiple REDSet by search.
Parameter Location Type Requirements Optional Default value Description
search URI-Query string No The string to search on.
idGroups URI-Query int[] Yes null idGroups of the REDSet. Used to determine the data-collection this dataset is located in.
collection URI-Query string
pattern: ^[a-zA-Z]{1,32}$
 Yes null Predetermined name of the data-collection. Can be used instead of idGroups.
requireAllGroups URI-Query int[] Yes [] Matched items must have all of these REDGroups, if not supplied: not filtered upon.
hasStatusIn URI-Query int[] Yes [] Matched items must have one of these statuses, if not supplied: not filtered upon.
includeDataPaths URI-Query string[] Yes [] Optional. If provided, each of these SJAQuery-paths will be included in the result objects. Example: "data.xbrlVersion".
limit URI-Query int
min: 1
max: 10
 Yes 5 Limit the amount of results.
Response HTTP Type Description
Success 200 array Returns an array of select-items (object with id and title) on success.
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:read' OR 'red:*') ⎘
GET/dataset/byId/{idREDSet} ⎘Authentication required
Returns a REDSet by ID.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No ID of the dataset to write to.
idGroups URI-Query int[] Yes null idGroups of the REDSet. Used to determine the data-collection this dataset is located in.
collection URI-Query string
pattern: ^[a-zA-Z]{1,32}$
 Yes null Predetermined name of the data-collection. Can be used instead of idGroups.
audience URI-Query string
enum: [ "nova-fe", "reports", "client", "" ]
 Yes "nova-fe" Audience this dataset is intended for. SSBin URLs will be signed for given audience. Defaults to Kate Nova Frontend, with a validity of 24 hours. Empty audience means original untouched; which is only allowed from selected intra-service domains.
forceEmbedLockin URI-Query bool Yes false True to enforce embed lock-in: all linked REDSets will be recursively embedded.
includeCustomer URI-Query bool Yes false True to include an additional property "customer" on the REDSet, containing the Customer-Department object.
includeEntities URI-Query bool Yes false True to expand all entitie-selectables to full entities on the REDSet. Note that this significantly slows down the call; if the requesting service has access to REDDefinition, it is always preferred to handle remotely.
includeGenerated URI-Query bool Yes false True to include additional properties "generated.data" and "generated.footer" on the REDSet, containing the output of all generators.
Response HTTP Type Description
Success 200 REDSet Returns the dataset on success.
DatasetNotFoundByIdException 404 REDSet with provided ID could not be found.
REDStoreException 500 An exception occurred on the driver-level of the REDStore. See 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.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('red:read' OR 'red:*' OR 'kate:migration') ⎘
GET/dataset/{idREDSet}/validate/redSetSelectables/{redPointPath} ⎘Authentication required
Validate if the REDSet selectables are allowed for the REDSetSelect data point.
Parameter Location Type Requirements Optional Default value Description
idREDSet URI-Path string
pattern: ^[a-z0-9]{24}$
 No ID of the parent dataset.
idGroups URI-Query int[] Yes null idGroups of the parent REDSet. Used to determine the data-collection the datasets are located in.
collection URI-Query string
pattern: ^[a-zA-Z]{1,32}$
 Yes null Predetermined name of the data-collection of the parent REDSet. Can be used instead of idGroups.
redPointPath URI-Path string No The path of the REDSetSelect/REDSetTable REDPointDef.
scenario URI-Query string Yes null Scenario of the redPath to validate against. Leave empty for base scenario.
referredREDSetIDs URI-Query string[]
minItems: 1
 No Array of referred (selected) REDSet IDs. These are to be validated.
returnEmbeds URI-Query bool Yes false If true, all embeds are returned (with their sub-embeds all in linked-form).
Response HTTP Type Description
Success 200 true Returns true on success if returnEmbeds is false; returns the array of validated REDSet embeds otherwise.
REDPointValidationException 200 REDPoint data is invalidated.
DatasetNotFoundByIdException 404 REDSet with provided ID could not be found.
REDStoreException 500 An exception occurred on the driver-level of the REDStore. See 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.
UnauthorizedException 403 Authorization for requested method rejected. See error details for details.
Authentication required:
Yes
Authentication scheme:
JWTAuth
Required flags:
('red:read' OR 'red:*' OR 'kate:migration') ⎘
GET/datasetSelectables ⎘Authentication required
Search the REDSet list.
Parameter Location Type Requirements Optional Default value Description
redPointPath URI-Query string No The path of the REDPointDef.
scenario URI-Query string Yes null Scenario of the redPath to edit. Leave empty for base scenario.
reData URI-Query string
format: json
 Yes [] JSON-string of key-value map where keys represent SJAQueries occurring in REDSet-context literals in the filter, and their respective values contain their respective resolved values.
search URI-Query string
maxLength: 128
 Yes null Optional search query as additional filter.
limit URI-Query int Yes 9999 Limit the amount of results.
Response HTTP Type Description
Success 200 REDSet[] Returns a list of REDSets.
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:read' OR 'red:*' OR 'kate:migration') ⎘
GET/redPoint/{redPointPath} ⎘Authentication required
Returns a single REDPoint by the redPointPath.
Parameter Location Type Requirements Optional Default value Description
redPointPath URI-Path string No The path of the REDPointDef.
idREDSet URI-Query string
pattern: ^[a-z0-9]{24}$
 No ID of the dataset.
scenario URI-Query string Yes null Scenario of the redPath to edit. Leave empty for base scenario.
idGroups URI-Query int[] Yes null idGroups of the REDSet. Used to determine the data-collection this dataset is located in.
collection URI-Query string
pattern: ^[a-zA-Z]{1,32}$
 Yes null Predetermined name of the data-collection. Can be used instead of idGroups.
audience URI-Query string
enum: [ "nova-fe" ]
 Yes "nova-fe" Audience this dataset is intended for. SSBin URLs will be signed for given audience. Defaults to Kate Nova Frontend, with a validity of 24 hours.
Response HTTP Type Description
Success 200 mixed Returns the datapoint value.
DatasetNotFoundByIdException 404 REDSet with provided ID could not be found.
REDStoreException 500 An exception occurred on the driver-level of the REDStore. See details for details.
EmbeddedDatasetNotFoundException 404 Embedded REDSet not found that was referred by a parent REDSet.
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:read' OR 'red:*') ⎘
Read Query API
GET/query/specification ⎘Authentication required
Get the specification of how to get multiple REDSet by query.
Parameter Location Type Requirements Optional Default value Description
queryName URI-Query string
enum: [ "duplicateBusinessParty", "duplicatePrivateParty", "externalReference", "coi" ]
 No name of the query you want to perform
Response HTTP Type Description
Success 200 object Names of the arguments you need to provide when performing that query and their types.
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:query ⎘
GET/query/{queryName} ⎘Authentication required
Get multiple REDSets or REDSetIds using a query, requires different arguments based on the queryName.
Parameter Location Type Requirements Optional Default value Description
queryName URI-Path string
enum: [ "duplicateBusinessParty", "duplicatePrivateParty", "externalReference", "coi" ]
 No Name of the query you want to perform
arguments URI-Query string
format: json
 Yes [] Json-object of the required arguments for your query. For the specification call "/query/specification"
projection URI-Query string
enum: [ "full", "id", "coi" ]
 Yes "id" The name of the projection to be applied
limit URI-Query int
min: 0
max: 10
 Yes 0 Limit the amount of results. If zero, automatically takes the maximum value, which for the case of the projection id is infinite.
Response HTTP Type Description
Success 200 array Returns an array of REDSet (ids) that match your query.
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:*' OR 'red:read' OR 'red:query') ⎘
POST/query/{queryName} ⎘Authentication required
[POST alternative of the same request] Get multiple REDSets or REDSetIds using a query, requires different arguments based on the queryName.
Parameter Location Type Requirements Optional Default value Description
queryName URI-Path string
enum: [ "duplicateBusinessParty", "duplicatePrivateParty", "externalReference", "coi" ]
 No Name of the query you want to perform
arguments POST-body string
format: json
 Yes [] Json-object of the required arguments for your query. For the specification call "/query/specification"
projection POST-body string
enum: [ "full", "id", "coi" ]
 Yes "id" The name of the projection to be applied
limit POST-body int
min: 0
max: 10
 Yes 0 Limit the amount of results. If zero, automatically takes the maximum value, which for the case of the projection id is infinite.
Response HTTP Type Description
Success 200 array Returns an array of REDSet (ids) that match your query.
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:*' OR 'red:read' OR 'red:query') ⎘
Test APIs
GET/test/readOperations ⎘Authentication required
Executes the tests for the reading operations.
Parameter Location Type Requirements Optional Default value Description
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.
Response HTTP Type Description
Success 200 void Prints out the tests output/summary based on the outputVerbosity.
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 ⎘
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error