/api/v1/datagrid-columns/{id} (PATCH)

PATCH

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

curl --request PATCH \
  --url https://api.endless.zaia.app/api/v1/datagrid-columns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "detail": { "semanticSearch": true, "type": "string" }, "name": "example" }'

• API Server

Updates a datagrid column.

Parameters

Path Parameters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Request Body^required

Media typeapplication/json

object

description

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

string

>= 3 characters <= 250 characters

detail

Any of:

object

object

semanticSearch

required

boolean

type

required

string

Allowed values: string

object

object

type

required

string

Allowed values: number

object

object

type

required

string

Allowed values: boolean

object

object

allowedExtensions

required

Array<string>

>= 1 items <= 4 items

Allowed values: png pdf txt md

type

required

string

Allowed values: file

name

The display name of the datagrid column.

string

>= 3 characters <= 50 characters

Responses

200

The datagrid column was updated.

Media typeapplication/json

object

createdAt

required

string format: date-time

id

required

A UUID v4 string that identifies an entity.

string format: uuid

updatedAt

required

string format: date-time

datagridId

required

The datagrid ID associated with the column.

string format: uuid

description

required

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

string

>= 3 characters <= 250 characters

detail

required

Any of:

object

object

semanticSearch

required

boolean

type

required

string

Allowed values: string

object

object

type

required

string

Allowed values: number

object

object

type

required

string

Allowed values: boolean

object

object

allowedExtensions

required

Array<string>

>= 1 items <= 4 items

Allowed values: png pdf txt md

type

required

string

Allowed values: file

name

required

The display name of the datagrid column.

string

>= 3 characters <= 50 characters

Example

{
  "detail": {
    "type": "string"
  }
}

400

Invalid request - data type cannot be changed.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

401

Unauthorized.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

404

The datagrid column was not found.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}

412

Precondition failed.

Media typeapplication/json

The description of a known exception.

object

code

The error code.

string

cta

The error call-to-action.

object

type

required

string

Allowed values: support-contact

url

required

string format: uri

feedback

required

The error feedback.

object

enUs

string

esEs

string

ptBr

string

message

required

The error message.

string

name

required

The error name.

string

Example

{
  "cta": {
    "type": "support-contact"
  }
}