Dialog Manager

The Dialog Manager is where you configure and draw your flows; Those are the methods you'll need to setup a user flow, configure each Cell and link them.

API SUBPATH: eva-dialog-manager

Flows

Pagination and Listings

Its function is to provide a list of Flow in page format

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of FlowPageDTO (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows?enabled=false&page=0&linesPerPage=5&orderBy=name&direction=ASC&searchTerms=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "uuid": "text",
      "name": "text",
      "type": "USER_JOURNEY",
      "size": 0,
      "lastModified": {
        "uuid": "text",
        "image": "text",
        "name": "text",
        "timeStamp": 0
      },
      "rules": {
        "delete": false,
        "jumped": false,
        "children": [
          "text"
        ]
      },
      "tags": [
        {
          "name": "text"
        }
      ]
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

Its service is used to search a flows by name

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/quicksearch

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

[
  "text"
]

CRUD Operations

Service responsible for creating a flow.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

Header parameters

Body

application/json

namestring

Name of the flow.

descriptionstring

Description of the flow.

tagsarray of TagDTO (object)

These are the tags used in the Flow.

typeenum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

Response

201400401403404409422500

CREATED

Body

*/*

uuidstring

Uuid of the flow.

namestring

Name of the flow.

typeenum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

sizeinteger (int32)

Number of cells in the flow.

lastModifiedUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the Flow.

rulesRuleDTO (object)

Represents the Flow rules, used to generate usage rules in Cockpit.

tagsarray of TagDTO (object)

These are the tags used in the Flow.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text",
  "name": "text",
  "type": "USER_JOURNEY",
  "size": 0,
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 0
  },
  "rules": {
    "delete": false,
    "jumped": false,
    "children": [
      "text"
    ]
  },
  "tags": [
    {
      "name": "text"
    }
  ]
}

Its function is to find the Flow data and provide it for updating

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

uuid*string

It is the uuid used to search for a Flow

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

namestring

Name of the flow.

descriptionstring

Description of the flow.

tagsarray of TagDTO (object)

These are the tags used in the Flow.

typeenum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

uuidstring

Uuid of the flow.

createdByUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the Flow.

rulesRuleDTO (object)

Represents the Flow rules, used to generate usage rules in Cockpit.

disconnectedboolean

It is a flag that represents if the Flow has disconnected cells.

editorsarray of UserDTO (object)

It is a list of users who have already edited this Flow.

cellsTypearray of CellTypeDTO (object)

It is a summary that contains the number of cell types in the Flow.

jumpFromobject

Contains data from cells that jump to this Flow.

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "type": "USER_JOURNEY",
  "uuid": "text",
  "createdBy": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 0
  },
  "rules": {
    "delete": false,
    "jumped": false,
    "children": [
      "text"
    ]
  },
  "disconnected": false,
  "editors": [
    {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timeStamp": 0
    }
  ],
  "cellsType": [
    {
      "size": 0,
      "cellType": "text",
      "names": [
        "text"
      ]
    }
  ]
}

Service responsible for updating a flow

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

uuid*string

It is the uuid used to search for the Flow that will be updated

Header parameters

Body

application/json

namestring

Name of the flow.

descriptionstring

Description of the flow.

tagsarray of TagDTO (object)

These are the tags used in the Flow.

typeenum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

Response

200400401403404409422500

OK

Body

*/*

uuidstring

Uuid of the flow.

namestring

Name of the flow.

typeenum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

sizeinteger (int32)

Number of cells in the flow.

lastModifiedUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the Flow.

rulesRuleDTO (object)

Represents the Flow rules, used to generate usage rules in Cockpit.

tagsarray of TagDTO (object)

These are the tags used in the Flow.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

{
  "uuid": "text",
  "name": "text",
  "type": "USER_JOURNEY",
  "size": 0,
  "lastModified": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 0
  },
  "rules": {
    "delete": false,
    "jumped": false,
    "children": [
      "text"
    ]
  },
  "tags": [
    {
      "name": "text"
    }
  ]
}

Service responsible for updating a flow

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

