Rest Connector

The Rest Connector API handles all rest connectors used in your flows. They share the transactional service subpath.

API SUBPATH: eva-transactional-service

Pagination and Listing

Returng a pagination list of bot's rest connectors

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/pagination

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

sizeinteger (int32)

contentarray of TransactionalServicePageDTO (object)

numberinteger (int32)

sortSort (object)

pageablePageableObject (object)

numberOfElementsinteger (int32)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/pagination', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ],
      "updatedAt": "2024-11-21T06:27:06.461Z",
      "updatedBy": "text",
      "user": {
        "image": "text",
        "username": "text"
      }
    }
  ],
  "sort": {
    "empty": false,
    "sorted": false,
    "unsorted": false
  },
  "pageable": {
    "sort": {
      "empty": false,
      "sorted": false,
      "unsorted": false
    },
    "paged": false,
    "unpaged": false
  },
  "first": false,
  "last": false,
  "empty": false
}

Returning a list of possible words to autocomplete in search

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Returns a list of all existing bot's rest connectors

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/list

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Response

200400401403404409422500

Ok

Body

*/*

dataarray of TransactionalServiceContentListDTO (object)

List with of transactional service

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "content": [
        {
          "id": "text",
          "option": "text",
          "expressionCode": "text",
          "connectedTo": "text",
          "buttonText": "text",
          "buttonType": "text",
          "urlRedirect": false,
          "buttonUrl": "text",
          "cockpitUUID": "text"
        }
      ],
      "tags": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

CRUD Operations

Retrieves a rest connector, by ID.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

serviceUUID*string

A valid service Uuid

Response

200400401403404409422500

Ok

Body

*/*

name*string

Name of the rest connector

descriptionstring

Description of the rest connector

requestType*RequestTypeEnum (enum)

The used RequestType

GETPOSTPUTDELETE

url*string

Url of the rest connector

headersarray of HeaderDTO (object)

Headers of the rest connector

contentType*ContentTypeEnum (enum)

Content Type of the request

NONEJSONXMLFORM_DATAURL_ENCODED

authType*AuthTypeEnum (enum)

Enum describing if cell uses an auth method, and which.

AUTH_NONEAUTH_BASICAUTH_BEARERAUTH_OAUTH

grantTypeGrantTypeEnum (enum)

Grant type to be used with oAuth Method

CLIENT_CREDENTIALSPASSWORDREFRESH_TOKEN

basicTokenstring

Basic Token for Basic Auth Header

bearerTokenstring

Bearer Token for Bearer Token Auth Header

clientIdstring

Client Id to be used with oAuth Method

clientSecretstring

Client Secret to be used with oAuth Method and grant type 'client_credentials'

oauthUrlstring

URL for authentication with oAuth Method

authUsernamestring

Username to be used with oAuth Method and grant type 'password'

authPasswordstring

Password to be used with oAuth Method and grant type 'password'

body*string

Body of the rest connector

output*string

Expected parsing of output of the rest connector

tagsarray of TagDTO (object)

Tags of the rest connector

uuidstring

UUID of the transactional service

flowsarray of FlowDTO (object)

Flows when the transactional service is used

updatedAtstring (date-time)

Datetime of last transactional service update

updatedBystring

User uuid of last transactional service update

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "name": "text",
  "description": "text",
  "requestType": "GET",
  "url": "text",
  "headers": [
    {
      "header": "text",
      "value": "text"
    }
  ],
  "contentType": "NONE",
  "authType": "AUTH_NONE",
  "grantType": "CLIENT_CREDENTIALS",
  "basicToken": "text",
  "bearerToken": "text",
  "clientId": "text",
  "clientSecret": "text",
  "oauthUrl": "text",
  "authUsername": "text",
  "authPassword": "text",
  "body": "text",
  "output": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "uuid": "text",
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ],
  "updatedAt": "2024-11-21T06:27:06.461Z",
  "updatedBy": "text"
}

Create a new Rest Connector

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

name*string

Name of the rest connector

descriptionstring

Description of the rest connector

requestType*RequestTypeEnum (enum)

The used RequestType

GETPOSTPUTDELETE

url*string

Url of the rest connector

headersarray of HeaderDTO (object)

Headers of the rest connector

contentType*ContentTypeEnum (enum)

Content Type of the request

NONEJSONXMLFORM_DATAURL_ENCODED

authType*AuthTypeEnum (enum)

Enum describing if cell uses an auth method, and which.

AUTH_NONEAUTH_BASICAUTH_BEARERAUTH_OAUTH

grantTypeGrantTypeEnum (enum)

Grant type to be used with oAuth Method

CLIENT_CREDENTIALSPASSWORDREFRESH_TOKEN

basicTokenstring

Basic Token for Basic Auth Header

bearerTokenstring

Bearer Token for Bearer Token Auth Header

clientIdstring

Client Id to be used with oAuth Method

clientSecretstring

Client Secret to be used with oAuth Method and grant type 'client_credentials'

oauthUrlstring

URL for authentication with oAuth Method

authUsernamestring

Username to be used with oAuth Method and grant type 'password'

authPasswordstring

Password to be used with oAuth Method and grant type 'password'

body*string

Body of the rest connector

output*string

Expected parsing of output of the rest connector

tagsarray of TagDTO (object)

Tags of the rest connector

Response

201400401403404409422500

Created

Body

*/*

uuidstring

UUID of the transactional service

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "authType": "AUTH_NONE",
      "body": "text",
      "contentType": "NONE",
      "name": "text",
      "output": "text",
      "requestType": "GET",
      "url": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text"
}

Updates an existing rest connector

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

serviceUUID*string

A valid service Uuid

Body

application/json

name*string

Name of the rest connector

descriptionstring

Description of the rest connector

requestType*RequestTypeEnum (enum)

The used RequestType

GETPOSTPUTDELETE

url*string

Url of the rest connector

headersarray of HeaderDTO (object)

Headers of the rest connector

contentType*ContentTypeEnum (enum)

Content Type of the request

NONEJSONXMLFORM_DATAURL_ENCODED

authType*AuthTypeEnum (enum)

Enum describing if cell uses an auth method, and which.

AUTH_NONEAUTH_BASICAUTH_BEARERAUTH_OAUTH

grantTypeGrantTypeEnum (enum)

Grant type to be used with oAuth Method

CLIENT_CREDENTIALSPASSWORDREFRESH_TOKEN

basicTokenstring

Basic Token for Basic Auth Header

bearerTokenstring

Bearer Token for Bearer Token Auth Header

clientIdstring

Client Id to be used with oAuth Method

clientSecretstring

Client Secret to be used with oAuth Method and grant type 'client_credentials'

oauthUrlstring

URL for authentication with oAuth Method

authUsernamestring

Username to be used with oAuth Method and grant type 'password'

authPasswordstring

Password to be used with oAuth Method and grant type 'password'

body*string

Body of the rest connector

output*string

Expected parsing of output of the rest connector

tagsarray of TagDTO (object)

Tags of the rest connector

Response

200400401403404409422500

Ok

Body

*/*

messagestring

Message 'OK'

datastring

Message 'Service Updated'

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "authType": "AUTH_NONE",
      "body": "text",
      "contentType": "NONE",
      "name": "text",
      "output": "text",
      "requestType": "GET",
      "url": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "message": "text",
  "data": "text"
}

Symbolically deletes an existing rest connector

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

serviceUUID*string

A valid service Uuid

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/rest-connectors/{serviceUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}