REST API

REST API documentation API documentation version v1

Base URL: https://cloud.kaaiot.com/api/v1/re

Rules

Operations on rules.

/rules post get

post /rules

Creates a new rule.

Secured by oauth_2_0 with scopes:
  • tenant:rule:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Rule name.

  • description: optional (string)

    Rule description.

  • expression: required(string)

    Rule expression.

  • state: optional (one of ENABLED, DISABLED - default: ENABLED)

    Enables or disables the rule.

  • uiMetadata: optional (string)

    UI metadata.

Examples:

endpoint metadata:

{
  "name": "Low battery",
  "description": "Checks if sensor has low battery",
  "expression": "return ctx.endpoint.getMetadata().battery.status == 'low'",
  "state": "ENABLED",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

metadata updated trigger:

{
  "name": "Comfort temperature",
  "description": "Checks if temperature is 20",
  "expression": "return ctx.trigger.endpointMetadataUpdated.updated.temperature.newValue == '20';",
  "state": "ENABLED",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

time series updated trigger:

{
  "name": "Comfort temperature",
  "description": "Checks if temperature more than 20",
  "expression": "return ctx.trigger.endpointTimeSeriesUpdated['auto~co2'][0].values.value > 20;",
  "state": "ENABLED",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Rule is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/rules/{ruleId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/rules/47e17fc5-060c-4923-b315-d17f6a1bf8d6

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /rules

Retrieves rules.

Secured by oauth_2_0 with scopes:
  • rule:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Rules are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of RuleResponse)

    Items: RuleResponse

    • id: required(string)

      Rule ID.

    • name: required(string)

      Rule name.

    • description: optional (string)

      Rule description.

    • expression: required(string)

      Rule expression.

    • state: optional (one of ENABLED, DISABLED - default: ENABLED)

      enables or disables the rule.

    • uiMetadata: optional (string)

      UI metadata.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the rule was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the rule was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "47e17fc5-060c-4923-b315-d17f6a1bf8d6",
      "name": "Low battery",
      "description": "Checks if sensor has low battery",
      "expression": "return ctx.endpoint.getMetadata().battery.status == 'low'",
      "state": "ENABLED",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 1
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId} get put delete

get /rules/{ruleId}

Retrieves a specific rule.

Secured by oauth_2_0 with scopes:
  • rule:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

HTTP status code 200

Rule is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Rule ID.

  • name: required(string)

    Rule name.

  • description: optional (string)

    Rule description.

  • expression: required(string)

    Rule expression.

  • state: optional (one of ENABLED, DISABLED - default: ENABLED)

    enables or disables the rule.

  • uiMetadata: optional (string)

    UI metadata.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the rule was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the rule was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "47e17fc5-060c-4923-b315-d17f6a1bf8d6",
  "name": "Low battery",
  "description": "Checks if sensor has low battery",
  "expression": "return ctx.endpoint.getMetadata().battery.status == 'low'",
  "state": "ENABLED",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /rules/{ruleId}

Updates a rule.

Secured by oauth_2_0 with scopes:
  • rule:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Rule name.

  • description: optional (string)

    Rule description.

  • expression: required(string)

    Rule expression.

  • state: optional (one of ENABLED, DISABLED - default: ENABLED)

    Enables or disables the rule.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "Low battery",
  "description": "Checks if sensor has low battery",
  "expression": "return ctx.endpoint.getMetadata().battery.status == 'low'",
  "state": "ENABLED",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Rule is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /rules/{ruleId}

Deletes rule.

Secured by oauth_2_0 with scopes:
  • rule:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

HTTP status code 204

Rule is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/actions get

get /rules/{ruleId}/actions

Retrieves actions attached to rule.

Secured by oauth_2_0 with scopes:
  • rule:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

HTTP status code 200

Actions attached to the rule are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of AttachedAction)

    Items: AttachedAction

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • type: required(string)

      Action type.

  • negativeActions: required(array of AttachedAction)

    Items: AttachedAction

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • type: required(string)

      Action type.

Example:

{
  "positiveActions": [
    {
      "id": "1",
      "name": "Switch light",
      "type": "command-invocation"
    }
  ],
  "negativeActions": [
    {
      "id": "2",
      "name": "Turn on water pump",
      "type": "command-invocation"
    }
  ]
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/triggers get

get /rules/{ruleId}/triggers

Retrieves triggers attached to rule.

Secured by oauth_2_0 with scopes:
  • rule:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

HTTP status code 200

Triggers attached to the rule are successfully retrieved.

Body

Media type: application/json

Type: array of AttachedTrigger

Items: AttachedTrigger

  • id: required(string)

    Trigger ID.

  • name: required(string)

    Trigger name.

  • type: required(string)

    Trigger type.

Example:

[
  {
    "id": "1",
    "name": "Simple trigger",
    "type": "cron"
  }
]

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/command-invocation/actions put

put /rules/{ruleId}/action-types/command-invocation/actions

Updates attached command invocation actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • command-invocation-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached to rule command invocation actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/metadata-update/actions put

put /rules/{ruleId}/action-types/metadata-update/actions

Updates attached metadata update actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • metadata-update-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached to rule metadata update actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/webhook/actions put

put /rules/{ruleId}/action-types/webhook/actions

Updates attached webhook actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • webhook-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached to rule webhook actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/rule-execution/actions put

put /rules/{ruleId}/action-types/rule-execution/actions

Updates attached rule execution actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • rule-execution-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached rule execution actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/data-sample/actions put

put /rules/{ruleId}/action-types/data-sample/actions

Updates attached data sample actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • data-sample-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached data sample actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/time-series/actions put

put /rules/{ruleId}/action-types/time-series/actions

Updates attached time series actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • time-series-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached time series event actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/alert-activation/actions put

put /rules/{ruleId}/action-types/alert-activation/actions

Updates attached alert activation actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • alert-activation-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached alert activation actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/action-types/alert-resolution/actions put

put /rules/{ruleId}/action-types/alert-resolution/actions

Updates attached alert resolution actions.

Secured by oauth_2_0 with scopes:
  • rule:update
  • alert-resolution-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: object

Properties

  • positiveActions: required(array of )
  • negativeActions: required(array of )

Example:

{
  "positiveActions": ["1", "2"],
  "negativeActions": ["3", "4"]
}

HTTP status code 204

Attached alert resolution actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/trigger-types/endpoint-metadata-updated/triggers put

put /rules/{ruleId}/trigger-types/endpoint-metadata-updated/triggers

Updates attached 'endpoint metadata updated' triggers.

Secured by oauth_2_0 with scopes:
  • rule:update
  • endpoint-metadata-updated-trigger:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: array of string

Example:

[
  "1"
]

HTTP status code 204

Attached 'endpoint metadata updated' triggers are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/trigger-types/cron/triggers put

put /rules/{ruleId}/trigger-types/cron/triggers

Updates attached 'cron' triggers.

Secured by oauth_2_0 with scopes:
  • rule:update
  • cron-trigger:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: array of string

Example:

[
  "1"
]

HTTP status code 204

Attached 'cron' triggers are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/rules/{ruleId}/trigger-types/endpoint-time-series-updated/triggers put

put /rules/{ruleId}/trigger-types/endpoint-time-series-updated/triggers

Updates attached 'endpoint time series updated' triggers.

Secured by oauth_2_0 with scopes:
  • rule:update
  • endpoint-time-series-updated-trigger:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • ruleId: required(string)

    Rule ID

Body

Media type: application/json

Type: array of string

Example:

[
  "1"
]

HTTP status code 204

Attached 'endpoint time series updated' triggers are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

Actions

Operations on actions.

/action-types/command-invocation/actions post get

post /action-types/command-invocation/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:command-invocation-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • commandType: required(string)

    Command type.

  • commandPayloadExpression: optional (string)

    Command payload expression.

Example:

{
  "name": "Switch light",
  "description": "Turns on/off light depending on the endpoint state",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "commandType": "SWITCH_LIGHT",
  "commandPayloadExpression": "return {switch: ctx.endpoint.getMetadata().state === 'opened' ? 'on' : 'off'};",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/command-invocation/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/command-invocation/actions/10

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/command-invocation/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • command-invocation-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of CommandActionResponse)

    Items: CommandActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • endpointIdExpression: required(string)

      Endpoint ID expression.

    • commandType: required(string)

      Command type.

    • commandPayloadExpression: optional (string)

      Command payload expression.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the rule was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the rule was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "1",
      "name": "Switch light",
      "description": "Turns on/off light depending on the endpoint state",
      "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
      "commandType": "SWITCH_LIGHT",
      "commandPayloadExpression": "return {switch: ctx.endpoint.getMetadata().state === 'opened' ? 'on' : 'off'}",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    },
    {
      "id": "2",
      "name": "Switch heater",
      "description": "Turns on/off parent endpoint heater depending on the child endpoint state",
      "endpointIdExpression": "return ctx.endpoint.getParent().getId()",
      "commandType": "SWITCH_HEATER",
      "commandPayloadExpression": "return {switch: ctx.endpoint.getMetadata().state === 'opened' ? 'on' : 'off'}",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 2
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/command-invocation/actions/{actionId} get put delete

get /action-types/command-invocation/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • command-invocation-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • commandType: required(string)

    Command type.

  • commandPayloadExpression: optional (string)

    Command payload expression.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the rule was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the rule was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "1",
  "name": "Switch light",
  "description": "Turns on/off light depending on the endpoint state",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "commandType": "SWITCH_LIGHT",
  "commandPayloadExpression": "return {switch: ctx.endpoint.getMetadata().state === 'opened' ? 'on' : 'off'}",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/command-invocation/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • command-invocation-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • commandType: required(string)

    Command type.

  • commandPayloadExpression: optional (string)

    Command payload expression.

Example:

{
  "name": "Switch light",
  "description": "Turns on/off light depending on the endpoint state",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "commandType": "SWITCH_LIGHT",
  "commandPayloadExpression": "return {switch: ctx.endpoint.getMetadata().state === 'opened' ? 'on' : 'off'};",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/command-invocation/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • command-invocation-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/metadata-update/actions post get

post /action-types/metadata-update/actions

Creates a new metadata update action.

Secured by oauth_2_0 with scopes:
  • tenant:metadata-update-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • metadataKeyExpression: required(string)

    Metadata key expression to update key.

  • metadataValueExpression: required(string)

    Metadata value expression.

Example:

{
  "name": "Lighting state",
  "description": "Updates the parent endpoint lighting state depending on the child endpoint state",
  "endpointIdExpression": "return ctx.endpoint.getParent().getId()",
  "metadataKeyExpression": "return ctx.endpoint.getMetadata().device_type + '.status'",
  "metadataValueExpression": "return ctx.endpoint.getMetadata().state == 'opened' ? 'on' : 'off'",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/metadata-update/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/metadata-update/actions/18

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/metadata-update/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • metadata-update-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of MetadataUpdateActionResponse)

    Items: MetadataUpdateActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • endpointIdExpression: required(string)

      Endpoint ID expression.

    • metadataKeyExpression: required(string)

      Metadata key expression to update key

    • metadataValueExpression: required(string)

      Metadata value expression.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "2",
      "name": "Lighting state",
      "description": "Updates the parent endpoint lighting state depending on the child endpoint state",
      "endpointIdExpression": "return ctx.endpoint.getParent().getId()",
      "metadataKeyExpression": "return ctx.endpoint.getMetadata().device_type + '.status'",
      "metadataValueExpression": "return ctx.endpoint.getMetadata().state == 'opened' ? 'on' : 'off'",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 1
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/metadata-update/actions/{actionId} get put delete

get /action-types/metadata-update/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • metadata-update-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • metadataKeyExpression: required(string)

    Metadata key expression to update key

  • metadataValueExpression: required(string)

    Metadata value expression.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "2",
  "name": "Lighting state",
  "description": "Updates the parent endpoint lighting state depending on the child endpoint state",
  "endpointIdExpression": "return ctx.endpoint.getParent().getId()",
  "metadataKeyExpression": "return ctx.endpoint.getMetadata().device_type + '.status'",
  "metadataValueExpression": "return ctx.endpoint.getMetadata().state == 'opened' ? 'on' : 'off'",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/metadata-update/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • metadata-update-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • metadataKeyExpression: required(string)

    Metadata key expression to update key.

  • metadataValueExpression: required(string)

    Metadata value expression.

Example:

{
  "name": "Lighting state",
  "description": "Updates the parent endpoint lighting state depending on the child endpoint state",
  "endpointIdExpression": "return ctx.endpoint.getParent().getId()",
  "metadataKeyExpression": "return ctx.endpoint.getMetadata().device_type + '.status'",
  "metadataValueExpression": "return ctx.endpoint.getMetadata().state == 'opened' ? 'on' : 'off'",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/metadata-update/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • metadata-update-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/webhook/actions post get

post /action-types/webhook/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:webhook-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • webhookUrl: required(string)

    Webhook URL.

  • headers: optional (object)

    Wehbook HTTP headers.

    • : optional ( - repeat: function () { for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) { args[_key2] = arguments[_key2]; } return obj[val].apply(obj, args); })
  • webhookPayloadExpression: optional (string)

    Webhook payload expression.

Example:

{
  "name": "Water leakage email alert",
  "description": "Sends email alert with the endpoint water leakage state",
  "webhookUrl": "https://cloud.kaaiot.com/aa/api/v1/applications/cdhn26a09eau0udkrcj2/actions/email-notification/32/webhooks/cf8qn5ooq9sqgvjlajod",
  "headers": {
    "X-Token": "Qf3YvMiNRZPu0ZRb2OjlxRqevccCc5tB"
  },
  "webhookPayloadExpression": "return 'Water leakage state is ' + ctx.endpoint.getMetadata().state.waterLeakage",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/webhook/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/webhook/actions/37

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/webhook/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • webhook-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of WebhookActionResponse)

    Items: WebhookActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • webhookUrl: required(string)

      Webhook URL.

    • headers: optional (object)

      Wehbook HTTP headers.

      • : optional ( - repeat: function () { for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) { args[_key2] = arguments[_key2]; } return obj[val].apply(obj, args); })
    • webhookPayloadExpression: optional (string)

      Webhook payload expression.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "4",
      "name": "Water leakage email alert",
      "description": "Sends email alert with the endpoint water leakage state",
      "webhookUrl": "https://cloud.kaaiot.com/aa/api/v1/applications/cdhn26a09eau0udkrcj2/actions/email-notification/32/webhooks/cf8qn5ooq9sqgvjlajod",
      "headers": {
        "X-Token": "Qf3YvMiNRZPu0ZRb2OjlxRqevccCc5tB"
      },
      "webhookPayloadExpression": "return 'Water leakage state is ' + ctx.endpoint.getMetadata().state.waterLeakage",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 1
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/webhook/actions/{actionId} get put delete

get /action-types/webhook/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • webhook-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • webhookUrl: required(string)

    Webhook URL.

  • headers: optional (object)

    Wehbook HTTP headers.

    • : optional ( - repeat: function () { for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) { args[_key2] = arguments[_key2]; } return obj[val].apply(obj, args); })
  • webhookPayloadExpression: optional (string)

    Webhook payload expression.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "4",
  "name": "Water leakage email alert",
  "description": "Sends email alert with the endpoint water leakage state",
  "webhookUrl": "https://cloud.kaaiot.com/aa/api/v1/applications/cdhn26a09eau0udkrcj2/actions/email-notification/32/webhooks/cf8qn5ooq9sqgvjlajod",
  "headers": {
    "X-Token": "Qf3YvMiNRZPu0ZRb2OjlxRqevccCc5tB"
  },
  "webhookPayloadExpression": "return 'Water leakage state is ' + ctx.endpoint.getMetadata().state.waterLeakage",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/webhook/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • webhook-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • webhookUrl: required(string)

    Webhook URL.

  • headers: optional ()
  • webhookPayloadExpression: optional (string)

    Webhook payload expression.

Example:

{
  "name": "Water leakage email alert",
  "description": "Sends email alert with the endpoint water leakage state",
  "webhookUrl": "https://cloud.kaaiot.com/aa/api/v1/applications/cdhn26a09eau0udkrcj2/actions/email-notification/32/webhooks/cf8qn5ooq9sqgvjlajod",
  "headers": {
    "X-Token": "Qf3YvMiNRZPu0ZRb2OjlxRqevccCc5tB"
  },
  "webhookPayloadExpression": "return 'Water leakage state is ' + ctx.endpoint.getMetadata().state.waterLeakage",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/webhook/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • webhook-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/rule-execution/actions post get

post /action-types/rule-execution/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:rule-execution-action:create
  • rule:execute

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • ruleId: required(string)

    The ID of the rule to execute.

Example:

{
  "name": "Check lighting state",
  "description": "Runs the rule that checks lighting state",
  "ruleId": "f6fde168-bbff-4383-9912-b9e6c51b7a88",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/rule-execution/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/rule-execution/actions/68

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/rule-execution/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • rule-execution-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • ruleId: optional (string)

    Rule ID.

    Example:

    47e17fc5-060c-4923-b315-d17f6a1bf8d6
  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of RuleExecutionActionResponse)

    Items: RuleExecutionActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • ruleId: required(string)

      The ID of the rule to execute.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "3",
      "name": "Check lighting state",
      "description": "Runs the rule that checks lighting state",
      "ruleId": "f6fde168-bbff-4383-9912-b9e6c51b7a88",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 1
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/rule-execution/actions/{actionId} get put delete

get /action-types/rule-execution/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • rule-execution-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • ruleId: required(string)

    The ID of the rule to execute.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "3",
  "name": "Check lighting state",
  "description": "Runs the rule that checks lighting state",
  "ruleId": "f6fde168-bbff-4383-9912-b9e6c51b7a88",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/rule-execution/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • rule-execution-action:update
  • rule:execute

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • ruleId: required(string)

    The ID of the rule to execute.

Example:

{
  "name": "Check lighting state",
  "description": "Runs the rule that checks lighting state",
  "ruleId": "f6fde168-bbff-4383-9912-b9e6c51b7a88",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/rule-execution/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • rule-execution-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/data-sample/actions post get

post /action-types/data-sample/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:data-sample-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    The expression that returns the endpoint ID to send data samples on behalf of.

  • dataSamplesExpression: required(string)

    Expression that returns data sample(s) to send.

Example:

{
  "name": "Temperature sensor",
  "description": "Publishes temperature data samples.",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "dataSamplesExpression": "return [{temperature:23}];",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/data-sample/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/data-sample/actions/70

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/data-sample/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • data-sample-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of DataSampleActionResponse)

    Items: DataSampleActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • endpointIdExpression: required(string)

      The expression that returns the endpoint ID to send data samples on behalf of.

    • dataSamplesExpression: required(string)

      Expression that returns data sample(s) to send.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "5",
      "name": "Temperature sensor",
      "description": "Publishes temperature data samples.",
      "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
      "dataSamplesExpression": "return [{temperature:23}];",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 2
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/data-sample/actions/{actionId} get put delete

get /action-types/data-sample/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • data-sample-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    The expression that returns the endpoint ID to send data samples on behalf of.

  • dataSamplesExpression: required(string)

    Expression that returns data sample(s) to send.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "5",
  "name": "Temperature sensor",
  "description": "Publishes temperature data samples.",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "dataSamplesExpression": "return [{temperature:23}]",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/data-sample/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • data-sample-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    The expression that returns the endpoint ID to send data samples on behalf of.

  • dataSamplesExpression: required(string)

    Expression that returns data sample(s) to send.

Example:

{
  "name": "Temperature sensor",
  "description": "Publishes temperature data samples.",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "dataSamplesExpression": "return [{temperature:23}];",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/data-sample/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • data-sample-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/time-series/actions post get

post /action-types/time-series/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:time-series-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    The expression that returns the endpoint ID to send time series on behalf of.

  • timeSeriesNameExpression: required(string)

    The expression that returns the time series name.

  • timeSeriesExpression: required(string)

    Expression that returns time series data to send.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "Weather sensor",
  "description": "Publishes weather time series data",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "timeSeriesNameExpression": "return 'time-series'",
  "timeSeriesExpression": "return [{temperature:10,humidity:63}]",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/time-series/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/time-series/actions/70

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/time-series/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • time-series-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of TimeSeriesEventActionResponse)

    Items: TimeSeriesEventActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • endpointIdExpression: required(string)

      The expression that returns the endpoint ID to send time series on behalf of.

    • timeSeriesNameExpression: required(string)

      The expression that returns the time series name.

    • timeSeriesExpression: required(string)

      Expression that returns time series data to send.

    • uiMetadata: optional (string)

      UI metadata.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "7",
      "name": "Weather sensor",
      "description": "Publishes weather time series data",
      "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
      "timeSeriesNameExpression": "return 'time-series'",
      "timeSeriesExpression": "return [{temperature:10,humidity:63}]",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-07-30T12:30:54.540Z",
      "updatedAt": "2023-08-30T12:30:54.541Z"
    }
  ],
  "totalElements": 1
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/time-series/actions/{actionId} get put delete

get /action-types/time-series/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • time-series-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    The expression that returns the endpoint ID to send time series on behalf of.

  • timeSeriesNameExpression: required(string)

    The expression that returns the time series name.

  • timeSeriesExpression: required(string)

    Expression that returns time series data to send.

  • uiMetadata: optional (string)

    UI metadata.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "7",
  "name": "Weather sensor",
  "description": "Publishes weather time series data",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "timeSeriesNameExpression": "return 'time-series'",
  "timeSeriesExpression": "return [{temperature:10,humidity:63}]",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-07-30T12:30:54.540Z",
  "updatedAt": "2023-08-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/time-series/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • time-series-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • endpointIdExpression: required(string)

    The expression that returns the endpoint ID to send time series on behalf of.

  • timeSeriesNameExpression: required(string)

    The expression that returns the time series name.

  • timeSeriesExpression: required(string)

    Expression that returns time series data to send.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "Weather sensor",
  "description": "Publishes weather time series data",
  "endpointIdExpression": "return '65efe88c-6875-4aa6-a064-8c65f9f40514'",
  "timeSeriesNameExpression": "return 'time-series'",
  "timeSeriesExpression": "return [{temperature:10,humidity:63}]",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/time-series/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • time-series-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/alert-activation/actions post get

post /action-types/alert-activation/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:alert-activation-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

  • severityLevelExpression: required(string)

    Returns alert severity level. Must return one of "INFO", "LOW", "MEDIUM", "HIGH", "CRITICAL".

  • entityType: required(ENDPOINT)

    Type of an entity that alert relates to.

  • entityIdExpression: required(string)

    Expression that returns ID of an entity that alert raised on.

  • activateReasonExpression: required(string)

    Expression that returns activation reason.

  • startedAtExpression: optional (string)

    Expression that returns when the alert was started. Must return timestamp in millis.

  • lastActiveAtExpression: optional (string)

    Expression that returns when the alert was last active at. Must return timestamp in millis.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "High temperature",
  "description": "Sensor reports high temperature",
  "alertTypeExpression": "return 'HIGH_TEMPERATURE';",
  "severityLevelExpression": "return 'HIGH';",
  "entityType": "ENDPOINT",
  "entityIdExpression": "return 'endpoint-id-1';",
  "activateReasonExpression": "return 'High temperature';",
  "startedAtExpression": "return new Date('2023-11-06T21:53:07Z').getTime();",
  "lastActiveAtExpression": "return 1699307588000;",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/alert-activation/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/alert-activation/actions/37

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/alert-activation/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • alert-activation-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of ActionResponse)

    Items: ActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • alertTypeExpression: required(string)

      Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

    • severityLevelExpression: required(string)

      Returns alert severity level. Must return one of "INFO", "LOW", "MEDIUM", "HIGH", "CRITICAL".

    • entityType: required(ENDPOINT)

      Type of an entity that alert relates to.

    • entityIdExpression: required(string)

      Expression that returns ID of an entity that alert raised on.

    • activateReasonExpression: required(string)

      Expression that returns activation reason.

    • startedAtExpression: optional (string)

      Expression that returns when the alert was started. Must return timestamp in millis.

    • lastActiveAtExpression: optional (string)

      Expression that returns when the alert was last active at. Must return timestamp in millis.

    • uiMetadata: optional (string)

      UI metadata.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "75b05695-27ca-46eb-9481-69c199088d99",
      "name": "High temperature",
      "description": "Sensor reports high temperature",
      "alertTypeExpression": "return 'HIGH_TEMPERATURE';",
      "severityLevelExpression": "return 'HIGH';",
      "entityType": "ENDPOINT",
      "entityIdExpression": "return 'endpoint-id-1';",
      "activateReasonExpression": "return 'High temperature';",
      "startedAtExpression": "return new Date('2023-11-06T21:53:07Z').getTime();",
      "lastActiveAtExpression": "return 1699307588000;",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 2
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/alert-activation/actions/{actionId} get put delete

