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

PATCH

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

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

• API Server

Updates a datagrid value.

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

detail

Any of:

object

object

type

required

string

Allowed values: string

value

required

string

nullable <= 1000 characters

object

object

type

required

string

Allowed values: number

value

required

number

nullable

object

object

type

required

string

Allowed values: boolean

value

required

boolean

nullable

object

object

type

required

string

Allowed values: file

value

required

Array<object>

nullable <= 5 items

object

description

required

string

nullable >= 3 characters <= 250 characters

extension

required

Any of:

string

string

Allowed values: png

string

string

Allowed values: pdf

string

string

Allowed values: txt

string

string

Allowed values: md

file

required

string

nullable >= 1 characters

filePath

required

string

nullable >= 1 characters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

nullable

name

required

string

nullable >= 3 characters <= 50 characters

Responses

200

The datagrid value 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

datagridColumnId

required

A UUID v4 string that identifies an entity.

string format: uuid

datagridId

required

A UUID v4 string that identifies an entity.

string format: uuid

datagridRowId

required

A UUID v4 string that identifies an entity.

string format: uuid

detail

required

Any of:

object

object

type

required

string

Allowed values: string

value

required

string

nullable <= 1000 characters

object

object

type

required

string

Allowed values: number

value

required

number

nullable

object

object

type

required

string

Allowed values: boolean

value

required

boolean

nullable

object

object

type

required

string

Allowed values: file

value

required

Array<object>

nullable <= 5 items

object

description

required

string

nullable >= 3 characters <= 250 characters

extension

required

Any of:

string

string

Allowed values: png

string

string

Allowed values: pdf

string

string

Allowed values: txt

string

string

Allowed values: md

filePath

required

string

>= 1 characters

id

required

A UUID v4 string that identifies an entity.

string format: uuid

name

required

string

>= 3 characters <= 50 characters

Example

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

400

Invalid datagrid value configuration.

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 value 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"
  }
}