Tag

The tag API handles searching with tags

API SUBPATH: eva-tag

Auxiliary Methods

Retrieves all existing Tags registered in a given Bot.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Responses

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags'

200

400

401

403

404

409

422

500

200

[
  {
    "uuid": "text",
    "name": "text",
    "objectRef": "text",
    "tagTypeId": 1
  }
]

Ok

Retrieves the tags just consulted.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Query parameters

limitinteger · int32 · default: 10optional

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/recent-search'

400

401

403

404

409

422

500

default

400

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

Bad Request

Its service is used to search a tags by name.

get

Path parameters

orgUUIDstringrequired

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

envUUIDstringrequired

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

botUUIDstringrequired

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

Query parameters

namestringrequired

It is the parameter used to search for tags related to the entered value

limitinteger · int32 · default: 6optional

It is the max number of result, default value 6

Example: 6

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

application/json

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/quicksearch?name=text'

200

400

401

403

404

409

422

500

200

[
  {
    "uuid": "text",
    "name": "text"
  }
]

Ok

Records new tag searches.

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

string[]optional

Uuids of consulted tags.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/add-recent' \
  --header 'Content-Type: application/json' \
  --data '[
    "text"
  ]'

200

400

401

403

404

409

422

500

200

No body

OK