get /action-types/alert-activation/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • alert-activation-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

  • severityLevelExpression: required(string)

    Returns alert severity level. Must return one of "INFO", "LOW", "MEDIUM", "HIGH", "CRITICAL".

  • entityType: required(ENDPOINT)

    Type of an entity that alert relates to.

  • entityIdExpression: required(string)

    Expression that returns ID of an entity that alert raised on.

  • activateReasonExpression: required(string)

    Expression that returns activation reason.

  • startedAtExpression: optional (string)

    Expression that returns when the alert was started. Must return timestamp in millis.

  • lastActiveAtExpression: optional (string)

    Expression that returns when the alert was last active at. Must return timestamp in millis.

  • uiMetadata: optional (string)

    UI metadata.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "75b05695-27ca-46eb-9481-69c199088d99",
  "name": "High temperature",
  "description": "Sensor reports high temperature",
  "alertTypeExpression": "return 'HIGH_TEMPERATURE';",
  "severityLevelExpression": "return 'HIGH';",
  "entityType": "ENDPOINT",
  "entityIdExpression": "return 'endpoint-id-1';",
  "activateReasonExpression": "return 'High temperature';",
  "startedAtExpression": "return new Date('2023-11-06T21:53:07Z').getTime();",
  "lastActiveAtExpression": "return 1699307588000;",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/alert-activation/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • alert-activation-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

  • severityLevelExpression: required(string)

    Returns alert severity level. Must return one of "INFO", "LOW", "MEDIUM", "HIGH", "CRITICAL".

  • entityType: required(ENDPOINT)

    Type of an entity that alert relates to.

  • entityIdExpression: required(string)

    Expression that returns ID of an entity that alert raised on.

  • activateReasonExpression: required(string)

    Expression that returns activation reason.

  • startedAtExpression: optional (string)

    Expression that returns when the alert was started. Must return timestamp in millis.

  • lastActiveAtExpression: optional (string)

    Expression that returns when the alert was last active at. Must return timestamp in millis.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "High temperature",
  "description": "Sensor reports high temperature",
  "alertTypeExpression": "return 'HIGH_TEMPERATURE';",
  "severityLevelExpression": "return 'HIGH';",
  "entityType": "ENDPOINT",
  "entityIdExpression": "return 'endpoint-id-1';",
  "activateReasonExpression": "return 'High temperature';",
  "startedAtExpression": "return new Date('2023-11-06T21:53:07Z').getTime();",
  "lastActiveAtExpression": "return 1699307588000;",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/alert-activation/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • alert-activation-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/alert-resolution/actions post get

post /action-types/alert-resolution/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:alert-resolution-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

  • entityType: required(ENDPOINT)

    Type of an entity that alert relates to.

  • entityIdExpression: required(string)

    Expression that returns ID of an entity that alert raised on.

  • resolveReasonExpression: required(string)

    Expression that returns resolution reason.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "OK temperature",
  "description": "Sensor reports OK temperature",
  "alertType": "HIGH_TEMPERATURE",
  "entityType": "ENDPOINT",
  "entityIdExpression": "return 'endpoint-id-1';",
  "resolveReasonExpression": "return 'temperature back to norm';",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"

}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/alert-resolution/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/alert-resolution/actions/37

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/alert-resolution/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • alert-resolution-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of ActionResponse)

    Items: ActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • alertTypeExpression: required(string)

      Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

    • entityType: required(ENDPOINT)

      Type of an entity that alert relates to.

    • entityIdExpression: required(string)

      Expression that returns ID of an entity that alert raised on.

    • resolveReasonExpression: required(string)

      Expression that returns resolution reason.

    • uiMetadata: optional (string)

      UI metadata.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "6b8b6b4d-127d-44b6-9a14-10b0bc60b7dd",
      "name": "OK temperature",
      "description": "Sensor reports OK temperature",
      "alertType": "HIGH_TEMPERATURE",
      "entityType": "ENDPOINT",
      "entityIdExpression": "return 'endpoint-id-1';",
      "resolveReasonExpression": "return 'temperature back to norm';",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 2
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/alert-resolution/actions/{actionId} get put delete

