REST API

Action Automation Connector REST API documentation version v1

{schema}://{host}/api/{version}

  • schema: required(one of http, https - default: http)
  • host: required(string - default: localhost)
  • version: required(v1)

Automations

Available service automations.

/automations get

get /automations

Returns automations handled by the service.

HTTP status code 200

Automations are successfully retrieved.

Body

Media type: application/json

Type: array of AutomationResponse

Items: AutomationResponse

  • automationType: required(string)

    Automation type.

  • schema: optional (object)

    Automation body JSON schema.

    Example:

    [
      {
        "automationType": "command-invocation"
      },
      {
        "automationType": "email-notification",
        "schema": {
          "$schema": "http://json-schema.org/draft-06/schema",
          "title": "Email",
          "description": "Email notification automation",
          "type": "object",
          "properties": {
            "recipient": {
              "description": "Email recipient",
              "type": "string"
            },
            "subject": {
              "description": "Email subject",
              "type": "string"
            },
            "text": {
              "description": "Email text",
              "type": "string"
            },
            "sender": {
              "description": "Email sender",
              "type": "string"
            }
          },
          "required": ["recipient", "subject", "text", "sender"]
        }
      }
    ]