Content items – Baack docs
Content items
The typed values that make up a content entity: text, markdown, numbers, money, images and more, each with its history.
Boolean Item
A boolean content item associatedwith a content entity
Endpoints
GET/n/v1/booleanitem/{urn}
Boolean (truthy) value item endpoint with support for managing boolean content items associated with an entity.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Boolean Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/booleanitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Boolean item history | |
| value | boolean | Required on create. |
| entity | Entity | Required on create. |
| url | string (uri) |
Used by: Boolean item history, Entity
Boolean item history
Representation of the history of a boolean (truthy) content item value
Endpoints
GET/n/v1/booleanitemhistory/{urn}
Endpoint for boolean (truthy) content item history access and live version selection
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Boolean item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/booleanitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Boolean Item | |
| pagination | Pagination | |
| history | array of Boolean Item | Ignored on update. |
| url | string (uri) |
Used by: Boolean Item
Date Time Item
Date time represented as ISO 8601 with milliseconds
Endpoints
GET/n/v1/datetimeitem/{urn}
Date time item endpoint with support for managing date time items associated with an entity.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Date Time Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/datetimeitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Date / Time item history | |
| value | string | Required on create. |
| url | string (uri) | |
| entity | Entity | Required on create. |
Used by: Date / Time item history, Entity
Date / Time item history
Representation of a date / time timestamp (UTC) item value history
Endpoints
GET/n/v1/datetimeitemhistory/{urn}
Endpoint for date/time timestamp content item history and live version selection
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Date / Time item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/datetimeitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Date Time Item | |
| pagination | Pagination | |
| history | array of Date Time Item | Ignored on update. |
| url | string (uri) |
Used by: Date Time Item
Double Item
A double precision content item associated with a content entity
Endpoints
GET/n/v1/doubleitem/{urn}
Double precision floating point value endpoint for managing floating point values associated with an entity.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Double Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/doubleitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Double Item History | |
| value | number (double) | Required on create. |
| url | string (uri) | |
| entity | Entity | Required on create. |
Used by: Double Item History, Entity
Double Item History
The history of values of a double item
Endpoints
GET/n/v1/doubleitemhistory/{urn}
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Double Item History
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/doubleitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Double Item | |
| pagination | Pagination | |
| history | array of Double Item | Ignored on update. |
| url | string (uri) |
Used by: Double Item
Image Item
Object representing an image resource
Endpoints
GET/n/v1/imageitem/{urn}
Image item endpoint with support for creating image items with associated image assets. Images are posted separately via the imageitemfile endpoint once the image item is created. Files associated with the image item support multiple size formats.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Image Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/imageitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| altText | string | Up to 1024 characters. |
| src | string (uri) | Up to 2048 characters. |
| mediumSrc | string (uri) | Up to 2048 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| largeSrc | string (uri) | Up to 2048 characters. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Image item history | |
| url | string (uri) | |
| entity | Entity | Required on create. |
Used by: Entity, Image item history
Image item history
Representation of the history of an image content item
Endpoints
GET/n/v1/imageitemhistory/{urn}
Endpoint for image item content history retrieval and live version selection
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Image item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/imageitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Image Item | |
| pagination | Pagination | |
| history | array of Image Item | Ignored on update. |
| url | string (uri) |
Used by: Image Item
JSON Item
Representation of a JSON content entity for arbitrary JSON values
Endpoints
GET/n/v1/jsonitem/{urn}
Endpoint for managing JSON items associated with an entity.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/jsonitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Json item history | |
| value | object | Required on create. Maximum length allowed for JSON string. |
| entity | Entity | Required on create. |
| url | string (uri) |
Used by: Entity, Json item history
Json item history
Representation of the history of a JSON item
Endpoints
GET/n/v1/jsonitemhistory/{urn}
Endpoint for reviewing and managing the history of JSON content item values
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Json item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/jsonitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | JSON Item | |
| pagination | Pagination | |
| history | array of JSON Item | Ignored on update. |
| url | string (uri) |
Used by: JSON Item
Latitude / Longitude item
Latitude / Longitude content item associated with an entity
Endpoints
GET/n/v1/latlongitem/{urn}
Latitude / Longitude content endpoint used for creating points or lines with latitude longitude values.Creation of a polygon can be achieved by creating multiple points with a sort order for sequencing.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Latitude / Longitude item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/latlongitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| latitude | number (double) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 128 characters. |
| history | Lat / Long item history | |
| url | string (uri) | |
| entity | Entity | Required on create. |
| longitude | number (double) | Required on create. |
Used by: Entity, Lat / Long item history
Lat / Long item history
Representation of the history of lat / long content item history
Endpoints
GET/n/v1/latlongitemhistory/{urn}
Endpoint for accessing the history of a latitude / longitude item and picking the live version
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Lat / Long item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/latlongitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Latitude / Longitude item | |
| pagination | Pagination | |
| history | array of Latitude / Longitude item | Ignored on update. |
| url | string (uri) |
Used by: Latitude / Longitude item
Link Item
Representation of a link content item associated with a content entity. Links have specific type and attribute fields to support fully modelling links in different contexts
Endpoints
GET/n/v1/linkitem/{urn}
A link with support for href, text and rel e.g. nofollow or author links. This item is intended to make it easy to model links both as document links and other reference links like canonical links.
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/linkitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Up to 1024 characters. |
| rel | string | |
| href | string (uri) | Required on create. Up to 2048 characters. |
| text | string | Up to 1024 characters. |
| lang | string | One of: Up to 16 characters. |
| entity | Entity | Required on create.Ignored on update. |
Used by: Entity, Link Item History
Link Item History
Representation of the history of a link content item
Endpoints
GET/n/v1/linkitemhistory/{urn}
Endpoint for retrieving and managing the history of a link item
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/linkitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Link Item | |
| pagination | Pagination | |
| history | array of Link Item | Ignored on update. |
| url | string (uri) |
Long item
Representation of a long integer item
Endpoints
GET/n/v1/longitem/{urn}
Endpoint for managing long integer value items
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/longitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Long item history | |
| value | number (int64) | Required on create. |
| entity | Entity | Required on create. |
| url | string (uri) |
Used by: Entity, Long item history, Template item history
Long item history
Representation of the history of a long integer content item. Note that history is returned from newest to oldest value
Endpoints
GET/n/v1/longitemhistory/{urn}
Long integer content item history endpoint.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Long item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/longitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Long item | |
| pagination | Pagination | |
| history | array of Long item | Ignored on update. |
| url | string (uri) |
Used by: Long item
Markdown Item
A markdown item value associated with a particular entity
Endpoints
GET/n/v1/markdownitem/{urn}
Endpoint for managing markdown items associated with an entity
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Markdown Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/markdownitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Markdown item history | |
| value | string | Required on create. Up to 65535 characters. |
| entity | string (uuid) | Required on create. |
| url | string (uri) |
Used by: Entity, Markdown item history, Money item history
Markdown item history
Representation of the markdown item history. Note that the history is ordered from newest to oldest and may be paginated.
Endpoints
GET/n/v1/markdownitemhistory/{urn}
Endpoint for retrieving the history of markdown content items and picking the live version
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Markdown item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/markdownitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Markdown Item | |
| pagination | Pagination | |
| history | array of Markdown Item | Ignored on update. |
| url | string (uri) |
Used by: Markdown Item
Money Item
A money value item in the context of a content entity
Endpoints
GET/n/v1/moneyitem/{urn}
Monetary value items endpoint used for creating money values associated with a content entity.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Money Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/moneyitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| formattedValue | string | |
| currencySymbol | string | |
| currencyCode | string | Required on create. One of: |
| url | string (uri) | |
| entity | Entity | Required on create. |
| unitValue | number (int64) | Required on create. |
Used by: Entity
Money item history
Representation of a money content item history
Endpoints
GET/n/v1/moneyitemhistory/{urn}
Endpoint for accessing money content item historical values and pick the live version.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Money item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/moneyitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Markdown Item | |
| pagination | Pagination | |
| history | array of Markdown Item | Ignored on update. |
| url | string (uri) |
Reference Item
Content item used to refer to another content entity for example the author or another content entity for part of a page which is shared across multiple pages.
Endpoints
GET/n/v1/referenceitem/{urn}
Endpoint for managing references from one entity via a reference content item to another entity e.g. a reference to the author or the navigation content
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Reference Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/referenceitem/{urn}
Fields
Used by: Entity
Template Item
Object representing a template content item associated with a content entity
Endpoints
GET/n/v1/templateitem/{urn}
Template content item endpoint with support for managing templates which are translated on rendering endpoint calls using the entity context and other included resources.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Template Item
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/templateitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| value | string | Required on create. Up to 65535 characters. |
| entity | Entity | Required on create. |
| url | string (uri) |
Used by: Entity
Template item history
Representation of the history of a template item values
Endpoints
GET/n/v1/templateitemhistory/{urn}
Endpoint for accessing the template content item history
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Template item history
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/templateitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Long item | |
| pagination | Pagination | |
| history | array of Text Item | Ignored on update. |
| url | string (uri) |
Text Item
A text content item associated with a content entity
Endpoints
GET/n/v1/textitem/{urn}
Text content items endpoint with support for managing text items associated with an entity.
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/textitem/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | Up to 36 characters. |
| isPublished | boolean | |
| sortOrder | integer (int32) | Required on create. |
| createdTimestamp | string (date-time) | |
| name | string | Required on create. Up to 1024 characters. |
| history | Text Item History | |
| value | string | Required on create. Up to 65535 characters. |
| entity | Entity | Required on create. |
| url | string (uri) |
Used by: Entity, Template item history, Text Item History
Text Item History
Representation of the history of a text item including all of the revisions stored which may be paged if they exceed the maximum per response.
Endpoints
GET/n/v1/textitemhistory/{urn}
Endpoint for accessing the text item content history and picking the live version
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Text Item History
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/textitemhistory/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| item | Text Item | |
| pagination | Pagination | |
| history | array of Text Item | Ignored on update. |
| url | string (uri) |
Used by: Text Item