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

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Query parameters

parameterstringOptional

It is the parameter's name to find

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/parameters HTTP/1.1
Host: 
Accept: */*

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

Creates a new parameter/configuration within an Environment.

post

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

post

POST /org/{orgUUID}/env/{envUUID}/parameters HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Updates an existing parameter/configuration for a whole environment.

put

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

parameterIdstringRequired

Represents the id of environment

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Parameter with that id and botUUID doesn't exist

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

put

PUT /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Removes an existing parameter/configuration for a whole environment.

delete

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

parameterIdstringRequired

Represents the id of environment

Responses

200

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Configuration is not erasable

*/*

404

Parameter with that id doesn't exist

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Host: 
Accept: */*

No content

Returns the current version for the cockpit server.

get

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Configuration not found

*/*

get

GET /org/{orgUUID}/env/{envUUID}/parameters/version HTTP/1.1
Host: 
Accept: */*

{
  "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

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

Query parameters

parameterstringOptional

It is the parameter's name to find

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters HTTP/1.1
Host: 
Accept: */*

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

Creates a new parameter/configuration within a bot.

post

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

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

put

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

parameterIdstringRequired

Represents the id of configuration

Body

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Parameter with that id and botUUID doesn't exist

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Removes an existing parameter/configuration for a specific bot.

delete

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

parameterIdstringRequired

Represents the id of configuration

Responses

200

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Configuration is not erasable

*/*

404

Parameter with that id doesn't exist

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Host: 
Accept: */*

No content

PreviousIntent NextTraining

Was this helpful?