get /action-types/alert-resolution/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • alert-resolution-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

  • entityType: required(ENDPOINT)

    Type of an entity that alert relates to.

  • entityIdExpression: required(string)

    Expression that returns ID of an entity that alert raised on.

  • resolveReasonExpression: required(string)

    Expression that returns resolution reason.

  • uiMetadata: optional (string)

    UI metadata.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "6b8b6b4d-127d-44b6-9a14-10b0bc60b7dd",
  "name": "OK temperature",
  "description": "Sensor reports OK temperature",
  "alertType": "HIGH_TEMPERATURE",
  "entityType": "ENDPOINT",
  "entityIdExpression": "return 'endpoint-id-1';",
  "resolveReasonExpression": "return 'temperature back to norm';",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/alert-resolution/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • alert-resolution-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[A-Z0-9_]{3,50}+$ pattern.

  • entityType: required(ENDPOINT)

    Type of an entity that alert relates to.

  • entityIdExpression: required(string)

    Expression that returns ID of an entity that alert raised on.

  • resolveReasonExpression: required(string)

    Expression that returns resolution reason.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "OK temperature",
  "description": "Sensor reports OK temperature",
  "alertType": "HIGH_TEMPERATURE",
  "entityType": "ENDPOINT",
  "entityIdExpression": "return 'endpoint-id-1';",
  "resolveReasonExpression": "return 'temperature back to norm';",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"

}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/alert-resolution/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • alert-resolution-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/send-email/actions post get

post /action-types/send-email/actions

Creates a new action.

Secured by oauth_2_0 with scopes:
  • tenant:send-email-action:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • recipientsExpression: required(string)

    Email recipients.

  • subjectExpression: required(string)

    Email subject expression.

  • textExpression: required(string)

    Email text expression.

  • sender: required(string)

    Email sender.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "High temperature",
  "description": "Sensor reports high temperature",
  "recipientsExpression": "return ['tom@acme.com', 'jerry@acme.com']",
  "subjectExpression": "return 'High temperature';",
  "textExpression": "return 'Current temperature is ' + 20;",
  "sender": "monitoring@acme.com",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 201

Action is successfully created.

Headers

  • Location: required(string)

    URI in format {schema}://{host}/re/api/v1/action-types/send-email/actions/{actionId}

    Example:

    https://cloud.kaaiot.com/re/api/v1/action-types/send-email/actions/37

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 403

Principal does not have sufficient permissions to perform this operation.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

get /action-types/send-email/actions

Retrieves actions.

Secured by oauth_2_0 with scopes:
  • send-email-action:read

RE supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10
  • name: optional (string)

    Name. Supports partial match.

    Example:

    myName
  • description: optional (string)

    Description. Supports partial match.

    Example:

    myDescription
  • sort: optional (one of createdAt, updatedAt - default: createdAt)

    Field to sort by.

    Example:

    updatedAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc

HTTP status code 200

Actions are successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of ActionResponse)

    Items: ActionResponse

    • id: required(string)

      Action ID.

    • name: required(string)

      Action name.

    • description: optional (string)

      Action description.

    • recipientsExpression: required(string)

      Email recipients.

    • subjectExpression: required(string)

      Email subject expression.

    • textExpression: required(string)

      Email text expression.

    • sender: required(string)

      Email sender.

    • uiMetadata: optional (string)

      UI metadata.

    • createdAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

      Example:

      2023-06-30T12:30:54.540Z
    • updatedAt: required(datetime)

      Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

      Example:

      2023-06-30T12:30:54.540Z

Example:

{
  "content": [
    {
      "id": "75b05695-27ca-46eb-9481-69c199088d99",
      "name": "High temperature",
      "description": "Sensor reports high temperature",
      "recipientsExpression": "return ['tom@acme.com', 'jerry@acme.com']",
      "subjectExpression": "return 'High temperature';",
      "textExpression": "return 'Current temperature is ' + 20;",
      "sender": "monitoring@acme.com",
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "updatedAt": "2023-06-30T12:30:54.541Z"
    }
  ],
  "totalElements": 2
}

HTTP status code 401

Request is not authenticated.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

/action-types/send-email/actions/{actionId} get put delete

get /action-types/send-email/actions/{actionId}

Retrieves action.

