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
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags HTTP/1.1
Host: 
Accept: */*
[
  {
    "uuid": "text",
    "name": "text",
    "objectRef": "text",
    "tagTypeId": 1
  }
]
get
Path parameters
orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters
limitinteger · int32OptionalDefault: 10
Header parameters
x-request-idstringOptional

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

Responses
400
Bad Request
*/*
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/recent-search HTTP/1.1
Host: 
Accept: */*
{
  "timestamp": 1,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

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 · int32Optional

It is the max number of result, default value 6

Default: 6Example: 6
Header parameters
x-request-idstringOptional

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

Responses
200
Ok
application/json
get
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/quicksearch?name=text HTTP/1.1
Host: 
Accept: */*
[
  {
    "uuid": "text",
    "name": "text"
  }
]

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.

Bodystring[]
string[]Optional

Uuids of consulted tags.

Responses
200
OK
put
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/add-recent HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Last updated

Was this helpful?