/api/v1/datagrid-rows (GET)

GET

/api/v1/datagrid-rows

curl --request GET \
  --url 'https://api.endless.zaia.app/api/v1/datagrid-rows?datagridId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&mode=semantic&operator=ilike&pageNumber=1&pageSize=10'

• API Server

Retrieves multiple datagrid rows.

Parameters

Query Parameters

datagridColumnIds

Any of:

Array<string>

Array<string>

string

A UUID v4 string that identifies an entity.

string format: uuid

datagridId

required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

mode

string

default: semantic

Allowed values: semantic similarity

operator

string

default: ilike

Allowed values: ilike not ilike

pageNumber

The page number.

number

default: 1 >= 1

The page number.

pageSize

The page size.

number

default: 10 >= 1 <= 100

The page size.

search

string

>= 1 characters

Responses

200

Retrieves all datagrid rows for the specified datagrid.

Media typeapplication/json

Array<object>

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

A UUID v4 string that identifies an entity.

string format: uuid

position

required

integer

datagridValues

required

Array<object>

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

[
  {
    "datagridValues": [
      {
        "detail": {
          "type": "string"
        }
      }
    ]
  }
]

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

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