API routes (Click a route to expand it, click here to expand/collapse all)
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
GET/definition/user ⎘
This is a utility method to output the internal representations of the constructed DTODefinition and ModelDefinition for the User-model.
Response HTTP Type Description
Success 200 array User Model definition.
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/hello ⎘
Say your name!
Parameter Location Type Requirements Optional Default value Description
name URI-Query string
enum: [ "World", "Piet", "Puk", "Jan", "Klaas", "Kees", "Daan" ]
 Yes "World" Your name
Response HTTP Type Description
Success 200 string Says hello to you!
NameNotFoundException 404 The given name could not be found. See details for unresolved name.
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/users ⎘
Retrieve all users matching (optional criteria)
Parameter Location Type Requirements Optional Default value Description
firstName URI-Query string
minLength: 1
maxLength: 32
 Yes null Only return matching that match this exact firstName
lastName URI-Query string
minLength: 1
maxLength: 32
 Yes null Only return matching that match this exact lastname
Response HTTP Type Description
Success 200 User[] Array of Users, ordered by lastName, then by firstName
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/users/getUserHistory/{idUser} ⎘
Lists revision history of given user.
Parameter Location Type Requirements Optional Default value Description
idUser URI-Path int No User ID
Response HTTP Type Description
Success 200 User[] Users
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:
No
GET/users/{idUser} ⎘
Retrieve User.
Parameter Location Type Requirements Optional Default value Description
idUser URI-Path int No User ID
Response HTTP Type Description
Success 200 User User
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:
No
POST/mgmt/cache/deleteAPIMap ⎘Authentication required
Clears the cached API-map. It will be reconstructed upon next API invocation.
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:admin ⎘
POST/mgmt/cache/deleteCache ⎘Authentication required
Clears the entire cache. This includes for example all API-maps, but might also clear service-specific data.
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:admin ⎘
POST/mgmt/model/clearCache ⎘Authentication required
Clears the cached Model Definitions. It will be reconstructed upon next API invocation.
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:
sandbox:aaa ⎘
POST/mgmt/model/synchronizeMySQL ⎘Authentication required
Synchronizes all relational models. Prunes the corresponding model-cache first.
Parameter Location Type Requirements Optional Default value Description
dryRun POST-body bool Yes true In case of dry-run, no modifications are performed, but only their queries are generated.
dropNonModelTables POST-body bool Yes false If true, all non-recognized tables (i.e. unused by a model) will be dropped.
Response HTTP Type Description
Success 200 string[] Array of queries to be executed (in case of dryRun) or queries executed.
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:
sandbox:aaa ⎘
POST/users/createRandom ⎘
Creates the specified amount of random users and returns them.
Parameter Location Type Requirements Optional Default value Description
amount POST-body int
min: 1
max: 50
 Yes 15 Amount of users to generate
Response HTTP Type Description
Success 200 User[] Array of randomly created users
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/users/createUser ⎘
Return new user.
Parameter Location Type Requirements Optional Default value Description
firstName POST-body string
minLength: 1
maxLength: 32
 No First name
lastName POST-body string
minLength: 1
maxLength: 32
 No Last name
Response HTTP Type Description
Success 200 User User
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/users/deleteUser/{idUser} ⎘
Deletes given user.
Parameter Location Type Requirements Optional Default value Description
idUser URI-Path int No User ID
Response HTTP Type Description
Success 200 bool true
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:
No
POST/users/updateUser/{idUser} ⎘
Update user.
Parameter Location Type Requirements Optional Default value Description
idUser URI-Path int No User ID
firstName POST-body string
minLength: 1
maxLength: 32
 Yes null First name
lastName POST-body string
minLength: 1
maxLength: 32
 Yes null Last name
Response HTTP Type Description
Success 200 User Updated user instance
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:
No
Authentication schemes (Click an authentication scheme to expand it)
JWTAuth
Result wrappers (Click a result-wrapper to expand it)
Success
Error