Datagrid Rows

get

Retrieves multiple datagrid rows.

Query parameters
datagridColumnIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

datagridIdstring · uuidRequired

A UUID v4 string that identifies an entity.

modestring · enumOptionalDefault: semanticPossible values:
operatorstring · enumOptionalDefault: ilikePossible values:
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
searchstring · min: 1Optional
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 rows for the specified datagrid.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

A UUID v4 string that identifies an entity.

positionintegerRequired
get
/api/v1/datagrid-rows
post

Creates a new datagrid row.

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

A UUID v4 string that identifies an entity.

positionintegerRequired
Responses
200

The datagrid row was created with default values for all columns.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

A UUID v4 string that identifies an entity.

positionintegerRequired
post
/api/v1/datagrid-rows
delete

Removes multiple datagrid rows.

Query parameters
idsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

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 rows were removed.

application/json
messagestringRequired

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

delete
/api/v1/datagrid-rows
get

Retrieves a datagrid row.

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

Retrieves a datagrid row.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

A UUID v4 string that identifies an entity.

positionintegerRequired
get
/api/v1/datagrid-rows/{id}
delete

Removes a datagrid row.

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 row was removed.

application/json
messagestringRequired

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

delete
/api/v1/datagrid-rows/{id}
patch
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
positionintegerOptional
Responses
200

The datagrid row was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

updatedAtstring · date-timeRequired
datagridIdstring · uuidRequired

A UUID v4 string that identifies an entity.

positionintegerRequired
patch
/api/v1/datagrid-rows/{id}

Last updated