uuid*string

It is the uuid used to search for the Flow that will be deleted

Header parameters

Response

204400401403404409422500

NO_CONTENT

Request

JavaScriptCurlPython

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

Response

400401403404409422500

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

Auxiliary Methods

Analyzes which types of Flows have already been created, and returns a list of possible types that can still be created

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/types-to-create

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsenum

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/types-to-create', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "USER_JOURNEY"
]

Endpoint to list the flow names of one bot that have cells with the type passed as parameter

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/by-cellType

Path parameters

orgUUID*string

It is the organization uuid where the bot is

envUUID*string

It is the environment uuid where the bot is

botUUID*string

It is the identification of the bot

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/by-cellType?cellType=ANSWER', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Flow Tree

Its function is to find the Flow data, containing the complete tree, rules and so on

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}/tree

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter Flows

uuid*string

It is the uuid used to search for a Flow

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

namestring

Name of the flow.

descriptionstring

Description of the flow.

tagsarray of TagDTO (object)

These are the tags used in the Flow.

typeenum

The flow type shall refer to:

1 - USER_JOURNEY

2 - WELCOME

3 - NOT_EXPECTED

4 - JUMP

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

uuidstring

Uuid of the flow.

createdByUserDTO (object)

Represents the basic data of a User, in this case the last user to edit the Flow.

rulesRuleDTO (object)

Represents the Flow rules, used to generate usage rules in Cockpit.

disconnectedboolean

It is a flag that represents if the Flow has disconnected cells.

editorsarray of UserDTO (object)

It is a list of users who have already edited this Flow.

cellsTypearray of CellTypeDTO (object)

It is a summary that contains the number of cell types in the Flow.

jumpFromobject

Contains data from cells that jump to this Flow.

treeCellResponseDTO (object)

DTO responsible to return data of cell

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/flows/{uuid}/tree', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "name": "text",
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "type": "USER_JOURNEY",
  "uuid": "text",
  "createdBy": {
    "uuid": "text",
    "image": "text",
    "name": "text",
    "timeStamp": 0
  },
  "rules": {
    "delete": false,
    "jumped": false,
    "children": [
      "text"
    ]
  },
  "disconnected": false,
  "editors": [
    {
      "uuid": "text",
      "image": "text",
      "name": "text",
      "timeStamp": 0
    }
  ],
  "cellsType": [
    {
      "size": 0,
      "cellType": "text",
      "names": [
        "text"
      ]
    }
  ],
  "tree": {
    "uuid": "text",
    "cellFirst": false,
    "cellParentUUID": "text",
    "buttonParentUUID": "text",
    "flowUUID": "text",
    "draftText": "text",
    "cellName": "text",
    "cellType": "text",
    "modelVersion": "text",
    "cellEnable": false,
    "expressionCode": "text",
    "objectRef": "text",
    "editor": {
      "uuid": "text",
      "lastModified": false,
      "lastEdition": 0
    },
    "jumpTo": {
      "cellDestination": "text",
      "cellDestinationName": "text",
      "flowDestination": "text",
      "flowDestinationName": "text"
    },
    "rules": {
      "connectionOnTheLeft": false,
      "connectionOnTheRight": false,
      "connectionOnTheBottom": false,
      "delete": false,
      "children": [
        "text"
      ],
      "sequence": [
        "text"
      ],
      "jump": [
        "text"
      ]
    },
    "disconnected": false,
    "executionLimit": 0,
    "hasSibling": false,
    "jumpFrom": [
      {
        "cellOrigin": "text",
        "flowOrigin": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 0
      }
    ],
    "children": [],
    "options": [
      {
        "buttonUUID": "text",
        "cockpitUUID": "text",
        "urlRedirect": false,
        "buttonUrl": "text",
        "buttonType": "text",
        "buttonText": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "disconnected": false,
        "rules": {
          "connectionOnTheLeft": false,
          "connectionOnTheRight": false,
          "connectionOnTheBottom": false,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ]
        }
      }
    ],
    "description": "text",
    "template": "text"
  }
}

Cells

CRUD Operations

