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

• 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: (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

Rules are successfully retrieved.

Body

Media type: application/json

Type: object

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of all-types.RuleResponse)

  Items: RuleResponse

  • id: required(string)

    Rule ID.

  • name: required(string)

    Rule name.

  • description: (string)

    Rule description.

  • expression: required(string)

    Rule expression.

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

    enables or disables the rule.

  • uiMetadata: (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: (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

Rule is successfully retrieved.

Body

Media type: application/json

Type: object

• id: required(string)

  Rule ID.

• name: required(string)

  Rule name.

• description: (string)

  Rule description.

• expression: required(string)

  Rule expression.

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

  enables or disables the rule.

• uiMetadata: (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: (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

Rule is successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

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: (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

Rule is successfully executed.

Body

Media type: application/json

Type: object

• traces: required(array of trace-types.TraceResponse)

  Traces.

  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, ALERT_ACTIVATION_ACTION, ALERT_RESOLUTION_ACTION, SEND_EMAIL_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: (string)

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

  • reason: (string)

    Outcome reason.

  • metadata: (object)

    Additional metadata.
• returnedValue: required(string)

  Returned from rule value.

Example:

{
  "returnedValue": "\"Hello from rule\"",
  "traces": [
    {
      "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"
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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 attached to the rule are successfully retrieved.

Body

Media type: application/json

Type: object

• positiveActions: required(array of all-types.AttachedAction)

  Items: AttachedAction

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • type: required(string)

    Action type.

• negativeActions: required(array of all-types.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: (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

Triggers attached to the rule are successfully retrieved.

Body

Media type: application/json

Type: array of object

Items: AttachedTrigger

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: (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

Attached to rule command invocation actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached to rule metadata update actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached to rule webhook actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached rule execution actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached data sample actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached time series event actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached alert activation actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached alert resolution actions are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached 'endpoint metadata updated' triggers are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Attached 'cron' triggers are successfully updated.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

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

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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/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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of all-types.CommandActionResponse)

  Items: CommandActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (string)

    Action description.

  • endpointIdExpression: required(string)

    Endpoint ID expression.

  • commandType: required(string)

    Command type.

  • commandPayloadExpression: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (string)

  Action description.

• endpointIdExpression: required(string)

  Endpoint ID expression.

• commandType: required(string)

  Command type.

• commandPayloadExpression: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of all-types.MetadataUpdateActionResponse)

  Items: MetadataUpdateActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of webhook-action-types.WebhookActionResponse)

  Items: WebhookActionResponse

  • name: required(string)

    Action name.

  • description: (string)

    Action description.

  • webhookUrl: required(string)

    Webhook URL.

  • headersExpression: (string)

    Wehbook HTTP headers expression.

  • webhookPayloadExpression: (string)

    Webhook payload expression.

  • id: required(string)

    Action ID.

  • 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\"}",
      "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: (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

• name: required(string)

  Action name.

• description: (string)

  Action description.

• webhookUrl: required(string)

  Webhook URL.

• headersExpression: (string)

  Wehbook HTTP headers expression.

• webhookPayloadExpression: (string)

  Webhook payload expression.

• id: required(string)

  Action ID.

• 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\"}",
  "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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of all-types.RuleExecutionActionResponse)

  Items: RuleExecutionActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of all-types.DataSampleActionResponse)

  Items: DataSampleActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of all-types.TimeSeriesEventActionResponse)

  Items: TimeSeriesEventActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (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: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (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: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of alert-activation-action-types.ActionResponse)

  Items: ActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (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: (string)

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

  • lastActiveAtExpression: (string)

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

  • uiMetadata: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (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: (string)

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

• lastActiveAtExpression: (string)

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

• uiMetadata: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of alert-resolution-action-types.ActionResponse)

  Items: ActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (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: (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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (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: (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: (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

• 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: (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: (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

• 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: (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

• totalElements: required(integer)

  Total number of elements available for retrieval.

• content: required(array of send-email-action-types.ActionResponse)

  Items: ActionResponse

  • id: required(string)

    Action ID.

  • name: required(string)

    Action name.

  • description: (string)

    Action description.

  • recipientsExpression: required(string)

    Email recipients.

  • subjectExpression: required(string)

    Email subject expression.

  • textExpression: required(string)

    Email text expression.

  • contentType: required(one of TEXT, HTML)

    Email content type.

  • uiMetadata: (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;",
      "contentType": "TEXT",
      "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: (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

• id: required(string)

  Action ID.

• name: required(string)

  Action name.

• description: (string)

  Action description.

• recipientsExpression: required(string)

  Email recipients.

• subjectExpression: required(string)

  Email subject expression.

• textExpression: required(string)

  Email text expression.

• contentType: required(one of TEXT, HTML)

  Email content type.

• uiMetadata: (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;",
  "contentType": "TEXT",
  "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: (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

• 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: (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: (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

Expression is successfully evaluated.

Body

Media type: application/json

Type: any

Example:

true