Parameters

The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.

API SUBPATH: eva-parameter

Environment Parameters

Retrieves a list of parameters for an Environment. If the parameter field is supplied, you search filter the results by parameter name.

GET/org/{orgUUID}/env/{envUUID}/parameters

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Query parameters

Response

200400401403404409422500

OK

Body

*/*

dataarray of ParameterListDataDTO (object)

List of parameter's DTO with id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "data": [
    {
      "id": "text",
      "enabled": false,
      "description": "text",
      "key": "text",
      "value": "text"
    }
  ],
  "message": "text"
}

Creates a new parameter/configuration within an Environment.

POST/org/{orgUUID}/env/{envUUID}/parameters

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

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

Response

200400401403404409420422500

{
  "data": {
    "id": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Updates an existing parameter/configuration for a whole environment.

PUT/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

parameterId*string

Represents the id of environment

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

200400401403404409420422500

{
  "data": {
    "id": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Removes an existing parameter/configuration for a whole environment.

DELETE/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

parameterId*string

Represents the id of environment

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

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

Response

400401403404409422500

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

Returns the current version for the cockpit server.

GET/org/{orgUUID}/env/{envUUID}/parameters/version

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Response

200400401403404409422500

OK

Body

*/*

dataVersionDataDTO (object)

DTO with value of version

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

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

Bot Parameters

Retrieves a list of parameters for a given bot. If the parameter field is supplied, you search filter the results by parameter name.

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

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

Query parameters

Response

200400401403404409422500

OK

Body

*/*

dataarray of ParameterListDataDTO (object)

List of parameter's DTO with id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "data": [
    {
      "id": "text",
      "enabled": false,
      "description": "text",
      "key": "text",
      "value": "text"
    }
  ],
  "message": "text"
}

Creates a new parameter/configuration within a bot.

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

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

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

Response

200400401403404409420422500

{
  "data": {
    "id": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Updates an existing parameter/configuration for a specific bot. Those take precedence over environment configurations.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

parameterId*string

Represents the id of configuration

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

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

Response

200400401403404409420422500

{
  "data": {
    "id": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Removes an existing parameter/configuration for a specific bot.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

parameterId*string

Represents the id of configuration

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

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

Response

400401403404409422500

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