Create new cells

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Body

application/json

cellName*string

Name of the cell

cellType*enum

Type of the cell

ANSWERANYTHING_ELSEINTENTENTITYSYSTEM_ENTITYSERVICEGENERATIVE_SERVICERESTUSERBOTJUMPWAIT_INPUTRULECODEPLACE_HOLDERENDSTART

descriptionstring

Description of the cell

objectRefstring

Uuid of object to relationate. It can be intent, entity, service...

expressionCode*string

Expression code of the cell

jumpToJumpTo (object)

DTO and entity used to request create of jump cell

templatestring

Template of the cell. It's required if cell is code or rule type

executionLimitinteger (int64)

Number of times that the cell has to execute repeatedly

optionsarray of ButtonCreateDTO (object)

Options of the cell. It's required if cell is service type

tagsarray of Tag (object)

Tags of the cell

Response

201400401403404409422500

Created

Body

*/*

uuidstring

Uuid of the cell

cellFirstboolean

True if is the first cell of flow, false if not

cellParentUUIDstring

Uuid of parent cell

buttonParentUUIDstring

Uuid of parent button

flowUUIDstring

Uuid of flow that the cell belongs

draftTextstring

Draft text of the cell

cellNamestring

Name of the cell

cellTypestring

Type of the cell

modelVersionstring

Model version of the cell

cellEnableboolean

If the cell is enable or not

expressionCodestring

Expression code of the cell

objectRefstring

Uuid of the object that is relationed. This object can be intent, entity, service...

editorEditor (object)

This class represents the eva users who modified the flow.

jumpToJumpToResponseDTO (object)

DTO with data about destination after jump

rulesCellRulesDTO (object)

DTO responsible to return rules of cell

disconnectedboolean

If the cell is disconnected or not

executionLimitinteger (int64)

Number of executions the cell may have

hasSiblingboolean

If the cell has siblings or not

jumpFromarray of JumpFromDTO (object)

cell list coming to her from a jump cell

tagsarray of Tag (object)

Tags of the cell

childrenarray of CellResponseDTO (object)

Children of the cell

optionsarray of ButtonDTO (object)

Buttons of the cell. It only has if it is a service type

descriptionstring

Description of the cell

templatestring

Template of the cell. It only has if it is a code or rule type

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells?flowUUID=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cellName": "text",
      "cellType": "ANSWER",
      "expressionCode": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

[
  {
    "uuid": "text",
    "cellFirst": false,
    "cellParentUUID": "text",
    "buttonParentUUID": "text",
    "flowUUID": "text",
    "draftText": "text",
    "cellName": "text",
    "cellType": "text",
    "modelVersion": "text",
    "cellEnable": false,
    "expressionCode": "text",
    "objectRef": "text",
    "editor": {
      "uuid": "text",
      "lastModified": false,
      "lastEdition": 0
    },
    "jumpTo": {
      "cellDestination": "text",
      "cellDestinationName": "text",
      "flowDestination": "text",
      "flowDestinationName": "text"
    },
    "rules": {
      "connectionOnTheLeft": false,
      "connectionOnTheRight": false,
      "connectionOnTheBottom": false,
      "delete": false,
      "children": [
        "text"
      ],
      "sequence": [
        "text"
      ],
      "jump": [
        "text"
      ]
    },
    "disconnected": false,
    "executionLimit": 0,
    "hasSibling": false,
    "jumpFrom": [
      {
        "cellOrigin": "text",
        "flowOrigin": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "objectRef": "text",
        "tagTypeId": 0
      }
    ],
    "children": [],
    "options": [
      {
        "buttonUUID": "text",
        "cockpitUUID": "text",
        "urlRedirect": false,
        "buttonUrl": "text",
        "buttonType": "text",
        "buttonText": "text",
        "expressionCode": "text",
        "connectedTo": "text",
        "disconnected": false,
        "rules": {
          "connectionOnTheLeft": false,
          "connectionOnTheRight": false,
          "connectionOnTheBottom": false,
          "children": [
            "text"
          ],
          "sequence": [
            "text"
          ]
        }
      }
    ],
    "description": "text",
    "template": "text"
  }
]

Search cells

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

cellUUID*string

A valid cell Uuid

Response

200400401403404409422500

Ok

Body

*/*

