Datagrid Columns

get

Retrieves multiple datagrid columns.

Query parameters
datagridIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all datagrid columns for the specified datagrid.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

The datagrid ID associated with the column.

descriptionstring · min: 3 · max: 250Required

The description of the column. Will be used by the agent to understand how to interact with it.

detailany ofRequired
or
or
namestring · min: 3 · max: 50Required

The display name of the datagrid column.

get
/api/v1/datagrid-columns
post

Creates a new datagrid column.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
datagridIdstring · uuidRequired

The datagrid ID associated with the column.

descriptionstring · min: 3 · max: 250Required

The description of the column. Will be used by the agent to understand how to interact with it.

detailany ofRequired
or
or
namestring · min: 3 · max: 50Required

The display name of the datagrid column.

Responses
200

The datagrid column was created.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

The datagrid ID associated with the column.

descriptionstring · min: 3 · max: 250Required

The description of the column. Will be used by the agent to understand how to interact with it.

detailany ofRequired
or
or
namestring · min: 3 · max: 50Required

The display name of the datagrid column.

post
/api/v1/datagrid-columns
delete

Removes a datagrid column.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The datagrid column was removed along with all associated values.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/datagrid-columns/{id}
patch

Updates a datagrid column.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250Optional

The description of the column. Will be used by the agent to understand how to interact with it.

detailany ofOptional
or
or
namestring · min: 3 · max: 50Optional

The display name of the datagrid column.

Responses
200

The datagrid column was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

The datagrid ID associated with the column.

descriptionstring · min: 3 · max: 250Required

The description of the column. Will be used by the agent to understand how to interact with it.

detailany ofRequired
or
or
namestring · min: 3 · max: 50Required

The display name of the datagrid column.

patch
/api/v1/datagrid-columns/{id}

Last updated