Kaa releases
Shortcuts
Skip to end of metadata
Go to start of metadata

User

Get user authentication status

Returns information about the current authorized user.

  • URL 
    /kaaAdmin/rest/api/auth/checkAuth
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create user with KAA_ADMIN role

Creates a user with the KAA_ADMIN role.

  • URL 
    /kaaAdmin/rest/api/auth/createKaaAdmin?username&password
  • Method:
    POST

  • URL params

    ParameterValueDescription
    usernamestringuser name of Kaa admin user
    passwordstringuser password of Kaa admin user, must be no shorter than 6 characters
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    403 ForbiddenUser with the KAA_ADMIN role already exists
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Change user password

Changes the password of a user.

  • URL 
    /kaaAdmin/rest/api/auth/changePassword?username&oldPassword&newPassword
  • Method:
    POST

  • URL params

    ParameterValueDescription
    usernamestringuser name of the user whose password is to be changed
    oldPasswordstringold password of the user
    newPasswordstringnew password of the user, must be no shorter than 6 characters
  • Data params

    None

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get user profile

Returns the user profile of the current user. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/userProfile
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Edit user profile

Edits the user profile. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/userProfile
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get all users

Returns a list of all users associated with the current authorized user: users whose Tenant ID values match the Tenant ID of the request submitter. Only users with the TENANT_ADMIN role are allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/users
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN)
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get user

 Returns a user. Only users with the TENANT_ADMIN role are allowed to submit this request. The Tenant ID of requested user must be identical to the Tenant ID of the submitter.

  • URL 
    /kaaAdmin/rest/api/user/{userId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    userIdstringUser ID of the requested user.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the requested user does not match the Tenant ID of the authenticated user
    404 Not FoundUser with the specified userId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit user

Creates or edits a user. If a user with the specified ID does not exist, it will be created, and its Tenant ID will be set to the Tenant ID of the request submitter. A random password will be generated and sent to the user’s Email. If a user with the specified ID exists, the user will be updated. Only users with the TENANT_ADMIN role can perform this operation.

  • URL 
    /kaaAdmin/rest/api/application
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the editing user does not match the Tenant ID of the authenticated user
    404 Not FoundUser to be edited with the specified userId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete user

Deletes a user. Only users with the TENANT_ADMIN role can perform this operation. The Tenant ID of the user to be deleted must be identical to the Tenant ID of the user who submitted the request.

  • URL 
    /kaaAdmin/rest/api/delUser?userId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    userIdstringthe User ID of the user to be deleted.
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestuserId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the user to be deleted does not match the Tenant ID of the authenticated user
    404 Not FoundUser with the specified userId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Tenant

Get all tenants

Returns all tenants existing in the system. Only Kaa admin is allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/tenants
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the KAA_ADMIN role
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get tenant

Returns tenant by associated userId.

  • URL 
    /kaaAdmin/rest/api/tenant/{userId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    userIdstringthe ID of the user associated with the requested tenant
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the KAA_ADMIN role
    404 Not FoundTenant with the specified userId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit tenant

Creates or edits a tenant. If a tenant with the specified ID does not exist, it will be created. If a tenant with the specified ID exists, it will be updated.

  • URL 
    /kaaAdmin/rest/api/tenant
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the KAA_ADMIN role
    404 Not FoundTenant with the specified userId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete tenant

Deletes a tenant by associated User ID.

  • URL 
    /kaaAdmin/rest/api/delTenant?userId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    userIdstringthe ID of the user associated with the tenant to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the  KAA_ADMIN role
    404 Not FoundTenant with the specified userId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Application

Get all applications

Returns all applications for the current authorized user within the current tenant. The current user must have one of the following roles: TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER.

  • URL 
    /kaaAdmin/rest/api/applications
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER)
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get application

Returns an application by application ID

  • URL 
    /kaaAdmin/rest/api/application/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER) or Tenant ID of the application does not match the Tenant ID of the user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit application

Creates or edits an application. If the application with the specified ID does not exist, it will be created. If the application with the specified ID exists, it will be updated. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/application
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the application to be edited does not match the Tenant ID of the user
    404 Not FoundApplication to be edited with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete application

Deletes an application. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delApplication?applicationId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the application does not match the Tenant ID of the user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:


SDK generation

Get versions of all schema types

 Returns versions for all schema types available in the application. Only users with role TENANT_DEVELOPER or TENANT_USER are allowed to requests this information.

  • URL 
    /kaaAdmin/rest/api/schemaVersions/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID id of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Generate endpoint SDK