uuidstring

Uuid of the cell

cellFirstboolean

True if is the first cell of flow, false if not

cellParentUUIDstring

Uuid of parent cell

buttonParentUUIDstring

Uuid of parent button

flowUUIDstring

Uuid of flow that the cell belongs

draftTextstring

Draft text of the cell

cellNamestring

Name of the cell

cellTypestring

Type of the cell

modelVersionstring

Model version of the cell

cellEnableboolean

If the cell is enable or not

expressionCodestring

Expression code of the cell

objectRefstring

Uuid of the object that is relationed. This object can be intent, entity, service...

editorEditor (object)

This class represents the eva users who modified the flow.

jumpToJumpToResponseDTO (object)

DTO with data about destination after jump

rulesCellRulesDTO (object)

DTO responsible to return rules of cell

disconnectedboolean

If the cell is disconnected or not

executionLimitinteger (int64)

Number of executions the cell may have

hasSiblingboolean

If the cell has siblings or not

jumpFromarray of JumpFromDTO (object)

cell list coming to her from a jump cell

tagsarray of Tag (object)

Tags of the cell

childrenarray of CellResponseDTO (object)

Children of the cell

optionsarray of ButtonDTO (object)

Buttons of the cell. It only has if it is a service type

descriptionstring

Description of the cell

templatestring

Template of the cell. It only has if it is a code or rule type

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "uuid": "text",
  "cellFirst": false,
  "cellParentUUID": "text",
  "buttonParentUUID": "text",
  "flowUUID": "text",
  "draftText": "text",
  "cellName": "text",
  "cellType": "text",
  "modelVersion": "text",
  "cellEnable": false,
  "expressionCode": "text",
  "objectRef": "text",
  "editor": {
    "uuid": "text",
    "lastModified": false,
    "lastEdition": 0
  },
  "jumpTo": {
    "cellDestination": "text",
    "cellDestinationName": "text",
    "flowDestination": "text",
    "flowDestinationName": "text"
  },
  "rules": {
    "connectionOnTheLeft": false,
    "connectionOnTheRight": false,
    "connectionOnTheBottom": false,
    "delete": false,
    "children": [
      "text"
    ],
    "sequence": [
      "text"
    ],
    "jump": [
      "text"
    ]
  },
  "disconnected": false,
  "executionLimit": 0,
  "hasSibling": false,
  "jumpFrom": [
    {
      "cellOrigin": "text",
      "flowOrigin": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "objectRef": "text",
      "tagTypeId": 0
    }
  ],
  "children": [],
  "options": [
    {
      "buttonUUID": "text",
      "cockpitUUID": "text",
      "urlRedirect": false,
      "buttonUrl": "text",
      "buttonType": "text",
      "buttonText": "text",
      "expressionCode": "text",
      "connectedTo": "text",
      "disconnected": false,
      "rules": {
        "connectionOnTheLeft": false,
        "connectionOnTheRight": false,
        "connectionOnTheBottom": false,
        "children": [
          "text"
        ],
        "sequence": [
          "text"
        ]
      }
    }
  ],
  "description": "text",
  "template": "text"
}

Update cells

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

cellUUID*string

A valid cell Uuid

Body

application/json

cellName*string

Name of the cell

descriptionstring

Description of the cell

objectRefstring

Uuid of object to relationate. It can be intent, entity, service...

expressionCode*string

Expression code of the cell

cellEnable*boolean

True if wants to enable cell or false if not

jumpToJumpTo (object)

DTO and entity used to request create of jump cell

templatestring

Template of the cell. It's required if cell is code or rule type

executionLimitinteger (int64)

Number of times that the cell has to execute repeatedly

optionsarray of ButtonUpdateDTO (object)

Options of the cell. It's required if cell is service type

tagsarray of Tag (object)