Secured by oauth_2_0 with scopes:
  • send-email-action:read

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • recipientsExpression: required(string)

    Email recipients.

  • subjectExpression: required(string)

    Email subject expression.

  • textExpression: required(string)

    Email text expression.

  • sender: required(string)

    Email sender.

  • uiMetadata: optional (string)

    UI metadata.

  • createdAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was created.

    Example:

    2023-06-30T12:30:54.540Z
  • updatedAt: required(datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the action was last updated.

    Example:

    2023-06-30T12:30:54.540Z

Example:

{
  "id": "75b05695-27ca-46eb-9481-69c199088d99",
  "name": "High temperature",
  "description": "Sensor reports high temperature",
  "recipientsExpression": "return ['tom@acme.com', 'jerry@acme.com']",
  "subjectExpression": "return 'High temperature';",
  "textExpression": "return 'Current temperature is ' + 20;",
  "sender": "monitoring@acme.com",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
  "createdAt": "2023-06-30T12:30:54.540Z",
  "updatedAt": "2023-06-30T12:30:54.541Z"
}

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

put /action-types/send-email/actions/{actionId}

Updates action.

Secured by oauth_2_0 with scopes:
  • send-email-action:update

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • recipientsExpression: required(string)

    Email recipients.

  • subjectExpression: required(string)

    Email subject expression.

  • textExpression: required(string)

    Email text expression.

  • sender: required(string)

    Email sender.

  • uiMetadata: optional (string)

    UI metadata.

Example:

{
  "name": "High temperature",
  "description": "Sensor reports high temperature",
  "recipientsExpression": "return ['tom@acme.com', 'jerry@acme.com']",
  "subjectExpression": "return 'High temperature';",
  "textExpression": "return 'Current temperature is ' + 20;",
  "sender": "monitoring@acme.com",
  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
}

HTTP status code 204

Action is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

delete /action-types/send-email/actions/{actionId}

Deletes action.

Secured by oauth_2_0 with scopes:
  • send-email-action:delete

RE supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • actionId: required(string)

    Action ID

HTTP status code 204

Action is successfully deleted.

HTTP status code 401

Request is not authenticated.

HTTP status code 404

Resource not found or querying user is not authorized for it.

Secured by oauth_2_0

Headers

  • Authorization: optional (string)

    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

Expressions

Operations on expressions.

/expressions/evaluation post

post /expressions/evaluation

Evaluates expression against provided data.

Body

Media type: application/json

Type: object

Properties

  • expression: required(string)

    Expression to evaluate.

  • endpointMetadata: optional (any)

    Endpoint metadata to run evaluation against.

  • childrenEndpoints: optional (array of )

    Children endpoints to run evaluation against.

Example:

{
  "expression": "ctx.endpointMetadata['fed5c358-1240-4ff0-adca-929bae563ad3'].currentStatus == 'alarm' && ctx.childrenEndpoints['d006175b-69bc-40a1-8bda-89686102933e'].size() == 2",
  "endpointMetadata": {
    "currentStatus": "alarm"
  },
  "childrenEndpoints": [
    "d006175b-69bc-40a1-8bda-89686102933e",
    "7981f9a6-00b0-11ee-be56-0242ac120002"
  ]
}

HTTP status code 200

Expression is successfully evaluated.

Body

Media type: application/json

Type: any

Example:

true

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

  • message: required(string)

    Detailed error description.

HTTP status code 401

Request is not authenticated.

Triggers

Operations on triggers.

/trigger-types/endpoint-metadata-updated/triggers post get

post /trigger-types/endpoint-metadata-updated/triggers

Creates a new trigger.

Secured by oauth_2_0 with scopes:
  • tenant:endpoint-metadata-updated-trigger:create

RE supports OAuth 2.0 for authenticating all API requests.

Body

Media type: application/json

Type: object

Properties

  • name: required(string)

    Trigger name.

  • description: optional (string)

    Trigger description.

  • appName: optional (string)

    Application name of the endpoint(s) that trigger will react on.

  • appVersionName: optional (string)

    Application version of the endpoint(s) that trigger will react on.

  • endpointIds: optional (array of )

    Endpoint IDs that trigger will react on.

  • metadata: optional (object)

    Additional trigger metadata.

    • uiMetadata: optional (string)

      UI metadata.

    Example:

    {
      "name": "1",
      "description": "Trigger description",
      "endpointIds": [
        "98ced78d-6875-8bd6-c064-8c65f9f40514",
        "65efe88c-6875-4aa6-a064-7a38f9c40519"
      ],
      "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
    }
    

    HTTP status code 201

    Trigger is successfully created.

    Headers

    • Location: required(string)

      URI in format {schema}://{host}/re/api/v1/trigger-types/endpoint-metadata-updated/triggers/{triggerId}

      Example:

      https://cloud.kaaiot.com/re/api/v1/trigger-types/endpoint-metadata-updated/triggers/25

    HTTP status code 400

    Invalid request.

    Body

    Media type: application/json

    Type: object

    Properties

    • message: required(string)

      Detailed error description.

    HTTP status code 401

    Request is not authenticated.

    HTTP status code 403

    Principal does not have sufficient permissions to perform this operation.

    Secured by oauth_2_0

    Headers

    • Authorization: optional (string)

      Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

    get /trigger-types/endpoint-metadata-updated/triggers

    Returns trigger list.

    Secured by oauth_2_0 with scopes:
    • endpoint-metadata-updated-trigger:read

    RE supports OAuth 2.0 for authenticating all API requests.

    Query Parameters

    • page: optional (number - default: 0)

      Page number.

      Example:

      0
    • size: optional (number - default: 100)

      Page size.

      Example:

      10

    HTTP status code 200

    Triggers are successfully retrieved.

    Body

    Media type: application/json

    Type: object

    Properties

    • totalElements: required(integer)

      Total number of elements available for retrieval.

    • content: required(array of TriggerResponse)

      Items: TriggerResponse

      • id: required(string)

        Trigger ID.

      • name: required(string)

        Trigger name.

      • description: optional (string)

        Trigger description.

      • appName: optional (string)

        Application name of the endpoint(s) that trigger will react on.

      • appVersionName: optional (string)

        Application version of the endpoint(s) that trigger will react on.

      • endpointIds: optional (array of )

        Endpoint IDs that trigger will react on.

      • metadata: optional (object)

        Additional trigger metadata.

        • uiMetadata: optional (string)

          UI metadata.

      Example:

      {
        "content": [
          {
            "id": "2",
            "name": "Trigger name",
            "description": "Trigger description",
            "endpointIds": [
              "98ced78d-6875-8bd6-c064-8c65f9f40514",
              "65efe88c-6875-4aa6-a064-7a38f9c40519"
            ],
            "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
            "createdAt": "2023-06-30T12:30:54.540Z",
            "updatedAt": "2023-06-30T12:30:54.541Z"
          }
        ],
        "totalElements": 1
      }
      

      HTTP status code 401

      Request is not authenticated.

      Secured by oauth_2_0

      Headers

      • Authorization: optional (string)

        Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

      /trigger-types/endpoint-metadata-updated/triggers/{triggerId} get put delete

      get /trigger-types/endpoint-metadata-updated/triggers/{triggerId}

      Returns trigger by ID.

      Secured by oauth_2_0 with scopes:
      • endpoint-metadata-updated-trigger:read

      RE supports OAuth 2.0 for authenticating all API requests.

      URI Parameters

      • triggerId: required(string)

        Trigger ID

      HTTP status code 200

      Trigger is successfully retrieved.

      Body

      Media type: application/json

      Type: object

      Properties

      • id: required(string)

        Trigger ID.

      • name: required(string)

        Trigger name.

      • description: optional (string)

        Trigger description.

      • appName: optional (string)

        Application name of the endpoint(s) that trigger will react on.

      • appVersionName: optional (string)

        Application version of the endpoint(s) that trigger will react on.

      • endpointIds: optional (array of )

        Endpoint IDs that trigger will react on.

      • metadata: optional (object)

        Additional trigger metadata.

        • uiMetadata: optional (string)

          UI metadata.

        Example:

        {
          "id": "2",
          "name": "Trigger name",
          "description": "Trigger description",
          "endpointIds": [
            "98ced78d-6875-8bd6-c064-8c65f9f40514",
            "65efe88c-6875-4aa6-a064-7a38f9c40519"
          ],
          "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
          "createdAt": "2023-06-30T12:30:54.540Z",
          "updatedAt": "2023-06-30T12:30:54.541Z"
        }
        

        HTTP status code 400

        Invalid request.

        Body

        Media type: application/json

        Type: object

        Properties

        • message: required(string)

          Detailed error description.

        HTTP status code 401

        Request is not authenticated.

        HTTP status code 404

        Resource not found or querying user is not authorized for it.

        Secured by oauth_2_0

        Headers

        • Authorization: optional (string)

          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

        put /trigger-types/endpoint-metadata-updated/triggers/{triggerId}

        Updates a trigger.

        Secured by oauth_2_0 with scopes:
        • endpoint-metadata-updated-trigger:update

        RE supports OAuth 2.0 for authenticating all API requests.

        URI Parameters

        • triggerId: required(string)

          Trigger ID

        Body

        Media type: application/json

        Type: object

        Properties

        • name: required(string)

          Trigger name.

        • description: optional (string)

          Trigger description.

        • appName: optional (string)

          Application name of the endpoint(s) that trigger will react on.

        • appVersionName: optional (string)

          Application version of the endpoint(s) that trigger will react on.

        • endpointIds: optional (array of )

          Endpoint IDs that trigger will react on.

        • metadata: optional (object)

          Additional trigger metadata.

          • uiMetadata: optional (string)

            UI metadata.

          Example:

          {
            "name": "1",
            "description": "Trigger description",
            "endpointIds": [
              "98ced78d-6875-8bd6-c064-8c65f9f40514",
              "65efe88c-6875-4aa6-a064-7a38f9c40519"
            ],
            "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
          }
          

          HTTP status code 204

          Trigger is successfully updated.

          HTTP status code 400

          Invalid request.

          Body

          Media type: application/json

          Type: object

          Properties

          • message: required(string)

            Detailed error description.

          HTTP status code 401

          Request is not authenticated.

          HTTP status code 404

          Resource not found or querying user is not authorized for it.

          Secured by oauth_2_0

          Headers

          • Authorization: optional (string)

            Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

          delete /trigger-types/endpoint-metadata-updated/triggers/{triggerId}

          Deletes trigger.

          Secured by oauth_2_0 with scopes:
          • endpoint-metadata-updated-trigger:delete

          RE supports OAuth 2.0 for authenticating all API requests.

          URI Parameters

          • triggerId: required(string)

            Trigger ID

          HTTP status code 204

          Trigger is successfully deleted.

          HTTP status code 401

          Request is not authenticated.

          HTTP status code 404

          Resource not found or querying user is not authorized for it.

          Secured by oauth_2_0

          Headers

          • Authorization: optional (string)

            Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

          /trigger-types/endpoint-time-series-updated/trigger post get

          post /trigger-types/endpoint-time-series-updated/trigger

          Creates a new trigger.

          Secured by oauth_2_0 with scopes:
          • tenant:endpoint-time-series-updated-trigger:create

          RE supports OAuth 2.0 for authenticating all API requests.

          Body

          Media type: application/json

          Type: object

          Properties

          • name: required(string)

            Trigger name.

          • description: optional (string)

            Trigger description.

          • appName: optional (string)

            Application name of the endpoint(s) that trigger will react on.

          • appVersionName: optional (string)

            Application version of the endpoint(s) that trigger will react on.

          • endpointIds: optional (array of )

            Endpoint IDs that trigger will react on.

          • metadata: optional (object)

            Additional trigger metadata.

            • uiMetadata: optional (string)

              UI metadata.

            • timeSeriesNames: required(array of )

              Time series names that trigger will react on.

            Example:

            {
              "name": "Trigger name",
              "description": "Trigger description",
              "endpointIds": [
                "98ced78d-6875-8bd6-c064-8c65f9f40514",
                "65efe88c-6875-4aa6-a064-7a38f9c40519"
              ],
              "timeSeriesNames": [
                "temperature",
                "humidity"
              ],
              "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
            }
            

            HTTP status code 201

            Trigger is successfully created.

            Headers

            • Location: required(string)

              URI in format {schema}://{host}/re/api/v1/trigger-types/endpoint-time-series-updated/triggers/{triggerId}

              Example:

              https://cloud.kaaiot.com/re/api/v1/trigger-types/endpoint-time-series-updated/triggers/25

            HTTP status code 400

            Invalid request.

            Body

            Media type: application/json

            Type: object

            Properties

            • message: required(string)

              Detailed error description.

            HTTP status code 401

            Request is not authenticated.

            HTTP status code 403

            Principal does not have sufficient permissions to perform this operation.

            Secured by oauth_2_0

            Headers

            • Authorization: optional (string)

              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

            get /trigger-types/endpoint-time-series-updated/trigger

            Returns trigger list.

            Secured by oauth_2_0 with scopes:
            • endpoint-endpoint-time-series-updated-trigger:read

            RE supports OAuth 2.0 for authenticating all API requests.

            Query Parameters

            • page: optional (number - default: 0)

              Page number.

              Example:

              0
            • size: optional (number - default: 100)

              Page size.

              Example:

              10

            HTTP status code 200

            Triggers are successfully retrieved.

            Body

            Media type: application/json

            Type: object

            Properties

            • totalElements: required(integer)

              Total number of elements available for retrieval.

            • content: required(array of TriggerResponse)

              Items: TriggerResponse

              • id: required(string)

                Trigger ID.

              • name: required(string)

                Trigger name.

              • description: optional (string)

                Trigger description.

              • appName: optional (string)

                Application name of the endpoint(s) that trigger will react on.

              • appVersionName: optional (string)

                Application version of the endpoint(s) that trigger will react on.

              • endpointIds: optional (array of )

                Endpoint IDs that trigger will react on.

              • metadata: optional (object)

                Additional trigger metadata.

                • uiMetadata: optional (string)

                  UI metadata.

              Example:

              {
                "content": [
                  {
                    "id": "1",
                    "name": "Trigger name",
                    "description": "Trigger description",
                    "endpointIds": [
                      "98ced78d-6875-8bd6-c064-8c65f9f40514",
                      "65efe88c-6875-4aa6-a064-7a38f9c40519"
                    ],
                    "metadata:": {
                      "timeSeriesName1": "temperature",
                      "timeSeriesName2": "humidity"
                    },
                    "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                  }
                ],
                "totalElements": 1
              }
              

              HTTP status code 401

              Request is not authenticated.

              Secured by oauth_2_0

              Headers

              • Authorization: optional (string)

                Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

              /trigger-types/endpoint-time-series-updated/trigger/{triggerId} get put delete

              get /trigger-types/endpoint-time-series-updated/trigger/{triggerId}

              Returns trigger by ID.

              Secured by oauth_2_0 with scopes:
              • endpoint-endpoint-time-series-updated-trigger:read

              RE supports OAuth 2.0 for authenticating all API requests.

              URI Parameters

              • triggerId: required(string)

                Trigger ID

              HTTP status code 200

              Trigger is successfully retrieved.

              Body

              Media type: application/json

              Type: object

              Properties

              • id: required(string)

                Trigger ID.

              • name: required(string)

                Trigger name.

              • description: optional (string)

                Trigger description.

              • appName: optional (string)

                Application name of the endpoint(s) that trigger will react on.

              • appVersionName: optional (string)

                Application version of the endpoint(s) that trigger will react on.

              • endpointIds: optional (array of )

                Endpoint IDs that trigger will react on.

              • metadata: optional (object)

                Additional trigger metadata.

                • uiMetadata: optional (string)

                  UI metadata.

                Example:

                {
                  "id": "1",
                  "name": "Trigger name",
                  "description": "Trigger description",
                  "endpointIds": [
                    "98ced78d-6875-8bd6-c064-8c65f9f40514",
                    "65efe88c-6875-4aa6-a064-7a38f9c40519"
                  ],
                  "metadata:": {
                    "timeSeriesName1": "temperature",
                    "timeSeriesName2": "humidity"
                  },
                  "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                }
                

                HTTP status code 400

                Invalid request.

                Body

                Media type: application/json

                Type: object

                Properties

                • message: required(string)

                  Detailed error description.

                HTTP status code 401

                Request is not authenticated.

                HTTP status code 404

                Resource not found or querying user is not authorized for it.

                Secured by oauth_2_0

                Headers

                • Authorization: optional (string)

                  Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                put /trigger-types/endpoint-time-series-updated/trigger/{triggerId}

                Updates a trigger.

                Secured by oauth_2_0 with scopes:
                • endpoint-endpoint-time-series-updated-trigger:update

                RE supports OAuth 2.0 for authenticating all API requests.

                URI Parameters

                • triggerId: required(string)

                  Trigger ID

                Body

                Media type: application/json

                Type: object

                Properties

                • name: required(string)

                  Trigger name.

                • description: optional (string)

                  Trigger description.

                • appName: optional (string)

                  Application name of the endpoint(s) that trigger will react on.

                • appVersionName: optional (string)

                  Application version of the endpoint(s) that trigger will react on.

                • endpointIds: optional (array of )

                  Endpoint IDs that trigger will react on.

                • metadata: optional (object)

                  Additional trigger metadata.

                  • uiMetadata: optional (string)

                    UI metadata.

                  • timeSeriesNames: required(array of )

                    Time series names that trigger will react on.

                  Example:

                  {
                    "name": "Trigger name",
                    "description": "Trigger description",
                    "endpointIds": [
                      "98ced78d-6875-8bd6-c064-8c65f9f40514",
                      "65efe88c-6875-4aa6-a064-7a38f9c40519"
                    ],
                    "timeSeriesNames": [
                      "temperature",
                      "humidity"
                    ],
                    "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                  }
                  

                  HTTP status code 204

                  Trigger is successfully updated.

                  HTTP status code 400

                  Invalid request.

                  Body

                  Media type: application/json

                  Type: object

                  Properties

                  • message: required(string)

                    Detailed error description.

                  HTTP status code 401

                  Request is not authenticated.

                  HTTP status code 404

                  Resource not found or querying user is not authorized for it.

                  Secured by oauth_2_0

                  Headers

                  • Authorization: optional (string)

                    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                  delete /trigger-types/endpoint-time-series-updated/trigger/{triggerId}

                  Deletes trigger.

                  Secured by oauth_2_0 with scopes:
                  • endpoint-endpoint-time-series-updated-trigger:delete

                  RE supports OAuth 2.0 for authenticating all API requests.

                  URI Parameters

                  • triggerId: required(string)

                    Trigger ID

                  HTTP status code 204

                  Trigger is successfully deleted.

                  HTTP status code 401

                  Request is not authenticated.

                  HTTP status code 404

                  Resource not found or querying user is not authorized for it.

                  Secured by oauth_2_0

                  Headers

                  • Authorization: optional (string)

                    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                  /trigger-types/endpoint-command-result-received/trigger post get

                  post /trigger-types/endpoint-command-result-received/trigger

                  Creates a new trigger.

                  Secured by oauth_2_0 with scopes:
                  • tenant:endpoint-command-result-received-trigger:create

                  RE supports OAuth 2.0 for authenticating all API requests.

                  Body

                  Media type: application/json

                  Type: object

                  Properties

                  • name: required(string)

                    Trigger name.

                  • description: optional (string)

                    Trigger description.

                  • appName: optional (string)

                    Application name of the endpoint(s) that trigger will react on.

                  • appVersionName: optional (string)

                    Application version of the endpoint(s) that trigger will react on.

                  • endpointIds: optional (array of )

                    Endpoint IDs that trigger will react on.

                  • metadata: optional (object)

                    Additional trigger metadata.

                    • uiMetadata: optional (string)

                      UI metadata.

                    • commandTypes: required(array of )

                      Command types that trigger will react on.

                    Example:

                    {
                      "name": "Trigger name",
                      "description": "Trigger description",
                      "endpointIds": [
                        "98ced78d-6875-8bd6-c064-8c65f9f40514",
                        "65efe88c-6875-4aa6-a064-7a38f9c40519"
                      ],
                      "commandTypes": [
                        "goto",
                        "reboot"
                      ],
                      "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                    }
                    

                    HTTP status code 201

                    Trigger is successfully created.

                    Headers

                    • Location: required(string)

                      URI in format {schema}://{host}/re/api/v1/trigger-types/endpoint-command-result-received/triggers/{triggerId}

                      Example:

                      https://cloud.kaaiot.com/re/api/v1/trigger-types/endpoint-command-result-received/triggers/25

                    HTTP status code 400

                    Invalid request.

                    Body

                    Media type: application/json

                    Type: object

                    Properties

                    • message: required(string)

                      Detailed error description.

                    HTTP status code 401

                    Request is not authenticated.

                    HTTP status code 403

                    Principal does not have sufficient permissions to perform this operation.

                    Secured by oauth_2_0

                    Headers

                    • Authorization: optional (string)

                      Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                    get /trigger-types/endpoint-command-result-received/trigger

                    Returns trigger list.

                    Secured by oauth_2_0 with scopes:
                    • endpoint-command-result-received-trigger:read

                    RE supports OAuth 2.0 for authenticating all API requests.

                    Query Parameters

                    • page: optional (number - default: 0)

                      Page number.

                      Example:

                      0
                    • size: optional (number - default: 100)

                      Page size.

                      Example:

                      10

                    HTTP status code 200

                    Triggers are successfully retrieved.

                    Body

                    Media type: application/json

                    Type: object

                    Properties

                    • totalElements: required(integer)

                      Total number of elements available for retrieval.

                    • content: required(array of TriggerResponse)

                      Items: TriggerResponse

                      • id: required(string)

                        Trigger ID.

                      • name: required(string)

                        Trigger name.

                      • description: optional (string)

                        Trigger description.

                      • appName: optional (string)

                        Application name of the endpoint(s) that trigger will react on.

                      • appVersionName: optional (string)

                        Application version of the endpoint(s) that trigger will react on.

                      • endpointIds: optional (array of )

                        Endpoint IDs that trigger will react on.

                      • metadata: optional (object)

                        Additional trigger metadata.

                        • uiMetadata: optional (string)

                          UI metadata.

                      Example:

                      {
                        "content": [
                          {
                            "id": "1",
                            "name": "Trigger name",
                            "description": "Trigger description",
                            "endpointIds": [
                              "98ced78d-6875-8bd6-c064-8c65f9f40514",
                              "65efe88c-6875-4aa6-a064-7a38f9c40519"
                            ],
                            "metadata:": {
                              "commandType1": "goto",
                              "commandType2": "reboot"
                            },
                            "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                          }
                        ],
                        "totalElements": 1
                      }
                      

                      HTTP status code 401

                      Request is not authenticated.

                      Secured by oauth_2_0

                      Headers

                      • Authorization: optional (string)

                        Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                      /trigger-types/endpoint-command-result-received/trigger/{triggerId} get put delete

                      get /trigger-types/endpoint-command-result-received/trigger/{triggerId}

                      Returns trigger by ID.

                      Secured by oauth_2_0 with scopes:
                      • endpoint-command-result-received-trigger:read

                      RE supports OAuth 2.0 for authenticating all API requests.

                      URI Parameters

                      • triggerId: required(string)

                        Trigger ID

                      HTTP status code 200

                      Trigger is successfully retrieved.

                      Body

                      Media type: application/json

                      Type: object

                      Properties

                      • id: required(string)

                        Trigger ID.

                      • name: required(string)

                        Trigger name.

                      • description: optional (string)

                        Trigger description.

                      • appName: optional (string)

                        Application name of the endpoint(s) that trigger will react on.

                      • appVersionName: optional (string)

                        Application version of the endpoint(s) that trigger will react on.

                      • endpointIds: optional (array of )

                        Endpoint IDs that trigger will react on.

                      • metadata: optional (object)

                        Additional trigger metadata.

                        • uiMetadata: optional (string)

                          UI metadata.

                        Example:

                        {
                          "id": "1",
                          "name": "Trigger name",
                          "description": "Trigger description",
                          "endpointIds": [
                            "98ced78d-6875-8bd6-c064-8c65f9f40514",
                            "65efe88c-6875-4aa6-a064-7a38f9c40519"
                          ],
                          "metadata:": {
                            "commandType1": "goto",
                            "commandType2": "reboot"
                          },
                          "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                        }
                        

                        HTTP status code 400

                        Invalid request.

                        Body

                        Media type: application/json

                        Type: object

                        Properties

                        • message: required(string)

                          Detailed error description.

                        HTTP status code 401

                        Request is not authenticated.

                        HTTP status code 404

                        Resource not found or querying user is not authorized for it.

                        Secured by oauth_2_0

                        Headers

                        • Authorization: optional (string)

                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                        put /trigger-types/endpoint-command-result-received/trigger/{triggerId}

                        Updates a trigger.

                        Secured by oauth_2_0 with scopes:
                        • endpoint-command-result-received-trigger:update

                        RE supports OAuth 2.0 for authenticating all API requests.

                        URI Parameters

                        • triggerId: required(string)

                          Trigger ID

                        Body

                        Media type: application/json

                        Type: object

                        Properties

                        • name: required(string)

                          Trigger name.

                        • description: optional (string)

                          Trigger description.

                        • appName: optional (string)

                          Application name of the endpoint(s) that trigger will react on.

                        • appVersionName: optional (string)

                          Application version of the endpoint(s) that trigger will react on.

                        • endpointIds: optional (array of )

                          Endpoint IDs that trigger will react on.

                        • metadata: optional (object)

                          Additional trigger metadata.

                          • uiMetadata: optional (string)

                            UI metadata.

                          • commandTypes: required(array of )

                            Command types that trigger will react on.

                          Example:

                          {
                            "name": "Trigger name",
                            "description": "Trigger description",
                            "endpointIds": [
                              "98ced78d-6875-8bd6-c064-8c65f9f40514",
                              "65efe88c-6875-4aa6-a064-7a38f9c40519"
                            ],
                            "commandTypes": [
                              "goto",
                              "reboot"
                            ],
                            "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                          }
                          

                          HTTP status code 204

                          Trigger is successfully updated.

                          HTTP status code 400

                          Invalid request.

                          Body

                          Media type: application/json

                          Type: object

                          Properties

                          • message: required(string)

                            Detailed error description.

                          HTTP status code 401

                          Request is not authenticated.

                          HTTP status code 404

                          Resource not found or querying user is not authorized for it.

                          Secured by oauth_2_0

                          Headers

                          • Authorization: optional (string)

                            Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                          delete /trigger-types/endpoint-command-result-received/trigger/{triggerId}

                          Deletes trigger.

                          Secured by oauth_2_0 with scopes:
                          • endpoint-command-result-received-trigger:delete

                          RE supports OAuth 2.0 for authenticating all API requests.

                          URI Parameters

                          • triggerId: required(string)

                            Trigger ID

                          HTTP status code 204

                          Trigger is successfully deleted.

                          HTTP status code 401

                          Request is not authenticated.

                          HTTP status code 404

                          Resource not found or querying user is not authorized for it.

                          Secured by oauth_2_0

                          Headers

                          • Authorization: optional (string)

                            Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                          /trigger-types/endpoint-data-samples-received/trigger post get

                          post /trigger-types/endpoint-data-samples-received/trigger

                          Creates a new trigger.

                          Secured by oauth_2_0 with scopes:
                          • tenant:endpoint-data-samples-received-trigger:create

                          RE supports OAuth 2.0 for authenticating all API requests.

                          Body

                          Media type: application/json

                          Type: object

                          Properties

                          • name: required(string)

                            Trigger name.

                          • description: optional (string)

                            Trigger description.

                          • appName: optional (string)

                            Application name of the endpoint(s) that trigger will react on.

                          • appVersionName: optional (string)

                            Application version of the endpoint(s) that trigger will react on.

                          • endpointIds: optional (array of )

                            Endpoint IDs that trigger will react on.

                          • metadata: optional (object)

                            Additional trigger metadata.

                            • uiMetadata: optional (string)

                              UI metadata.

                            Example:

                            {
                              "name": "1",
                              "description": "Trigger description",
                              "endpointIds": [
                                "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                "65efe88c-6875-4aa6-a064-7a38f9c40519"
                              ],
                              "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                            }
                            

                            HTTP status code 201

                            Trigger is successfully created.

                            Headers

                            • Location: required(string)

                              URI in format {schema}://{host}/re/api/v1/trigger-types/endpoint-data-samples-received/triggers/{triggerId}

                              Example:

                              https://cloud.kaaiot.com/re/api/v1/trigger-types/endpoint-data-samples-received/triggers/25

                            HTTP status code 400

                            Invalid request.

                            Body

                            Media type: application/json

                            Type: object

                            Properties

                            • message: required(string)

                              Detailed error description.

                            HTTP status code 401

                            Request is not authenticated.

                            HTTP status code 403

                            Principal does not have sufficient permissions to perform this operation.

                            Secured by oauth_2_0

                            Headers

                            • Authorization: optional (string)

                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                            get /trigger-types/endpoint-data-samples-received/trigger

                            Returns trigger list.

                            Secured by oauth_2_0 with scopes:
                            • endpoint-data-samples-received-trigger:read

                            RE supports OAuth 2.0 for authenticating all API requests.

                            Query Parameters

                            • page: optional (number - default: 0)

                              Page number.

                              Example:

                              0
                            • size: optional (number - default: 100)

                              Page size.

                              Example:

                              10

                            HTTP status code 200

                            Triggers are successfully retrieved.

                            Body

                            Media type: application/json

                            Type: object

                            Properties

                            • totalElements: required(integer)

                              Total number of elements available for retrieval.

                            • content: required(array of TriggerResponse)

                              Items: TriggerResponse

                              • id: required(string)

                                Trigger ID.

                              • name: required(string)

                                Trigger name.

                              • description: optional (string)

                                Trigger description.

                              • appName: optional (string)

                                Application name of the endpoint(s) that trigger will react on.

                              • appVersionName: optional (string)

                                Application version of the endpoint(s) that trigger will react on.

                              • endpointIds: optional (array of )

                                Endpoint IDs that trigger will react on.

                              • metadata: optional (object)

                                Additional trigger metadata.

                                • uiMetadata: optional (string)

                                  UI metadata.

                              Example:

                              {
                                "content": [
                                  {
                                    "id": "2",
                                    "name": "Trigger name",
                                    "description": "Trigger description",
                                    "endpointIds": [
                                      "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                      "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                    ],
                                    "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
                                    "createdAt": "2023-06-30T12:30:54.540Z",
                                    "updatedAt": "2023-06-30T12:30:54.541Z"
                                  }
                                ],
                                "totalElements": 1
                              }
                              

                              HTTP status code 401

                              Request is not authenticated.

                              Secured by oauth_2_0

                              Headers

                              • Authorization: optional (string)

                                Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                              /trigger-types/endpoint-data-samples-received/trigger/{triggerId} get put delete

                              get /trigger-types/endpoint-data-samples-received/trigger/{triggerId}

                              Returns trigger by ID.

                              Secured by oauth_2_0 with scopes:
                              • endpoint-data-samples-received-trigger:read

                              RE supports OAuth 2.0 for authenticating all API requests.

                              URI Parameters

                              • triggerId: required(string)

                                Trigger ID

                              HTTP status code 200

                              Trigger is successfully retrieved.

                              Body

                              Media type: application/json

                              Type: object

                              Properties

                              • id: required(string)

                                Trigger ID.

                              • name: required(string)

                                Trigger name.

                              • description: optional (string)

                                Trigger description.

                              • appName: optional (string)

                                Application name of the endpoint(s) that trigger will react on.

                              • appVersionName: optional (string)

                                Application version of the endpoint(s) that trigger will react on.

                              • endpointIds: optional (array of )

                                Endpoint IDs that trigger will react on.

                              • metadata: optional (object)

                                Additional trigger metadata.

                                • uiMetadata: optional (string)

                                  UI metadata.

                                Example:

                                {
                                  "id": "2",
                                  "name": "Trigger name",
                                  "description": "Trigger description",
                                  "endpointIds": [
                                    "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                    "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                  ],
                                  "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
                                  "createdAt": "2023-06-30T12:30:54.540Z",
                                  "updatedAt": "2023-06-30T12:30:54.541Z"
                                }
                                

                                HTTP status code 400

                                Invalid request.

                                Body

                                Media type: application/json

                                Type: object

                                Properties

                                • message: required(string)

                                  Detailed error description.

                                HTTP status code 401

                                Request is not authenticated.

                                HTTP status code 404

                                Resource not found or querying user is not authorized for it.

                                Secured by oauth_2_0

                                Headers

                                • Authorization: optional (string)

                                  Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                put /trigger-types/endpoint-data-samples-received/trigger/{triggerId}

                                Updates a trigger.

                                Secured by oauth_2_0 with scopes:
                                • endpoint-data-samples-received-trigger:update

                                RE supports OAuth 2.0 for authenticating all API requests.

                                URI Parameters

                                • triggerId: required(string)

                                  Trigger ID

                                Body

                                Media type: application/json

                                Type: object

                                Properties

                                • name: required(string)

                                  Trigger name.

                                • description: optional (string)

                                  Trigger description.

                                • appName: optional (string)

                                  Application name of the endpoint(s) that trigger will react on.

                                • appVersionName: optional (string)

                                  Application version of the endpoint(s) that trigger will react on.

                                • endpointIds: optional (array of )

                                  Endpoint IDs that trigger will react on.

                                • metadata: optional (object)

                                  Additional trigger metadata.

                                  • uiMetadata: optional (string)

                                    UI metadata.

                                  Example:

                                  {
                                    "name": "1",
                                    "description": "Trigger description",
                                    "endpointIds": [
                                      "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                      "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                    ],
                                    "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                  }
                                  

                                  HTTP status code 204

                                  Trigger is successfully updated.

                                  HTTP status code 400

                                  Invalid request.

                                  Body

                                  Media type: application/json

                                  Type: object

                                  Properties

                                  • message: required(string)

                                    Detailed error description.

                                  HTTP status code 401

                                  Request is not authenticated.

                                  HTTP status code 404

                                  Resource not found or querying user is not authorized for it.

                                  Secured by oauth_2_0

                                  Headers

                                  • Authorization: optional (string)

                                    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                  delete /trigger-types/endpoint-data-samples-received/trigger/{triggerId}

                                  Deletes trigger.

                                  Secured by oauth_2_0 with scopes:
                                  • endpoint-data-samples-received-trigger:delete

                                  RE supports OAuth 2.0 for authenticating all API requests.

                                  URI Parameters

                                  • triggerId: required(string)

                                    Trigger ID

                                  HTTP status code 204

                                  Trigger is successfully deleted.

                                  HTTP status code 401

                                  Request is not authenticated.

                                  HTTP status code 404

                                  Resource not found or querying user is not authorized for it.

                                  Secured by oauth_2_0

                                  Headers

                                  • Authorization: optional (string)

                                    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                  /trigger-types/alert-lifecycle-event/trigger post get

                                  post /trigger-types/alert-lifecycle-event/trigger

                                  Creates a new trigger.

                                  Secured by oauth_2_0 with scopes:
                                  • tenant:alert-lifecycle-event-trigger:create

                                  RE supports OAuth 2.0 for authenticating all API requests.

                                  Body

                                  Media type: application/json

                                  Type: object

                                  Properties

                                  • metadata: required(object)

                                    Additional trigger metadata.

                                    • alertLifecycleEventType: required(one of SEVERITY_LEVEL_INCREASED, SEVERITY_LEVEL_DECREASED, CREATED, ACTIVE, RESOLVED, ACKNOWLEDGED, UNACKNOWLEDGED)

                                      List of comma separated types of alert lifecycle events to activate trigger on.

                                  • name: required(string)

                                    Trigger name.

                                  • description: optional (string)

                                    Trigger description.

                                  • appName: optional (string)

                                    Application name of the endpoint(s) that trigger will react on.

                                  • appVersionName: optional (string)

                                    Application version of the endpoint(s) that trigger will react on.

                                  • endpointIds: optional (array of )

                                    Endpoint IDs that trigger will react on.

                                  • uiMetadata: optional (string)

                                    UI metadata.

                                  Example:

                                  {
                                    "name": "1",
                                    "description": "Trigger description",
                                    "endpointIds": [
                                      "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                      "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                    ],
                                    "metadata:": {
                                      "alertLifecycleEventType": "SEVERITY_LEVEL_INCREASED,RESOLVED"
                                    },
                                    "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                  }
                                  

                                  HTTP status code 201

                                  Trigger is successfully created.

                                  Headers

                                  • Location: required(string)

                                    URI in format {schema}://{host}/re/api/v1/trigger-types/alert-lifecycle-event/triggers/{triggerId}

                                    Example:

                                    https://cloud.kaaiot.com/re/api/v1/trigger-types/alert-lifecycle-event/triggers/25

                                  HTTP status code 400

                                  Invalid request.

                                  Body

                                  Media type: application/json

                                  Type: object

                                  Properties

                                  • message: required(string)

                                    Detailed error description.

                                  HTTP status code 401

                                  Request is not authenticated.

                                  HTTP status code 403

                                  Principal does not have sufficient permissions to perform this operation.

                                  Secured by oauth_2_0

                                  Headers

                                  • Authorization: optional (string)

                                    Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                  get /trigger-types/alert-lifecycle-event/trigger

                                  Returns trigger list.

                                  Secured by oauth_2_0 with scopes:
                                  • alert-lifecycle-event-trigger:read

                                  RE supports OAuth 2.0 for authenticating all API requests.

                                  Query Parameters

                                  • page: optional (number - default: 0)

                                    Page number.

                                    Example:

                                    0
                                  • size: optional (number - default: 100)

                                    Page size.

                                    Example:

                                    10

                                  HTTP status code 200

                                  Triggers are successfully retrieved.

                                  Body

                                  Media type: application/json

                                  Type: object

                                  Properties

                                  • totalElements: required(integer)

                                    Total number of elements available for retrieval.

                                  • content: required(array of TriggerResponse)

                                    Items: TriggerResponse

                                    • id: required(string)

                                      Trigger ID.

                                    • name: required(string)

                                      Trigger name.

                                    • description: optional (string)

                                      Trigger description.

                                    • appName: optional (string)

                                      Application name of the endpoint(s) that trigger will react on.

                                    • appVersionName: optional (string)

                                      Application version of the endpoint(s) that trigger will react on.

                                    • endpointIds: optional (array of )

                                      Endpoint IDs that trigger will react on.

                                    • metadata: optional (object)

                                      Additional trigger metadata.

                                      • uiMetadata: optional (string)

                                        UI metadata.

                                    Example:

                                    {
                                      "content": [
                                        {
                                          "id": "1",
                                          "name": "'endpoint time series updated' trigger",
                                          "description": "'endpoint time series updated' trigger that reacts to events on endpoints",
                                          "endpointIds": [
                                            "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                            "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                          ],
                                          "metadata:": {
                                            "alertLifecycleEventType": "SEVERITY_LEVEL_INCREASED,RESOLVED"
                                          },
                                          "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                        }
                                      ],
                                      "totalElements": 1
                                    }
                                    

                                    HTTP status code 401

                                    Request is not authenticated.

                                    Secured by oauth_2_0

                                    Headers

                                    • Authorization: optional (string)

                                      Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                    /trigger-types/alert-lifecycle-event/trigger/{triggerId} get put delete

                                    get /trigger-types/alert-lifecycle-event/trigger/{triggerId}

                                    Returns trigger by ID.

                                    Secured by oauth_2_0 with scopes:
                                    • alert-lifecycle-event-trigger:read

                                    RE supports OAuth 2.0 for authenticating all API requests.

                                    URI Parameters

                                    • triggerId: required(string)

                                      Trigger ID

                                    HTTP status code 200

                                    Trigger is successfully retrieved.

                                    Body

                                    Media type: application/json

                                    Type: object

                                    Properties

                                    • id: required(string)

                                      Trigger ID.

                                    • name: required(string)

                                      Trigger name.

                                    • description: optional (string)

                                      Trigger description.

                                    • appName: optional (string)

                                      Application name of the endpoint(s) that trigger will react on.

                                    • appVersionName: optional (string)

                                      Application version of the endpoint(s) that trigger will react on.

                                    • endpointIds: optional (array of )

                                      Endpoint IDs that trigger will react on.

                                    • metadata: optional (object)

                                      Additional trigger metadata.

                                      • uiMetadata: optional (string)

                                        UI metadata.

                                      Example:

                                      {
                                        "id": "1",
                                        "name": "'endpoint time series updated' trigger",
                                        "description": "'endpoint time series updated' trigger that reacts to events on endpoints",
                                        "endpointIds": [
                                          "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                          "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                        ],
                                        "metadata:": {
                                          "alertLifecycleEventType": "SEVERITY_LEVEL_INCREASED,RESOLVED"
                                        },
                                        "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                      }
                                      

                                      HTTP status code 400

                                      Invalid request.

                                      Body

                                      Media type: application/json

                                      Type: object

                                      Properties

                                      • message: required(string)

                                        Detailed error description.

                                      HTTP status code 401

                                      Request is not authenticated.

                                      HTTP status code 404

                                      Resource not found or querying user is not authorized for it.

                                      Secured by oauth_2_0

                                      Headers

                                      • Authorization: optional (string)

                                        Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                      put /trigger-types/alert-lifecycle-event/trigger/{triggerId}

                                      Updates a trigger.

                                      Secured by oauth_2_0 with scopes:
                                      • alert-lifecycle-event-trigger:update

                                      RE supports OAuth 2.0 for authenticating all API requests.

                                      URI Parameters

                                      • triggerId: required(string)

                                        Trigger ID

                                      Body

                                      Media type: application/json

                                      Type: object

                                      Properties

                                      • name: required(string)

                                        Trigger name.

                                      • description: optional (string)

                                        Trigger description.

                                      • appName: optional (string)

                                        Application name of the endpoint(s) that trigger will react on.

                                      • appVersionName: optional (string)

                                        Application version of the endpoint(s) that trigger will react on.

                                      • endpointIds: optional (array of )

                                        Endpoint IDs that trigger will react on.

                                      • metadata: optional (object)

                                        Additional trigger metadata.

                                        • uiMetadata: optional (string)

                                          UI metadata.

                                        Example:

                                        {
                                          "name": "1",
                                          "description": "Trigger description",
                                          "endpointIds": [
                                            "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                            "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                          ],
                                          "metadata:": {
                                            "alertLifecycleEventType": "SEVERITY_LEVEL_INCREASED,RESOLVED"
                                          },
                                          "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                        }
                                        

                                        HTTP status code 204

                                        Trigger is successfully updated.

                                        HTTP status code 400

                                        Invalid request.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • message: required(string)

                                          Detailed error description.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 404

                                        Resource not found or querying user is not authorized for it.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        delete /trigger-types/alert-lifecycle-event/trigger/{triggerId}

                                        Deletes trigger.

                                        Secured by oauth_2_0 with scopes:
                                        • alert-lifecycle-event-trigger:delete

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        URI Parameters

                                        • triggerId: required(string)

                                          Trigger ID

                                        HTTP status code 204

                                        Trigger is successfully deleted.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 404

                                        Resource not found or querying user is not authorized for it.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        /trigger-types/cron/triggers post get

                                        post /trigger-types/cron/triggers

                                        Creates a new trigger.

                                        Secured by oauth_2_0 with scopes:
                                        • tenant:cron-trigger:create

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • name: required(string)

                                          Trigger name.

                                        • description: optional (string)

                                          Trigger description.

                                        • cron: required(string)

                                          Cron expression.

                                        • appName: optional (string)

                                          Application name of the endpoint(s) that trigger will react on.

                                        • appVersionName: optional (string)

                                          Application version of the endpoint(s) that trigger will react on.

                                        • endpointIds: optional (array of )

                                          Endpoint IDs that trigger will react on.

                                        • uiMetadata: optional (string)

                                          UI metadata.

                                        Example:

                                        {
                                          "name": "Trigger name",
                                          "description": "Trigger description",
                                          "cron": "0 */10 * * * ?",
                                          "endpointIds": [
                                            "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                            "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                          ],
                                          "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                        }
                                        

                                        HTTP status code 201

                                        Trigger is successfully created.

                                        Headers

                                        • Location: required(string)

                                          URI in format {schema}://{host}/re/api/v1/trigger-types/cron/triggers/{triggerId}

                                          Example:

                                          https://cloud.kaaiot.com/re/api/v1/trigger-types/cron/triggers/25

                                        HTTP status code 400

                                        Invalid request.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • message: required(string)

                                          Detailed error description.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 403

                                        Principal does not have sufficient permissions to perform this operation.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        get /trigger-types/cron/triggers

                                        Returns trigger list.

                                        Secured by oauth_2_0 with scopes:
                                        • cron-trigger:read

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        Query Parameters

                                        • page: optional (number - default: 0)

                                          Page number.

                                          Example:

                                          0
                                        • size: optional (number - default: 100)

                                          Page size.

                                          Example:

                                          10
                                        • name: optional (string)

                                          Name. Supports partial match.

                                          Example:

                                          myName
                                        • description: optional (string)

                                          Description. Supports partial match.

                                          Example:

                                          myDescription
                                        • sort: optional (one of createdAt, updatedAt - default: createdAt)

                                          Field to sort by.

                                          Example:

                                          updatedAt
                                        • sortOrder: optional (one of asc, desc - default: desc)

                                          Sort direction.

                                          Example:

                                          asc

                                        HTTP status code 200

                                        Triggers are successfully retrieved.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • totalElements: required(integer)

                                          Total number of elements available for retrieval.

                                        • content: required(array of TriggerResponse)

                                          Items: TriggerResponse

                                          • id: required(string)

                                            Trigger ID.

                                          • name: required(string)

                                            Trigger name.

                                          • description: optional (string)

                                            Trigger description.

                                          • cron: required(string)

                                            Cron expression.

                                          • appName: optional (string)

                                            Application name of the endpoint(s) that trigger will react on.

                                          • appVersionName: optional (string)

                                            Application version of the endpoint(s) that trigger will react on.

                                          • endpointIds: optional (array of )

                                            Endpoint IDs that trigger will react on.

                                          • uiMetadata: optional (string)

                                            UI metadata.

                                        Example:

                                        {
                                          "content": [
                                            {
                                              "id": "1",
                                              "name": "Trigger name",
                                              "description": "Trigger description",
                                              "cron": "0 */10 * * * ?",
                                              "endpointIds": [
                                                "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                                "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                              ],
                                              "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
                                              "createdAt": "2023-06-30T12:30:54.540Z",
                                              "updatedAt": "2023-06-30T12:30:54.541Z"
                                            }
                                          ],
                                          "totalElements": 1
                                        }
                                        

                                        HTTP status code 401

                                        Request is not authenticated.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        /trigger-types/cron/triggers/{triggerId} get put delete

                                        get /trigger-types/cron/triggers/{triggerId}

                                        Returns trigger by ID.

                                        Secured by oauth_2_0 with scopes:
                                        • cron-trigger:read

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        URI Parameters

                                        • triggerId: required(string)

                                          Trigger ID

                                        HTTP status code 200

                                        Trigger is successfully retrieved.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • id: required(string)

                                          Trigger ID.

                                        • name: required(string)

                                          Trigger name.

                                        • description: optional (string)

                                          Trigger description.

                                        • cron: required(string)

                                          Cron expression.

                                        • appName: optional (string)

                                          Application name of the endpoint(s) that trigger will react on.

                                        • appVersionName: optional (string)

                                          Application version of the endpoint(s) that trigger will react on.

                                        • endpointIds: optional (array of )

                                          Endpoint IDs that trigger will react on.

                                        • uiMetadata: optional (string)

                                          UI metadata.

                                        Example:

                                        {
                                          "id": "1",
                                          "name": "Trigger name",
                                          "description": "Trigger description",
                                          "cron": "0 */10 * * * ?",
                                          "endpointIds": [
                                            "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                            "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                          ],
                                          "uiMetadata": "{\"severity\" : \"CRITICAL\"}",
                                          "createdAt": "2023-06-30T12:30:54.540Z",
                                          "updatedAt": "2023-06-30T12:30:54.541Z"
                                        }
                                        

                                        HTTP status code 400

                                        Invalid request.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • message: required(string)

                                          Detailed error description.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 404

                                        Resource not found or querying user is not authorized for it.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        put /trigger-types/cron/triggers/{triggerId}

                                        Updates a trigger.

                                        Secured by oauth_2_0 with scopes:
                                        • cron-trigger:update

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        URI Parameters

                                        • triggerId: required(string)

                                          Trigger ID

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • name: required(string)

                                          Trigger name.

                                        • description: optional (string)

                                          Trigger description.

                                        • cron: required(string)

                                          Cron expression.

                                        • appName: optional (string)

                                          Application name of the endpoint(s) that trigger will react on.

                                        • appVersionName: optional (string)

                                          Application version of the endpoint(s) that trigger will react on.

                                        • endpointIds: optional (array of )

                                          Endpoint IDs that trigger will react on.

                                        • uiMetadata: optional (string)

                                          UI metadata.

                                        Example:

                                        {
                                          "name": "Trigger name",
                                          "description": "Trigger description",
                                          "cron": "0 */10 * * * ?",
                                          "endpointIds": [
                                            "98ced78d-6875-8bd6-c064-8c65f9f40514",
                                            "65efe88c-6875-4aa6-a064-7a38f9c40519"
                                          ],
                                          "uiMetadata": "{\"severity\" : \"CRITICAL\"}"
                                        }
                                        

                                        HTTP status code 204

                                        Trigger is successfully updated.

                                        HTTP status code 400

                                        Invalid request.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • message: required(string)

                                          Detailed error description.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 404

                                        Resource not found or querying user is not authorized for it.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        delete /trigger-types/cron/triggers/{triggerId}

                                        Deletes trigger.

                                        Secured by oauth_2_0 with scopes:
                                        • cron-trigger:delete

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        URI Parameters

                                        • triggerId: required(string)

                                          Trigger ID

                                        HTTP status code 204

                                        Trigger is successfully deleted.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 404

                                        Resource not found or querying user is not authorized for it.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        Alerts

                                        Operations on alerts.

                                        /alerts get

                                        get /alerts

                                        Retrieves alerts.

                                        Secured by oauth_2_0 with scopes:
                                        • endpoint:read

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        Query Parameters

                                        • entityType: required(ENDPOINT)

                                          Entity type.

                                          Example:

                                          ENDPOINT
                                        • entityIds: optional (string)

                                          Entity ids.

                                          Example:

                                          c0e92a30-5958-4dc2-b275-b383efafa87d
                                        • alertSettingId: optional (string)

                                          Alert setting id.

                                          Example:

                                          75b05695-27ca-46eb-9481-69c199088d99
                                        • alertType: optional (string)

                                          Alert type.

                                          Example:

                                          HIGH_TEMPERATURE
                                        • state: optional (one of ACTIVE, RESOLVED)

                                          Alert state.

                                          Example:

                                          ACTIVE
                                        • acknowledgement: optional (one of UNACKNOWLEDGED, ACKNOWLEDGED)

                                          Alert acknowledgement.

                                          Example:

                                          UNACKNOWLEDGED
                                        • severityLevel: optional (one of INFO, LOW, MEDIUM, HIGH, CRITICAL)

                                          Alert severity level.

                                          Example:

                                          CRITICAL
                                        • entityMetadataPath: optional (string)

                                          Entity metadata path.

                                          Example:

                                          location.city
                                        • entityMetadataValue: optional (string)

                                          Entity metadata value.

                                          Example:

                                          Kyiv
                                        • sort: optional (startedAt - default: startedAt)

                                          Field to sort by.

                                          Example:

                                          startedAt
                                        • sortOrder: optional (one of asc, desc - default: desc)

                                          Sort direction.

                                          Example:

                                          asc
                                        • page: optional (number - default: 0)

                                          Page number.

                                          Example:

                                          0
                                        • size: optional (number - default: 100)

                                          Page size.

                                          Example:

                                          10

                                        HTTP status code 200

                                        Alerts are successfully retrieved.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • totalElements: required(integer)

                                          Total number of elements available for retrieval.

                                        • content: required(array of AlertResponse)

                                          Items: AlertResponse

                                          • id: required(string)

                                            Alert ID.

                                          • alertType: required(string - pattern: ^[a-zA-Z0-9_]{3,50}+$)

                                            Alert type.

                                          • acknowledgement: required(one of UNACKNOWLEDGED, ACKNOWLEDGED)

                                            Alert acknowledgement.

                                          • severityLevel: required(one of INFO, LOW, MEDIUM, HIGH, CRITICAL)

                                            Alert severity level.

                                          • state: required(one of ACTIVE, RESOLVED)

                                            Alert state.

                                          • entityType: required(ENDPOINT)

                                            Type of an entity that alert relates to.

                                          • entityId: required(string)

                                            Entity id that alert relates to.

                                          • activateReason: required(string)

                                            Alert activation reason.

                                          • resolveReason: optional (string)

                                            Alert resolution reason.

                                          • entityMetadata: optional (string)

                                            Entity metadata in the moment when it was last time active.

                                          • startedAt: required(datetime)

                                            Timestamp in ISO 8601 format (UTC timezone) showing when the alert started.

                                            Example:

                                            2023-06-30T12:30:54.540Z
                                          • lastActiveAt: required(datetime)

                                            Timestamp in ISO 8601 format (UTC timezone) showing when the alert was last active.

                                            Example:

                                            2023-06-30T12:30:54.540Z

                                        Example:

                                        {
                                          "content": [
                                            {
                                              "id": "0148290c-e8e7-4050-b4c4-5628becb286e",
                                              "alertType": "HIGH_TEMPERATURE",
                                              "acknowledgement": "UNACKNOWLEDGED",
                                              "state": "ACTIVE",
                                              "severityLevel": "LOW",
                                              "entityType": "ENDPOINT",
                                              "entityId": "c0e92a30-5958-4dc2-b275-b383efafa87d",
                                              "activateReason": "High temperature!",
                                              "resolveReason": null,
                                              "entityMetadata": "{\"floor\":1}",
                                              "startedAt": "2023-10-03T08:28:10.166Z",
                                              "lastActiveAt": "2023-10-03T08:28:10.166Z"
                                            }
                                          ],
                                          "totalElements": 1
                                        }
                                        

                                        HTTP status code 401

                                        Request is not authenticated.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        /alerts/{alertId}/acknowledgement put

                                        put /alerts/{alertId}/acknowledgement

                                        Acknowledges alert.

                                        Secured by oauth_2_0 with scopes:
                                        • endpoint:update

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        URI Parameters

                                        • alertId: required(string)

                                          Alert ID

                                        Query Parameters

                                        • entityId: required(string)

                                          Entity ID.

                                        • entityType: required(string)

                                          Entity type.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • status: required(one of UNACKNOWLEDGED, ACKNOWLEDGED)

                                          Alert status.

                                        • transitionReason: optional (string)

                                          Alert transition reason.

                                        Example:

                                        {
                                          "status": "ACKNOWLEDGED",
                                          "transitionReason": "Alert acknowledged"
                                        }

                                        HTTP status code 204

                                        Alert is successfully transitioned.

                                        HTTP status code 400

                                        Invalid request.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • message: required(string)

                                          Detailed error description.

                                        HTTP status code 401

                                        Request is not authenticated.

                                        HTTP status code 404

                                        Resource not found or querying user is not authorized for it.

                                        Secured by oauth_2_0

                                        Headers

                                        • Authorization: optional (string)

                                          Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                        /alerts/{alertId}/lifecycle-events get

                                        get /alerts/{alertId}/lifecycle-events

                                        Retrieves alert lifecycle events.

                                        Secured by oauth_2_0 with scopes:
                                        • endpoint:read

                                        RE supports OAuth 2.0 for authenticating all API requests.

                                        URI Parameters

                                        • alertId: required(string)

                                          Alert ID

                                        Query Parameters

                                        • entityId: required(string)

                                          Entity ID.

                                        • entityType: required(string)

                                          Entity type.

                                        • eventType: optional (one of SEVERITY_LEVEL_INCREASED, SEVERITY_LEVEL_DECREASED, CREATED, ACTIVE, RESOLVED, ACKNOWLEDGEMENT_TRANSITIONED)

                                          Event type.

                                          Example:

                                          SEVERITY_LEVEL_INCREASED
                                        • sort: optional (timestamp - default: timestamp)

                                          Field to sort by.

                                          Example:

                                          timestamp
                                        • sortOrder: optional (one of asc, desc - default: desc)

                                          Sort direction.

                                          Example:

                                          asc
                                        • page: optional (number - default: 0)

                                          Page number.

                                          Example:

                                          0
                                        • size: optional (number - default: 100)

                                          Page size.

                                          Example:

                                          10

                                        HTTP status code 200

                                        Alerts status transition history is successfully retrieved.

                                        Body

                                        Media type: application/json

                                        Type: object

                                        Properties

                                        • id: required(string)

                                          Event ID.

                                        • alertId: required(string)

                                          Alert ID.

                                        • eventType: required(one of SEVERITY_LEVEL_INCREASED, SEVERITY_LEVEL_DECREASED, CREATED, ACTIVE, RESOLVED, ACKNOWLEDGED, UNACKNOWLEDGED)

                                          Event type.

                                        • metadata: optional (object)

                                          Additional metadata.

                                          • timestamp: required(datetime)

                                            Timestamp in ISO 8601 format (UTC timezone) showing when the lifecycle event happened.

                                            Example:

                                            2023-06-30T12:30:54.540Z

                                          Example:

                                          {
                                            "content": [
                                              {
                                                "id": "4c96f636-8b0d-4c7a-a995-33cc91659df7",
                                                "alertId": "0148290c-e8e7-4050-b4c4-5628becb286e",
                                                "eventType": "SEVERITY_LEVEL_INCREASED",
                                                "timestamp": "2023-10-08T03:38:29.248Z",
                                                "metadata": {
                                                  "from": "HIGH",
                                                  "to": "CRITICAL"
                                                }
                                              }
                                            ],
                                            "totalElements": 1
                                          }
                                          

                                          HTTP status code 401

                                          Request is not authenticated.

                                          Secured by oauth_2_0

                                          Headers

                                          • Authorization: optional (string)

                                            Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                          /alerts/{alertId}/types get

                                          get /alerts/{alertId}/types

                                          Retrieves all alert types.

                                          Secured by oauth_2_0 with scopes:
                                          • tenant:alert-type:read

                                          RE supports OAuth 2.0 for authenticating all API requests.

                                          URI Parameters

                                          • alertId: required(string)

                                            Alert ID

                                          Query Parameters

                                          • entityType: required(string)

                                            Entity type.

                                          HTTP status code 200

                                          Alert types are successfully retrieved.

                                          Body

                                          Media type: application/json

                                          Type: array of string

                                          Example:

                                          [
                                            "overheat",
                                            "overload",
                                            "no_connection",
                                            "failure"
                                          ]

                                          HTTP status code 401

                                          Request is not authenticated.

                                          Secured by oauth_2_0

                                          Headers

                                          • Authorization: optional (string)

                                            Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                          Traces

                                          Operations on traces.

                                          /traces get delete

                                          get /traces

                                          Returns traces.

                                          Secured by oauth_2_0 with scopes:
                                          • tenant:rule-execution:trace:read

                                          RE supports OAuth 2.0 for authenticating all API requests.

                                          Query Parameters

                                          • traceId: optional (string)

                                            Trace ID.

                                          • entityType: optional (one of RULE, COMMAND_INVOCATION_ACTION, DATA_SAMPLE_ACTION, METADATA_UPDATE_ACTION, RULE_EXECUTION_ACTION, WEBHOOK_ACTION)

                                            Entity type.

                                          • entityId: optional (string)

                                            Entity ID.

                                          • outcome: optional (one of FAILURE, SUCCESS)

                                            Execution outcome.

                                          • fromCreatedAt: optional (datetime)

                                            Timestamp in ISO 8601 format (UTC timezone) to filter traces by creation time.

                                            Example:

                                            2023-06-30T12:30:54.540Z
                                          • toCreatedAt: optional (datetime)

                                            Timestamp in ISO 8601 format (UTC timezone) to filter traces by creation time.

                                            Example:

                                            2023-06-30T12:35:54.540Z
                                          • page: optional (number - default: 0)

                                            Page number.

                                            Example:

                                            0
                                          • size: optional (number - default: 100)

                                            Page size.

                                            Example:

                                            10

                                          HTTP status code 200

                                          Traces are successfully retrieved.

                                          Body

                                          Media type: application/json

                                          Type: object

                                          Properties

                                          • totalElements: required(integer)

                                            Total number of elements available for retrieval.

                                          • content: required(array of TraceResponse)

                                            Items: TraceResponse

                                            • id: required(string)

                                              Trace record ID. Unique for each trace record.

                                            • traceId: required(string)

                                              Trace ID. Common for the whole rule execution chain including attached to this rule actions and rule itself.

                                            • entityType: required(one of RULE, COMMAND_INVOCATION_ACTION, DATA_SAMPLE_ACTION, METADATA_UPDATE_ACTION, RULE_EXECUTION_ACTION, WEBHOOK_ACTION, RULE_ACTION, TIME_SERIES_ACTION)

                                              Entity type that produced the trace.

                                            • entityId: required(string)

                                              Entity ID that produced the trace.

                                            • outcome: required(one of FAILURE, SUCCESS)

                                              Execution outcome.

                                            • stage: optional (string)

                                              Stage on which trace was taken in case outcome equal to FAILURE.

                                            • reason: optional (string)

                                              Outcome reason.

                                            • metadata: optional (object)

                                              Additional metadata.

                                            Example:

                                            {
                                              "content": [
                                                {
                                                  "id": "aa54a074-6c87-46cf-a4a1-fbec44dd4ac8",
                                                  "traceId": "da7c72c6-d914-4ab8-ac45-e7f6fb6a2c15",
                                                  "entityType": "COMMAND_INVOCATION_ACTION",
                                                  "entityId": "74",
                                                  "outcome": "FAILURE",
                                                  "stage": "ENDPOINT_ID_EXPRESSION_EVALUATION",
                                                  "reason": "TypeError: Cannot read property 'getChildren' of undefined",
                                                  "metadata": {
                                                    "endpointIdExpression": "return ctx.endpoin.getChildren().length"
                                                  }
                                                },
                                                {
                                                  "id": "ea279e04-3f0d-49f5-a3c5-fc46acfbd675",
                                                  "traceId": "da7c72c6-d914-4ab8-ac45-e7f6fb6a2c15",
                                                  "entityType": "DATA_SAMPLE_ACTION",
                                                  "entityId": "91",
                                                  "outcome": "SUCCESS"
                                                }
                                              ],
                                              "totalElements": 2
                                            }
                                            

                                            HTTP status code 401

                                            Request is not authenticated.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            delete /traces

                                            Deletes traces.

                                            Secured by oauth_2_0 with scopes:
                                            • tenant:rule-execution:trace:delete

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            Query Parameters

                                            • beforeDate: optional (datetime)

                                              Date and time in ISO format to delete traces before. If not provided, all traces are deleted.

                                              Example:

                                              2023-06-30T12:30:54.540Z

                                            HTTP status code 204

                                            Traces are successfully deleted.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 403

                                            Principal does not have sufficient permissions to perform this operation.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            Alert settings

                                            Operations on alert settings.

                                            /alert-settings post get

                                            post /alert-settings

                                            Creates a new alert setting.

                                            Secured by oauth_2_0 with scopes:
                                            • rule:update

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • name: required(string)

                                              Name.

                                            • description: optional (string)

                                              Description.

                                            • state: required(one of ENABLED, DISABLED)

                                              State.

                                            • uiMetadata: optional (string)

                                              UI metadata.

                                            • ruleIds: required(array of )

                                              Rule IDs.

                                            • actions: required(array of AttachedAction)

                                              Attached actions.

                                              Items: AttachedAction

                                              • actionId: required(string)

                                                Action ID.

                                              • actionType: required(one of COMMAND_INVOCATION, METADATA_UPDATE, WEBHOOK, RULE_EXECUTION, DATA_SAMPLE, TIME_SERIES, ALERT_ACTIVATION, ALERT_RESOLUTION, SEND_EMAIL)

                                                Action type.

                                            • triggers: required(array of AttachedTrigger)

                                              Attached triggers.

                                              Items: AttachedTrigger

                                              • triggerId: required(string)

                                                Trigger ID.

                                              • triggerType: required(one of ENDPOINT_METADATA_UPDATED, ENDPOINT_TIME_SERIES_UPDATED, ENDPOINT_DATA_SAMPLES_RECEIVED, ALERT_LIFECYCLE_EVENT, CRON, RULE_EXECUTION_ACTION)

                                                Trigger type.

                                            Example:

                                            {
                                              "name": "High temperature alert setting",
                                              "description": "Alert setting for high temperature",
                                              "ruleIds": [
                                                "96fafee4-3238-44ab-93c0-28969d44abf6"
                                              ],
                                              "actions": [
                                                {
                                                  "actionId": "22",
                                                  "actionType": "COMMAND_INVOCATION"
                                                }
                                              ],
                                              "triggers": [
                                                {
                                                  "triggerId": "27",
                                                  "triggerType": "ENDPOINT_METADATA_UPDATED"
                                                }
                                              ]
                                            }

                                            HTTP status code 201

                                            Alert setting is successfully created.

                                            Headers

                                            • Location: required(string)

                                              URI in format {schema}://{host}/re/api/v1/alert-settings/{alertSettingId}

                                              Example:

                                              https://cloud.kaaiot.com/re/api/v1/alert-settings/024c1cec-edde-4f29-a0f7-4e86aabd43b0

                                            HTTP status code 400

                                            Invalid request.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • message: required(string)

                                              Detailed error description.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 403

                                            Principal does not have sufficient permissions to perform this operation.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            get /alert-settings

                                            Returns alert setting list.

                                            Secured by oauth_2_0 with scopes:
                                            • rule:read

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            Query Parameters

                                            • page: optional (number - default: 0)

                                              Page number.

                                              Example:

                                              0
                                            • size: optional (number - default: 100)

                                              Page size.

                                              Example:

                                              10
                                            • name: optional (string)

                                              Name. Supports partial match.

                                              Example:

                                              myName
                                            • description: optional (string)

                                              Description. Supports partial match.

                                              Example:

                                              myDescription
                                            • sort: optional (one of createdAt, updatedAt - default: createdAt)

                                              Field to sort by.

                                              Example:

                                              updatedAt
                                            • sortOrder: optional (one of asc, desc - default: desc)

                                              Sort direction.

                                              Example:

                                              asc

                                            HTTP status code 200

                                            Alert settings are successfully retrieved.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • totalElements: required(integer)

                                              Total number of elements available for retrieval.

                                            • content: required(array of AlertSettingResponse)

                                              Items: AlertSettingResponse

                                              • id: required(string)

                                                ID.

                                              • name: required(string)

                                                Name.

                                              • description: optional (string)

                                                Description.

                                              • state: required(one of ENABLED, DISABLED)

                                                State.

                                              • uiMetadata: optional (string)

                                                UI metadata.

                                              • ruleIds: required(array of )

                                                Rule IDs.

                                              • actions: required(array of AttachedAction)

                                                Attached actions.

                                                Items: AttachedAction

                                                • actionId: required(string)

                                                  Action ID.

                                                • actionType: required(one of COMMAND_INVOCATION, METADATA_UPDATE, WEBHOOK, RULE_EXECUTION, DATA_SAMPLE, TIME_SERIES, ALERT_ACTIVATION, ALERT_RESOLUTION, SEND_EMAIL)

                                                  Action type.

                                              • triggers: required(array of AttachedTrigger)

                                                Attached triggers.

                                                Items: AttachedTrigger

                                                • triggerId: required(string)

                                                  Trigger ID.

                                                • triggerType: required(one of ENDPOINT_METADATA_UPDATED, ENDPOINT_TIME_SERIES_UPDATED, ENDPOINT_DATA_SAMPLES_RECEIVED, ALERT_LIFECYCLE_EVENT, CRON, RULE_EXECUTION_ACTION)

                                                  Trigger type.

                                              • createdAt: required(datetime)

                                                Timestamp in ISO 8601 format (UTC timezone) showing when the record was created.

                                                Example:

                                                2023-06-30T12:30:54.540Z
                                              • updatedAt: required(datetime)

                                                Timestamp in ISO 8601 format (UTC timezone) showing when the record was last updated.

                                                Example:

                                                2023-06-30T12:30:54.540Z

                                            Example:

                                            {
                                              "content": [
                                                {
                                                  "id": "75b05695-27ca-46eb-9481-69c199088d99",
                                                  "name": "High temperature alert setting",
                                                  "description": "Alert setting for high temperature",
                                                  "state": "ENABLED",
                                                  "ruleIds": [
                                                    "96fafee4-3238-44ab-93c0-28969d44abf6"
                                                  ],
                                                  "actions": [
                                                    {
                                                      "actionId": "22",
                                                      "actionType": "COMMAND_INVOCATION"
                                                    }
                                                  ],
                                                  "triggers": [
                                                    {
                                                      "triggerId": "27",
                                                      "triggerType": "ENDPOINT_METADATA_UPDATED"
                                                    }
                                                  ],
                                                  "createdAt": "2023-06-30T12:30:54.540Z",
                                                  "updatedAt": "2023-06-30T12:30:54.541Z"
                                                }
                                              ],
                                              "totalElements": 2
                                            }
                                            

                                            HTTP status code 401

                                            Request is not authenticated.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            /alert-settings/{alertSettingId} get put delete

                                            get /alert-settings/{alertSettingId}

                                            Returns alert setting by ID.

                                            Secured by oauth_2_0 with scopes:
                                            • rule:read

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            URI Parameters

                                            • alertSettingId: required(string)

                                              Alert setting ID

                                            HTTP status code 200

                                            Alert setting is successfully retrieved.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • id: required(string)

                                              ID.

                                            • name: required(string)

                                              Name.

                                            • description: optional (string)

                                              Description.

                                            • state: required(one of ENABLED, DISABLED)

                                              State.

                                            • uiMetadata: optional (string)

                                              UI metadata.

                                            • ruleIds: required(array of )

                                              Rule IDs.

                                            • actions: required(array of AttachedAction)

                                              Attached actions.

                                              Items: AttachedAction

                                              • actionId: required(string)

                                                Action ID.

                                              • actionType: required(one of COMMAND_INVOCATION, METADATA_UPDATE, WEBHOOK, RULE_EXECUTION, DATA_SAMPLE, TIME_SERIES, ALERT_ACTIVATION, ALERT_RESOLUTION, SEND_EMAIL)

                                                Action type.

                                            • triggers: required(array of AttachedTrigger)

                                              Attached triggers.

                                              Items: AttachedTrigger

                                              • triggerId: required(string)

                                                Trigger ID.

                                              • triggerType: required(one of ENDPOINT_METADATA_UPDATED, ENDPOINT_TIME_SERIES_UPDATED, ENDPOINT_DATA_SAMPLES_RECEIVED, ALERT_LIFECYCLE_EVENT, CRON, RULE_EXECUTION_ACTION)

                                                Trigger type.

                                            • createdAt: required(datetime)

                                              Timestamp in ISO 8601 format (UTC timezone) showing when the record was created.

                                              Example:

                                              2023-06-30T12:30:54.540Z
                                            • updatedAt: required(datetime)

                                              Timestamp in ISO 8601 format (UTC timezone) showing when the record was last updated.

                                              Example:

                                              2023-06-30T12:30:54.540Z

                                            Example:

                                            {
                                              "id": "75b05695-27ca-46eb-9481-69c199088d99",
                                              "name": "High temperature alert setting",
                                              "description": "Alert setting for high temperature",
                                              "state": "ENABLED",
                                              "ruleIds": [
                                                "96fafee4-3238-44ab-93c0-28969d44abf6"
                                              ],
                                              "actions": [
                                                {
                                                  "actionId": "22",
                                                  "actionType": "COMMAND_INVOCATION"
                                                }
                                              ],
                                              "triggers": [
                                                {
                                                  "triggerId": "27",
                                                  "triggerType": "ENDPOINT_METADATA_UPDATED"
                                                }
                                              ],
                                              "createdAt": "2023-06-30T12:30:54.540Z",
                                              "updatedAt": "2023-06-30T12:30:54.541Z"
                                            }
                                            

                                            HTTP status code 400

                                            Invalid request.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • message: required(string)

                                              Detailed error description.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 404

                                            Resource not found or querying user is not authorized for it.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            put /alert-settings/{alertSettingId}

                                            Updates an alert setting.

                                            Secured by oauth_2_0 with scopes:
                                            • rule:update

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            URI Parameters

                                            • alertSettingId: required(string)

                                              Alert setting ID

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • name: required(string)

                                              Name.

                                            • description: optional (string)

                                              Description.

                                            • state: required(one of ENABLED, DISABLED)

                                              State.

                                            • uiMetadata: optional (string)

                                              UI metadata.

                                            • ruleIds: required(array of )

                                              Rule IDs.

                                            • actions: required(array of AttachedAction)

                                              Attached actions.

                                              Items: AttachedAction

                                              • actionId: required(string)

                                                Action ID.

                                              • actionType: required(one of COMMAND_INVOCATION, METADATA_UPDATE, WEBHOOK, RULE_EXECUTION, DATA_SAMPLE, TIME_SERIES, ALERT_ACTIVATION, ALERT_RESOLUTION, SEND_EMAIL)

                                                Action type.

                                            • triggers: required(array of AttachedTrigger)

                                              Attached triggers.

                                              Items: AttachedTrigger

                                              • triggerId: required(string)

                                                Trigger ID.

                                              • triggerType: required(one of ENDPOINT_METADATA_UPDATED, ENDPOINT_TIME_SERIES_UPDATED, ENDPOINT_DATA_SAMPLES_RECEIVED, ALERT_LIFECYCLE_EVENT, CRON, RULE_EXECUTION_ACTION)

                                                Trigger type.

                                            Example:

                                            {
                                              "name": "High temperature alert setting",
                                              "description": "Alert setting for high temperature",
                                              "ruleIds": [
                                                "96fafee4-3238-44ab-93c0-28969d44abf6"
                                              ],
                                              "actions": [
                                                {
                                                  "actionId": "22",
                                                  "actionType": "COMMAND_INVOCATION"
                                                }
                                              ],
                                              "triggers": [
                                                {
                                                  "triggerId": "27",
                                                  "triggerType": "ENDPOINT_METADATA_UPDATED"
                                                }
                                              ]
                                            }

                                            HTTP status code 204

                                            Alert setting is successfully updated.

                                            HTTP status code 400

                                            Invalid request.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • message: required(string)

                                              Detailed error description.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 404

                                            Resource not found or querying user is not authorized for it.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            delete /alert-settings/{alertSettingId}

                                            Deletes alert setting.

                                            Secured by oauth_2_0 with scopes:
                                            • rule:update

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            URI Parameters

                                            • alertSettingId: required(string)

                                              Alert setting ID

                                            HTTP status code 204

                                            Alert setting is successfully deleted.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 404

                                            Resource not found or querying user is not authorized for it.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            Secrets

                                            Operations on secrets.

                                            /secrets post get

                                            post /secrets

                                            Creates a new item.

                                            Secured by oauth_2_0 with scopes:
                                            • tenant:rule-secret:create

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • key: required(string - pattern: (?![0-9])[A-Z0-9_]+$)

                                              Secret key.

                                            • value: required(string)

                                              Secret value.

                                            Example:

                                            {
                                              "key": "MY_SECRET",
                                              "value": "fxMukYtUvH2MP27WoShdQv9PxlaMIFZd"
                                            }

                                            HTTP status code 201

                                            Item is successfully created.

                                            Headers

                                            • Location: required(string)

                                              URI in format {schema}://{host}/re/api/v1/secrets/{secretId}

                                              Example:

                                              https://cloud.kaaiot.com/re/api/v1/secrets/024c1cec-edde-4f29-a0f7-4e86aabd43b0

                                            HTTP status code 400

                                            Invalid request.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • message: required(string)

                                              Detailed error description.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 403

                                            Principal does not have sufficient permissions to perform this operation.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            get /secrets

                                            Returns list.

                                            Secured by oauth_2_0 with scopes:
                                            • rule-secret:read

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            Query Parameters

                                            • key: optional (string)

                                              Key. Supports partial match.

                                              Example:

                                              MY_SECRET
                                            • page: optional (number - default: 0)

                                              Page number.

                                              Example:

                                              0
                                            • size: optional (number - default: 100)

                                              Page size.

                                              Example:

                                              10
                                            • sort: optional (one of createdAt, updatedAt - default: createdAt)

                                              Field to sort by.

                                              Example:

                                              updatedAt
                                            • sortOrder: optional (one of asc, desc - default: desc)

                                              Sort direction.

                                              Example:

                                              asc

                                            HTTP status code 200

                                            List is successfully retrieved.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • totalElements: required(integer)

                                              Total number of elements available for retrieval.

                                            • content: required(array of ItemResponse)

                                              Items: ItemResponse

                                              • key: required(string - pattern: (?![0-9])[A-Z0-9]+$)

                                                Secret key.

                                              • value: required(string)

                                                Secret value.

                                              • createdAt: required(datetime)

                                                Timestamp in ISO 8601 format (UTC timezone) showing when the rule was created.

                                                Example:

                                                2023-06-30T12:30:54.540Z
                                              • updatedAt: required(datetime)

                                                Timestamp in ISO 8601 format (UTC timezone) showing when the rule was last updated.

                                                Example:

                                                2023-06-30T12:30:54.540Z

                                            Example:

                                            {
                                              "content": [
                                                {
                                                  "key": "MY_SECRET",
                                                  "value": "fxMukYtUvH2MP27WoShdQv9PxlaMIFZd",
                                                  "createdAt": "2023-06-30T12:30:54.540Z",
                                                  "updatedAt": "2023-06-30T12:30:54.541Z"
                                                }
                                              ],
                                              "totalElements": 1
                                            }
                                            

                                            HTTP status code 401

                                            Request is not authenticated.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            /secrets/{secretId} get put delete

                                            get /secrets/{secretId}

                                            Retrieves item.

                                            Secured by oauth_2_0 with scopes:
                                            • rule-secret:read

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            URI Parameters

                                            • secretId: required(string)

                                              ID

                                            HTTP status code 200

                                            Item is successfully retrieved.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • key: required(string - pattern: (?![0-9])[A-Z0-9]+$)

                                              Secret key.

                                            • value: required(string)

                                              Secret value.

                                            • createdAt: required(datetime)

                                              Timestamp in ISO 8601 format (UTC timezone) showing when the rule was created.

                                              Example:

                                              2023-06-30T12:30:54.540Z
                                            • updatedAt: required(datetime)

                                              Timestamp in ISO 8601 format (UTC timezone) showing when the rule was last updated.

                                              Example:

                                              2023-06-30T12:30:54.540Z

                                            Example:

                                            {
                                              "key": "MY_SECRET",
                                              "value": "fxMukYtUvH2MP27WoShdQv9PxlaMIFZd",
                                              "createdAt": "2023-06-30T12:30:54.540Z",
                                              "updatedAt": "2023-06-30T12:30:54.541Z"
                                            }

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 404

                                            Resource not found or querying user is not authorized for it.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            put /secrets/{secretId}

                                            Updates item.

                                            Secured by oauth_2_0 with scopes:
                                            • rule-secret:update

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            URI Parameters

                                            • secretId: required(string)

                                              ID

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • key: required(string - pattern: (?![0-9])[A-Z0-9_]+$)

                                              Secret key.

                                            • value: required(string)

                                              Secret value.

                                            Example:

                                            {
                                              "key": "MY_SECRET",
                                              "value": "fxMukYtUvH2MP27WoShdQv9PxlaMIFZd"
                                            }

                                            HTTP status code 204

                                            Item is successfully updated.

                                            HTTP status code 400

                                            Invalid request.

                                            Body

                                            Media type: application/json

                                            Type: object

                                            Properties

                                            • message: required(string)

                                              Detailed error description.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 404

                                            Resource not found or querying user is not authorized for it.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.

                                            delete /secrets/{secretId}

                                            Deletes.

                                            Secured by oauth_2_0 with scopes:
                                            • rule-secret:delete

                                            RE supports OAuth 2.0 for authenticating all API requests.

                                            URI Parameters

                                            • secretId: required(string)

                                              ID

                                            HTTP status code 204

                                            Item is successfully deleted.

                                            HTTP status code 401

                                            Request is not authenticated.

                                            HTTP status code 404

                                            Resource not found or querying user is not authorized for it.

                                            Secured by oauth_2_0

                                            Headers

                                            • Authorization: optional (string)

                                              Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.