Generates an endpoint SDK based on the target platform, Application ID, schema versions and event family map IDs specified in the request body. Only users with the TENANT_DEVELOPER or TENANT_USER role can perform this operation.

  • URL 
    /kaaAdmin/rest/api/sdk
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    • SDK file raw data

       

  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Profiling

Get profile schemas

Returns the profile schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. A users can only request schemas for applications associated with the same user.

  • URL 
    /kaaAdmin/rest/api/profileSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get profile schema

Returns the profile schema by Profile Schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/profileSchema/{profileSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    profileSchemaIdstringthe ID of the profile schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the profile schema does not match the Tenant ID of the authenticated user
    404 Not FoundProfile schema with the specified profileSchemaId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create profile schema

Uploads a profile schema. A unique version number will be generated (incrementally) for the uploaded schema, and the createdUsername field of the schema will be set to the name of the user who uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/profileSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     profileSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified profile schema is not a valid avro schema
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the profile schema does not match the Tenant ID of the authenticated user
    404 Not FoundFile with a schema not found in the form data
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Grouping

Get endpoint groups

Returns all endpoint groups for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/endpointGroups/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get endpoint group

Returns an endpoint group by Endpoint Group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/endpointGroup/{endpointGroupId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe id of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit endpoint group

Creates or edits an endpoint group. If an endpoint group with the specified ID does not exist, it will be created. If an endpoint group with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/endpointGroup
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group to be edited with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete endpoint group

Deletes an endpoint group specified by Endpoint Group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delEndpointGroup?endpointGroupId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Get profile filter records

Returns all profile filter records for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/profileFilterRecords?endpointGroupId&includeDeprecated
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
    includeDeprecatedstring[“true” or ”false”] if “true”, all profile filter records will be returned, including deprecated ones. If “false”, only active and inactive profile filter records will be returned
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get profile filter record

Returns the profile filter record for the specified endpoint group and profile schema. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/profileFilterRecord?schemaId&endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the profile schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist or endpoint group does not have the specified profile filter record
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant profile schemas

Returns all vacant (not being used by endpoint group profile filters) profile schemas for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantProfileSchemas?endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe id of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit profile filter

Creates or updates a profile filter. If a profile filter with the specified ID does not exist, then it will be created and its createUsername field will be set to the name of the user who has created it. f a profile filter with the specified ID exists, the profile filter will be updated and its modifyUsername will be set to the user who has submited the request. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/profileFilter
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist or existing profile filter with the specified profileFilterId not found
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Activate profile filter

Activates a profile filter. Sets the status field of the profile filter to ACTIVE, increments the sequenceNumber field value by 1, and sets the activateUsername and activatedTime fields to the name of the user who submitted the request and the activation time, respectively Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/activateProfileFilter
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundProfile filter with the specified profileFilterId not found
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Deactivate profile filter

Deactivates a profile filter. Sets the status field of the profile filter to DEPRECATED, sets the deactivatedTime field value to the time of the deactivation request, and sets the deactivateUsername field to the name of the user who has submitted the request. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/deactivateProfileFilter
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundProfile filter with the specified profileFilterId not found
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete profile filter record

Deletes a profile filter record by profile schema ID and endpoint group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delProfileFilterRecord?schemaId&endpointGroupId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the profile schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the specified profile filter record
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call

Configuration

Get configuration schemas

Returns all configuration schemas for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation. The application must be associated with the user who has submitted the request.

  • URL 
    /kaaAdmin/rest/api/configurationSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration schema

Returns a configuration schema by configuration schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/configurationSchema/{configurationSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    configurationSchemaIdstringthe ID of the configuration schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the configuration schema does not match the Tenant ID of the authenticated user
    404 Not FoundConfiguration schema with the specified configurationSchemaId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create configuration schema

Uploads a configuration schema. A unique version number will be generated (incrementally) for the uploaded schema, and the createUsername field of the schema will be set to the name of the user who uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/configurationSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     configurationSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified configuration schema is not a valid avro schema
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the configuration schema does not match the Tenant ID of the authenticated user
    404 Not FoundFile with a schema not found in the form data
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration records

Returns all configuration records for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/configurationRecords?endpointGroupId&includeDeprecated
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
    includeDeprecatedstring[“true” or ”false”] if “true”, all configuration records will be returned, including deprecated ones. If “false”, only active and inactive configuration records will be returned
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration record

Returns the configuration record for the specified endpoint group and configuration schema. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/configurationRecord?schemaId&endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the configuration schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the requested configuration record
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant configuration schemas

Returns all vacant (not being used by endpoint group configurations) configuration schemas for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantConfigurationSchemas?endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit configuration

Creates or updates a configuration. If a configuration with the specified ID does not exist, then it will be created and its createUsername field will be set to the name of the user who has uploaded it. If a configuration with the specified ID exists, the configuration will be updated and its modifyUsername will be set to the user who has submitted the request. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/configuration
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist or a configuration with the specified configurationId not found
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Activate configuration

Activates a configuration. Sets the status field of the configuration to ACTIVE, increments the sequenceNumber field value by 1, and sets the activateUsername and activatedTime fields to the name of the user who has submitted the request and the activation time, respectively.Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/activateConfiguration
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error rsponse:

    Statues codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not required the role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundConfiguration with the specified configurationId not found
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Deactivate configuration

Deactivates a configuration. Sets the status field of the configuration to DEPRECATED, sets the deactivatedTime field value to the time of the deactivation request, and sets the deactivateUsername field to the name of the user who has submitted the request. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/deactivateConfiguration
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundConfiguration with the specified configurationId not found
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete configuration record

Deletes a configuration record by configuration schema ID and endpoint group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delConfigurationRecord?schemaId&endpointGroupId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the configuration schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the requested configuration record
    500 Internal Server ErrorUnexpected error occurred on the server side

 

  • Sample call:

 

 

Notifications

 

Get notification schemas

Returns notification schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. The Tenant ID value of the application must match the Tenant ID of the request submitter.

  • URL 
    /kaaAdmin/rest/api/notificationSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the equired role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get user notification schemas

Returns user notification schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/userNotificationSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get notification schema

Returns a notification schema by notification schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/notificationSchema/{notificationSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    notificationSchemaIdstringthe ID of the notification schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the notification schema does not match the Tenant ID of the authenticated user
    404 Not FoundNotification schema with the specified notificationSchemaId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create notification schema

Uploads a notification schema. A unique version number will be generated (incrementally) for this schema, and the createUsername field of the schema will be set to the name of the user who has uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/notificationSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     notificationSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified notification schema is not a valid avro schema
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the notification schema does not match the Tenant ID of the authenticated user
    404 Not FoundFile with a schema not found in the form data
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get topics

Returns all topics for the specified application. Only users with  the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/topics/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get endpoint group topics

Returns all topics for the specified endpoint group. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/topics?endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant topics

Returns all vacant (not present in the endpoint group) topics for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantTopics/{endpointGroupId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundEndpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get topic

Returns a topic by topic ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/topic/{topicId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    topicIdstringthe ID of the topic
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequesttopicId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic does not match the Tenant ID of the authenticated user
    404 Not FoundTopic with the specified topicId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit topic

Creates or edits a topic. If a topic with the specified ID does not exist, it will be created. If a topic with the specified ID exists, it will be updated. Only users with theTENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/topic
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic does not match the Tenant ID of the authenticated user
    404 Not FoundTopic to be edited with the specified topicId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete topic

Deletes a topic. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delTopic?topicId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    topicIdstringthe ID of the topic to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequesttopicId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic does not match the Tenant ID of the authenticated user
    404 Not FoundTopic with the specified topicId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Add topic to endpoint group

Adds the specified topic to the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/addTopicToEpGroup?endpointGroupId&topicId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
    topicIdstringthe ID of the topic
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId or topicId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic or the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundTopic with the specified topicId or endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Remove topic from endpoint group

Removes the specified topic from the specified endpoint group. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/removeTopicFromEpGroup?endpointGroupId&topicId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
    topicIdstringthe ID of the topic
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId or topicId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic or the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundTopic with the specified topicId or endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Send notification

Sends a notification with the notification body from the specified file. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/sendNotification
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     notification (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the specified application or the application associated with the specified topic does not match the Tenant ID of the authenticated user
    404 Not FoundFile with the notification body not found in the form data or application with the specified ID does not exist or topic with the specified ID does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Events

Get event class families

Returns all event class families for the current authorized user within the current tenant. Only users with the TENANT_ADMIN role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClassFamilies
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the TENANT_ADMIN role
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get event class family

Returns an event class family by event class family IDOnly users with the TENANT_ADMIN role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClassFamily/{eventClassFamilyId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    eventClassFamilyIdstringthe ID of the event class family
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequesteventClassFamilyId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role TENANT_ADMIN or the Tenant ID of the event class family does not match the Tenant ID of the user
    404 Not FoundAn event class family with the specified eventClassFamilyId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit event class family

Creates or edits an event class family. If an event class family with the specified ID does not exist, it will be created. If an event class family with the specified ID exists, it will be updated. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/eventClassFamily
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the editing event class family does not match the Tenant ID of the user
    404 Not FoundEvent class family to be edited with the specified eventClassFamilyId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Add event class family schema

Adds the event class family schema to the event class family with the specified ID. The current user will be marked as the creator of schema. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/addEventClassFamilySchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     eventClassFamilyId (content-type: text/plain)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified event class family schema is not a valid avro schema
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the specified event class family does not match the Tenant ID of the authenticated user
    404 Not FoundFile with the event class family schema not found in the form data or event class family with the specified ID does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

Get event classes

Gets event classes by event class family ID, version and type. Only users with the TENANT_ADMIN, TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClasses?eventClassFamilyId&version&type
  • Method:
    GET

  • URL params

    ParameterValueDescription
    eventClassFamilyIdstringthe ID of the event class family
    versionstringversion of the event class family schema
    typestringevent classes type, one of ["EVENT", "OBJECT"]
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad Requestone of the url parameters is empty (eventClassFamilyId, version or type)
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the event class family does not match the Tenant ID of the authenticated user
    404 Not FoundEvent class family with the specified eventClassFamilyId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get application event family maps

Returns all application event family maps for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/applicationEventMaps/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get application event family map

Returns an application event family map by application event family map ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/applicationEventMap/{applicationEventFamilyMapId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationEventFamilyMapIdstringthe ID of the application event family map
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationEventFamilyMapId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the application event family map does not match the Tenant ID of the authenticated user
    404 Not FoundApplication event family map with the specified applicationEventFamilyMapId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit application event family map

Creates or edits an application event family map. If an application event family map with the specified ID does not exist, it will be created. If an application event family map with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/applicationEventMap
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the equired role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the application event family map does not match the Tenant ID of the authenticated user
    404 Not FoundApplication event family map to be edited with the specified applicationEventFamilyMapId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant event class families

Returns all vacant (not being used by application event family maps) event class families for the specified application. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantEventClassFamilies/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get application event class families

Returns all event class families for the specified application (being used by application event family maps). Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClassFamilies/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Logging

Get log schemas

Returns all log schemas for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. The Tenant ID value of the application must match Tenant ID of the request submitter.

  • URL 
    /kaaAdmin/rest/api/logSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get log schema

Returns a log schema by log schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logSchema/{logSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    logSchemaIdstringthe ID of the log schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log schema does not match the Tenant ID of the authenticated user
    404 Not FoundLog schema with the specified logSchemaId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get log schema by application token and schema version

Returns a log schema for the specified schema version and application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logSchema/{applicationToken}/{schemaVersion}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringtoken of the application for the requested log schema
    schemaVersionstringversion of the requested log schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log schema does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified application token does not exist or application does not have log schema with the specified schema version
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create log schema

Uploads a log schema. A unique version number will be generated (incrementally) for this schema, and the reateUsername field of the schema will be set to the name of the user who has uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/logSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     logSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified log schema is not a valid avro schema
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log schema does not match the Tenant ID of the authenticated user
    404 Not FoundFile with a schema not found in the form data
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get log appenders

Returns all log appenders for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logAppenders/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestapplicationId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Get log appender

Returns a log appender by log appender ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logAppender/{logAppenderId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    logAppenderIdstringthe ID of the log appender
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestlogAppenderId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundLog appender with the specified logAppenderId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit log appender

Creates or edits a log appender. If a log appender with the specified ID does not exist, it will be created. If a log appender with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/logAppender
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundLog appender to be edited with the specified logAppenderId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:

     Example result

Delete log appender

Deletes a log appender by log appender ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delLogAppender?logAppenderId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    logAppenderIdstringthe ID of the log appender to be deleted

     

     

  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestlogAppenderId parameter is empty
    401 UnauthorizedUser is not authenticated or invalid credentials provided
    403 ForbiddenAuthenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundLog appender with the specified logAppenderId does not exist
    500 Internal Server ErrorUnexpected error occurred on the server side
  • Sample call:


Copyright © 2014, CyberVision, Inc.

  • No labels