Action Automation Connector REST version v1

https://cloud.kaaiot.com/aac/api/v1

Automations

Available service automations.

get
get

Returns automations handled by the service.

Notification types

Operations on notification types.

get post
get

Returns available email notification recipients.

post

Creates new email notification recipient.

Returns available email notification recipients.

Secured by oauth_2_0 with scopes:
  • tenant:notification-recipient:read

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

Query Parameters

  • state: (one of VERIFIED, UNVERIFIED)

    Email notification recipient verification state.

HTTP status code 200

Email notification recipients are successfully retrieved.

Body

Media type: application/json

Type: array of aac-api-types.EmailNotificationRecipient

Items: EmailNotificationRecipient

  • id: required(integer)

    Email notification recipient unique identifier.

  • recipient: required(string)

    Email notification recipient.

  • state: required(one of VERIFIED, UNVERIFIED)

    Email notification recipient verification state.

Example:

[
  {
    "id": 159,
    "recipient": "usb@auto.logistic.com",
    "state": "VERIFIED"
  },
  {
    "id": 246,
    "recipient": "krsn.company@gmail.com",
    "state": "UNVERIFIED"
  }
]

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

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.

Creates new email notification recipient.

Secured by oauth_2_0 with scopes:
  • tenant:notification-recipient:create

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

Body

Media type: application/json

Type: object

Properties
  • recipient: required(string)

    Email notification recipient.

Example:

{
  "recipient": "usb@auto.logistic.com"
}

HTTP status code 201

Unverified email notification recipient was successfully created. The verification email was sent to the specified email.

Headers

  • Location: required(string)

    URI in format {schema}://{host}:{port}/api/v1/notification-types/email/recipients/{id}

    Example:

    http://example.com/api/v1/notification-types/email/recipients/267

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

HTTP status code 403

User does not have 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.

get delete
get

Returns email notification recipient.

delete

Deletes email notification recipient.

Returns email notification recipient.

Secured by oauth_2_0 with scopes:
  • tenant:notification-recipient:read

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email
  • recipientId: required(integer)

    Email recipient ID

    Example:

    351

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

HTTP status code 200

Email notification recipient is successfully retrieved.

Body

Media type: application/json

Type: object

Properties
  • id: required(integer)

    Email notification recipient unique identifier.

  • recipient: required(string)

    Email notification recipient.

  • state: required(one of VERIFIED, UNVERIFIED)

    Email notification recipient verification state.

Example:

{
  "id": 159,
  "recipient": "usb@auto.logistic.com",
  "state": "VERIFIED"
}

HTTP status code 404

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

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

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.

Deletes email notification recipient.

Secured by oauth_2_0 with scopes:
  • tenant:notification-recipient:update

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email
  • recipientId: required(integer)

    Email recipient ID

    Example:

    351

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

HTTP status code 204

Email notification recipient successfully deleted.

HTTP status code 404

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

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

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.

post
post

Resends notification recipient verification email.

Resends notification recipient verification email.

Secured by oauth_2_0 with scopes:
  • tenant:notification-recipient:read

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email
  • recipientId: required(integer)

    Email recipient ID

    Example:

    351

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

HTTP status code 200

A verification email has been successfully sent.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

HTTP status code 404

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

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

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.

get
get

Verifies email notification recipient.

Verifies email notification recipient.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email
  • recipientId: required(integer)

    Email recipient ID

    Example:

    351
  • token: required(string)

HTTP status code 200

Email notification recipient successfully verified.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

HTTP status code 404

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

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

put
put

Verifies recipient on demand.

Verifies recipient on demand.

Secured by oauth_2_0 with scopes:
  • tenant:notification-recipient:update

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

Body

Media type: application/json

Type: array of integer

Example:

[
  1,
  2,
  3
]

HTTP status code 200

Recipients have been successfully verified.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

HTTP status code 404

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

Body

Media type: application/json

Type: object

Properties
  • message: required(string)

    Detailed error description.

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.

get put
get

Retrieves verification email template.

put

Updates verification email template.

Retrieves verification email template.

Secured by oauth_2_0 with scopes:
  • tenant:email-template:read

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

Query Parameters

  • tenantId: (string)

    Tenant ID. If omitted, the tenant ID of the authenticated principal will be used.

HTTP status code 200

Item is successfully retrieved.

Body

Media type: application/json

Type: object

Properties
  • subject: required(string)

    Subject of the verification email.

  • template: required(string)

    HTML content of the verification email. Can contain next placeholders:

    • {{accountUrl}}
    • {{year}}

Example:

{
  "subject": "Kaa email verification",
  "template": "<!DOCTYPE html><html><body></body></html>"
}

HTTP status code 403

User does not have 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.

Updates verification email template.

Secured by oauth_2_0 with scopes:
  • tenant:email-template:update

AAC supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • notificationType: required(string)

    Notification type

    Example:

    email

Headers

  • Authorization: required(string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

Query Parameters

  • tenantId: (string)

    Tenant ID. If omitted, the tenant ID of the authenticated principal will be used.

Body

Media type: application/json

Type: object

Properties
  • subject: required(string)

    Subject of the verification email.

  • template: required(string)

    HTML content of the verification email. Can contain next placeholders:

    • {{accountUrl}}
    • {{year}}

Example:

{
  "subject": "Kaa email verification",
  "template": "<!DOCTYPE html><html><body></body></html>"
}

HTTP status code 201

Item is successfully updated.

HTTP status code 403

User does not have 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.