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.

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.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

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.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

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.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • webhookUrl: required(string)

    Webhook URL.

  • headersExpression: optional (string)

    Wehbook HTTP headers expression.

  • webhookPayloadExpression: optional (string)

    Webhook payload expression.

  • id: required(string)

    Action ID.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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",
      "headersExpression": "return {'X-Token':'mySecret'};",
      "webhookPayloadExpression": "return 'Water leakage state is ' + ctx.endpoint.getMetadata().state.waterLeakage",
      "uiMetadata": "{\"severity\": \"CRITICAL\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

HTTP status code 200

Action is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

• name: required(string)

  Action name.

• description: optional (string)

  Action description.

• webhookUrl: required(string)

  Webhook URL.

• headersExpression: optional (string)

  Wehbook HTTP headers expression.

• webhookPayloadExpression: optional (string)

  Webhook payload expression.

• id: required(string)

  Action ID.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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",
  "headersExpression": "return {'X-Token':'mySecret'};",
  "webhookPayloadExpression": "return 'Water leakage state is ' + ctx.endpoint.getMetadata().state.waterLeakage",
  "uiMetadata": "{\"severity\": \"CRITICAL\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

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.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

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.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

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.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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

  • name: required(string)

    Action name.

  • description: optional (string)

    Action description.

  • alertTypeExpression: required(string)

    Alert type expression. Must return string that matches ^[a-zA-Z0-9_]{1,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.

  • metadataExpression: optional (string)

    Expression that returns key-value map of a custom metadata that will be attached to the activated alert.

  • uiMetadata: optional (string)

    UI metadata.

  • id: required(string)

    Action ID.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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';",
      "metadataExpression": "return {location: 'Kyiv'};",
      "startedAtExpression": "return new Date('2023-11-06T21:53:07Z').getTime();",
      "lastActiveAtExpression": "return 1699307588000;",
      "uiMetadata": "{\"severity\": \"CRITICAL\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

HTTP status code 200

Action is successfully retrieved.

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-zA-Z0-9_]{1,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.

• metadataExpression: optional (string)

  Expression that returns key-value map of a custom metadata that will be attached to the activated alert.

• uiMetadata: optional (string)

  UI metadata.

• id: required(string)

  Action ID.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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';",
  "metadataExpression": "return {location: 'Kyiv'};",
  "startedAtExpression": "return new Date('2023-11-06T21:53:07Z').getTime();",
  "lastActiveAtExpression": "return 1699307588000;",
  "uiMetadata": "{\"severity\": \"CRITICAL\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.

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

  • 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.

  • metadataExpression: optional (string)

    Expression that returns key-value map of a custom metadata that will be attached to the resolved alert.

  • uiMetadata: optional (string)

    UI metadata.

  • id: required(string)

    Action ID.

  • statistics: required(object)

    Action statistics.

    • minDuration: required(integer)

      Minimal execution duration in milliseconds.

    • maxDuration: required(integer)

      Maximal execution duration in milliseconds.

    • avgDuration: required(integer)

      Average execution duration in milliseconds.

    • lastDuration: required(integer)

      Duration of the last execution in milliseconds.

    • count: required(integer)

      Number of executions.

  • 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';",
      "metadataExpression": "return {location: 'Kyiv'};",
      "uiMetadata": "{\"severity\": \"CRITICAL\"}",
      "statistics": {
        "minDuration": 12,
        "maxDuration": 12,
        "avgDuration": 12,
        "lastDuration": 12,
        "count": 1
      },
      "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.

HTTP status code 200

Action is successfully retrieved.

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.

• metadataExpression: optional (string)

  Expression that returns key-value map of a custom metadata that will be attached to the resolved alert.

• uiMetadata: optional (string)

  UI metadata.

• id: required(string)

  Action ID.

• statistics: required(object)

  Action statistics.

  • minDuration: required(integer)

    Minimal execution duration in milliseconds.

  • maxDuration: required(integer)

    Maximal execution duration in milliseconds.

  • avgDuration: required(integer)

    Average execution duration in milliseconds.

  • lastDuration: required(integer)

    Duration of the last execution in milliseconds.

  • count: required(integer)

    Number of executions.

• 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';",
  "metadataExpression": "return {location: 'Kyiv'};",
  "uiMetadata": "{\"severity\": \"CRITICAL\"}",
  "statistics": {
    "minDuration": 12,
    "maxDuration": 12,
    "avgDuration": 12,
    "lastDuration": 12,
    "count": 1
  },
  "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.

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.

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.

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.