45 Object Data

Object Data

Arbitrary data in any format can be associated with an object in the system.

API

POST /api/v1/object/data

Get or set arbitrary data for an object.

Request parameters:

Name	Type	Value	Description
id	NUMERIC		Required. Object identifier.
data	JSON array	null OR json	Variant. JSON array of objects containing arbitrary data.

data format:

Name	Type	Value	Description
type	STRING	text, json, xml	Required. Data type code.
code	STRING		Required. Data code (a unique key for this data entry).
data	STRING		Variant. The arbitrary data payload.

NOTE: If the data value is not specified or is null, the method works as Get; otherwise it works as Set.

Set

POST /api/v1/object/data/set

Set arbitrary data for an object.

Request parameters:

Name	Type	Value	Description
id	NUMERIC		Required. Object identifier.
data	JSON array		Required. JSON array of objects containing arbitrary data.

NOTE: Omitted keys are treated as null.

NOTE: If the data key value is not specified or is null, the action is treated as Delete.

Example (set):

Request:

POST /api/v1/object/data/set HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[truncated for brevity].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"id": 2, "data": [{"type": "json", "code": "unique.code", "data": "{\"search\": [{\"field\": \"validfromdate\", \"value\": \"24.03.2020 00:31:23\", \"compare\": \"LEQ\"}, {\"field\": \"validtodate\", \"value\": \"24.03.2020 00:31:23\", \"compare\": \"GTR\"}]}"}]}

Example (delete):

Request:

POST /api/v1/object/data/set HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[truncated for brevity].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"id": 2, "data": [{"type": "json", "code": "unique.code", "data": null}]}

Get

POST /api/v1/object/data/get

Retrieve arbitrary data for an object.

Request parameters:

Name	Type	Value	Description
id	NUMERIC		Required. Object identifier.
type	NUMERIC		Variant. Data type identifier (takes priority over type code).
typecode	STRING	text, json, xml	Variant. Data type code.
code	STRING		Required. Data code.
fields	JSON array		Optional. JSON array of field names to return. If omitted, the request returns all fields.

Example:

Request:

POST /api/v1/object/data/get HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[truncated for brevity].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"id": 2, "typecode": "json", "code": "unique.code"}

List

POST /api/v1/object/data/list

Retrieve arbitrary data for an object as a list.

Request parameters: Common list request parameters

Example:

Request:

POST /api/v1/object/data/list HTTP/1.1
Host: localhost:8080
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.[truncated for brevity].NorYsi-Ht826HUFCEArVZ60_dEUmYiJYXubnTyweIMg

{"filter": {"object": 2, "typecode": "json", "code": "unique.code"}}