Entity List – Baack docs
Entity List
Entity list for a collection of entity references. Note that the returned entity list on read will respect the natural ordering of the entity order sort order field
Browse the docs
Endpoints
GET/n/v1/entitylist/{urn}
Entity list endpoint that is used for creating collections of entities e.g. for a blog listing.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Entity List
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/entitylist/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| owner | Company | Required on create. |
| entities | array of Entity List Item | Required on create. |
| name | string | Required on create. |
| url | string (uri) |
Used by: Search Item
Entity List Item
Entity list item reference and sorting order
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| sortOrder | integer (int32) | |
| entity | Entity | Required on create. |
Used by: Entity List