Tags of the cell

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cellEnable": false,
      "cellName": "text",
      "expressionCode": "text"
    }),
});
const data = await response.json();

Response

400401403404409422500

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

Update cells

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/{cellUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

cellUUID*string

A valid cell Uuid

Query parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

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

Response

400401403404409422500

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

Auxiliary Methods

Valid the template of cell

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/template/validate

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Body

application/json

templatestring

Response

200400401403404409422500

Ok

Body

*/*

validboolean

If it's valid or not

messagestring

Message if it's not valid

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/template/validate?cellType=ANSWER', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404409422500

{
  "valid": false,
  "message": "text"
}

List all cells of a bot by the type passed in parameter

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type

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

*/*

objectRefstring

Uuid of the object that is relationed. This object can be intent, entity, service...

cellTypestring

Type of cell

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type?cellType=ANSWER', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "objectRef": "text",
    "cellType": "text"
  }
]

List all objectRef of cells that are the first cell of any flow in one bot

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/start-flows

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}/cells/start-flows?cellType=ANSWER', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

List all buttons of service cell

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/buttons

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

*/*

buttonUUIDstring

Uuid of button

cockpitUUIDstring

Uuid of button of cockpit

urlRedirectboolean

True if has url redirect and false if not

buttonUrlstring

Url of button

buttonTypestring

Type of button

buttonTextstring

Text of button

expressionCodestring

Expression code of button

connectedTostring

Uuid of the cell connected in the button

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/buttons?cellType=ANSWER&objectRef=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "buttonUUID": "text",
    "cockpitUUID": "text",
    "urlRedirect": false,
    "buttonUrl": "text",
    "buttonType": "text",
    "buttonText": "text",
    "expressionCode": "text",
    "connectedTo": "text"
  }
]

List all cells informing if can be connected left, bottom or right

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection

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

*/*

uuidstring

Uuid of the cell

connectionOnTheLeftboolean

If can be connected in left

connectionOnTheRightboolean

If can be connected in right

connectionOnTheBottomboolean

If can be connected in bottom

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?uuid=text&direction=LEFT', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "uuid": "text",
    "connectionOnTheLeft": false,
    "connectionOnTheRight": false,
    "connectionOnTheBottom": false
  }
]

List all flows that is possible to jump

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/jump

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

*/*

uuidstring

Uuid of the flow

namestring

Name of the flow

typeenum

Type of the flow

USER_JOURNEYWELCOMENOT_EXPECTEDJUMPDRAFT

enabledboolean

True if it's possible to jump, false if not

errorstring

If it's false, it's the message saying why you can't jump

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/jump?flowUUID=text&cellParentUUID=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "uuid": "text",
    "name": "text",
    "type": "USER_JOURNEY",
    "enabled": false,
    "error": "text"
  }
]

Massive update

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/massive

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Body

application/json

cellName*string

Name of the cell

descriptionstring

Description of the cell

expressionCode*string

Expression code of the cell

cellEnable*boolean

True if wants to enable cell or false if not

executionLimitinteger (int64)

Number of times that the cell has to execute repeatedly

optionsarray of ButtonUpdateDTO (object)

Options of the cell. It's required if cell is service type

templatestring

Template of the cell, in this case is used to rest connector cell

tagsarray of Tag (object)

Tags of the cell

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/massive?cellType=ANSWER&objectRef=text', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "cellEnable": false,
      "cellName": "text",
      "expressionCode": "text"
    }),
});
const data = await response.json();

Response

400401403404409422500

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

Connect cells

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/connection?cellOrigin=text&cellDestination=text&buttonUUID=text&direction=LEFT', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

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

Change visibility of one cell

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/change-visibility

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Body

application/json

botId*string

Uuid of the bot

objectRef*string

Uuid of object to relationate. It can be intent, entity, service...

visibility*boolean

true if you want to make visible, false if not

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/change-visibility', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "botId": "text",
      "objectRef": "text",
      "visibility": false
    }),
});
const data = await response.json();

Response

400401403404409422500

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

Remove cells by its type

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/cells/by-type?cellType=ANSWER&objectRef=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

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