Skip to content
Baack

Content items

The typed values that make up a content entity: text, markdown, numbers, money, images and more, each with its history.

Browse the docs

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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/booleanitem/{urn}

Fields

Boolean Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyBoolean item history
valueboolean

Required on create.

entityEntity

Required on create.

urlstring (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/booleanitemhistory/{urn}

Fields

Boolean item history fields
FieldTypeDescription
itemBoolean Item
paginationPagination
historyarray of Boolean Item

Ignored on update.

urlstring (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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/datetimeitem/{urn}

Fields

Date Time Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyDate / Time item history
valuestring

Required on create.

urlstring (uri)
entityEntity

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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/datetimeitemhistory/{urn}

Fields

Date / Time item history fields
FieldTypeDescription
itemDate Time Item
paginationPagination
historyarray of Date Time Item

Ignored on update.

urlstring (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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/doubleitem/{urn}

Fields

Double Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyDouble Item History
valuenumber (double)

Required on create.

urlstring (uri)
entityEntity

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 HistoryREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/doubleitemhistory/{urn}

Fields

Double Item History fields
FieldTypeDescription
itemDouble Item
paginationPagination
historyarray of Double Item

Ignored on update.

urlstring (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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/imageitem/{urn}

Fields

Image Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

altTextstring

Up to 1024 characters.

srcstring (uri)

Up to 2048 characters.

mediumSrcstring (uri)

Up to 2048 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

largeSrcstring (uri)

Up to 2048 characters.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyImage item history
urlstring (uri)
entityEntity

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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/imageitemhistory/{urn}

Fields

Image item history fields
FieldTypeDescription
itemImage Item
paginationPagination
historyarray of Image Item

Ignored on update.

urlstring (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

    200 OK
    returns JSON ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/jsonitem/{urn}

Fields

JSON Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyJson item history
valueobject

Required on create.

Maximum length allowed for JSON string.

entityEntity

Required on create.

urlstring (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/jsonitemhistory/{urn}

Fields

Json item history fields
FieldTypeDescription
itemJSON Item
paginationPagination
historyarray of JSON Item

Ignored on update.

urlstring (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 itemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/latlongitem/{urn}

Fields

Latitude / Longitude item fields
FieldTypeDescription
urnstring (uuid)
isPublishedboolean
sortOrderinteger (int32)

Required on create.

latitudenumber (double)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 128 characters.

historyLat / Long item history
urlstring (uri)
entityEntity

Required on create.

longitudenumber (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/latlongitemhistory/{urn}

Fields

Lat / Long item history fields
FieldTypeDescription
itemLatitude / Longitude item
paginationPagination
historyarray of Latitude / Longitude item

Ignored on update.

urlstring (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

Link Item fields
FieldTypeDescription
urnstring (uuid)
isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Up to 1024 characters.

relstring
hrefstring (uri)

Required on create.

Up to 2048 characters.

textstring

Up to 1024 characters.

langstring

One of: ky-KG, ksh, yrl-Latn-BR, bas-CM, ar-TD, raj-IN, es-BO, ar-SY, es-BR, sw-Latn-TZ, sr-Latn-BA, ccp, sc-Latn-IT, es-BZ, zu-ZA, ff-Adlm-GW, ff-Adlm-GM, ff-Adlm-GN, ksh-Latn-DE, raj, ar-TN, bem-Latn-ZM, teo, hu-HU, yue-Hant-HK, es-CR, nmg-CM, es-CL, es-CO, pt-PT, bs-Latn, es-CU, ceb, pt-MZ, xh-Latn-ZA, xog-Latn-UG, rn-Latn-BI, xog, pt-MO, mzn, sr-Cyrl-XK, ga-Latn-IE, ff-Latn-BF, uz-UZ, ff-Adlm-GH, bo-CN, cv-RU, es-AR, sd-PK, vai-LR, am-ET, mr-IN, zh-Hans-MO, cgg, mg-MG, be-Cyrl-BY, es-Latn-ES, ar-PS, pt-ST, ia-Latn-001, sd-IN, ar-QA, chr, fur-Latn-IT, om-ET, kw-Latn-GB, kam-Latn-KE, ff-Adlm-LR, ckb-Arab-IQ, pt-TL, sah-RU, mni-Beng-IN, ff-GN, pcm, ar-SA, ar-SD, sn-Latn-ZW, ak-GH, be-TARASK, so-KE, uz-Cyrl-UZ, uz-Latn, ar-SO, yrl-CO, ar-SS, gd-Latn-GB, ckb, mgo-CM, ar-KW, dyo-Latn-SN, agq, gsw, en-150, zh-Hans-HK, ar-LB, az-Latn-AZ, to-Latn-TO, naq, ar-LY, ewo-CM, twq-NE, zgh-Tfng-MA, fi-Latn-FI, sr-Cyrl-RS, shi-Latn, luy-Latn-KE, sd-Arab-PK, no-Latn-NO, ar-MA, el-POLYTON, yav-Latn-CM, ff-Adlm-NE, ar-MR, guz, ff-Adlm-NG, ms-Latn-MY, dz-BT, is-IS, tok, dav-Latn-KE, ff-Adlm-MR, ro-MD, chr-US, sr-Latn-ME, gu-Gujr-IN, ar-OM, ar-001, my-Mymr-MM, kln-Latn-KE, nds, es-419, bgc-IN, kde-TZ, tt-Cyrl-RU, ug-Arab-CN, ccp-BD, cy-Latn-GB, vun, ast-Latn-ES, bm-Latn-ML, ff-Adlm, lag, to-TO, pis, fo-FO, yue-HK, rwk-Latn-TZ, sd-Deva, yi-001, mk-Cyrl-MK, jv-Latn-ID, vi-Latn-VN, smn-FI, br-Latn-FR, mi-NZ, shi-Tfng-MA, zh-Hans-CN, qu-Latn-PE, ar-IL, ro-RO, dsb-Latn-DE, mt-MT, rof, lt-LT, kkj-Latn-CM, ar-IQ, fa-Arab-IR, rof-TZ, ckb-IQ, fo-DK, ckb-IR, ann, ar-Arab-EG, sq-MK, om-KE, mer-KE, ar-JO, az-Latn, so-SO, ff-Adlm-SN, xh-ZA, ff-Adlm-SL, mg-Latn-MG, kde-Latn-TZ, ar-KM, kab-Latn-DZ, ewo, nmg-Latn-CM, se-Latn-NO, sbp-TZ, en-AE, en-AG, hsb-Latn-DE, hr-BA, uz-Latn-UZ, en-AI, el-GR, zh-Hans, nl-NL, zh-Hant, hi-Deva-IN, mni-IN, en-AT, en-AS, en-AU, so-Latn-SO, he-IL, ml-IN, en-BB, gv-Latn-IM, en-BE, es-SV, tt-RU, en-BI, en-BM, en-BS, en-BW, mas-TZ, fil-PH, en-BZ, xog-UG, es-PR, sl-Latn-SI, zh-MO, bas-Latn-CM, es-PY, twq, pa-Arab, ce-Cyrl-RU, lkt-Latn-US, mua-CM, ki-Latn-KE, ks-Arab, pa-Guru-IN, ca-AD, asa, ha-Latn-NG, mt-Latn-MT, yav, lg-Latn-UG, da-DK, fo-Latn-FO, ln-AO, tg-TJ, ast, pt-CV, ak-Latn-GH, sd-Arab, sr-Cyrl-ME, nmg, ses-Latn-ML, ko-Kore-KR, pt-CH, shi-Latn-MA, dua-Latn-CM, el-CY, haw, ksb-Latn-TZ, bs-BA, asa-TZ, ka-GE, kkj-CM, tzm, ln-CD, lo-Laoo-LA, nnh, nnh-Latn-CM, ln-CF, sa-Deva-IN, ln-CG, or-Orya-IN, yo-Latn-NG, hsb-DE, ii-Yiii-CN, nn-NO, es-PE, fa-IR, es-PH, es-PA, tr-TR, yrl-VE, vi-VN, yue-Hant, yue-Hans, bs-Cyrl-BA, kl-GL, luy-KE, kw-GB, ne-IN, rwk, pt-AO, lrc-Arab-IR, sah-Cyrl-RU, si-LK, jgo, lkt, wae, tzm-Latn-MA, ann-NG, pl-Latn-PL, mfe-MU, uz-AF, zh-HK, pt-BR, sr-RS, sv-FI, ha-NG, nl-SX, su-Latn, ha-NE, th-TH-u-nu-thai-x-lvariant-TH, es-MX, ml-Mlym-IN, nl-SR, pa-Guru, si-Sinh-LK, lkt-US, wo-Latn-SN, es-NI, mzn-IR, mas-KE, eu-Latn-ES, pt-GW, agq-CM, pt-GQ, dyo-SN, so-DJ, guz-KE, tk-TM, or-IN, bez-Latn-TZ, kea-Latn-CV, tr-Latn-TR, ccp-Cakm-BD, haw-US, ann-Latn-NG, eu-ES, sr-Cyrl-BA, pis-Latn-SB, sv-Latn-SE, bg-Cyrl-BG, ga-IE, cv-Cyrl-RU, uz-Arab-AF, bo-IN, es-HN, kln-KE, ks-Deva, ff-SN, so-ET, gl-ES, rm-CH, my-MM, cs-CZ, da-Latn-DK, es-IC, bs-Latn-BA, zh-TW, ur-Arab-PK, pt-Latn-BR, sk-SK, shi-MA, vun-Latn-TZ, bho-Deva-IN, sq-AL, ga-GB, sv-SE, ig-Latn-NG, uz-Cyrl, mn-MN, jmc, tok-001, uk-UA, as-Beng-IN, gu-IN, nus, ceb-Latn-PH, dav, hy-AM, ff-Adlm-CM, lrc, ja-JP, ar-YE, ne-NP, es-GT, rwk-TZ, sbp-Latn-TZ, es-GQ, pt-LU, zh-Hans-SG, wo-SN, eo-Latn-001, zh-SG, nds-DE, fa-AF, az-AZ, sms-FI, lb-Latn-LU, ast-ES, es-DO, frr-Latn-DE, mgo-Latn-CM, ha-GH, ku-TR, es-EC, kn-IN, sah, khq-ML, mr-Deva-IN, es-EA, saq, lrc-IR, lrc-IQ, sat, lag-Latn-TZ, es-ES, nyn-Latn-UG, bm-ML, mer-Latn-KE, ff-Adlm-BF, dsb-DE, sbp, wae-CH, nyn, eo-001, sw-TZ, luo, fil, ceb-PH, tk-Latn-TM, ks-Deva-IN, sw-UG, luy, agq-Latn-CM, bas, sr-CS, zh-Hant-MO, ksb-TZ, af, dua-CM, en-RW, ak, ru-UA, am, hu-Latn-HU, kab-DZ, yav-CM, ar, as, en-SB, en-SD, dz-Tibt-BT, en-SC, en-SE, km-Khmr-KH, cy-GB, en-SH, az, en-SG, mi-Latn-NZ, shi-Tfng, en-SI, en-SL, dav-KE, be, bg, af-ZA, de-Latn-DE, bm, bn, bo, br, qu-PE, bs, fr-GF, mas-Latn-KE, en-Latn-US, seh, de-IT, fr-GN, en-PG, fr-GQ, ps-PK, fr-GP, hr-Latn-HR, nnh-CM, en-PH, ca, en-PK, bo-Tibt-CN, ses, az-Cyrl, ce, en-PN, ko-KR, en-PR, en-PW, cs, ru-RU, yrl, cv, te-Telu-IN, ksh-DE, cy, ko-KP, seh-Latn-MZ, asa-Latn-TZ, az-Cyrl-AZ, vun-TZ, fr-HT, da, de, nl-BQ, yo-BJ, en-MP, en-MO, en-US-POSIX, nd-ZW, en-MT, kk-Cyrl-KZ, ses-ML, bem, en-MS, ja-Jpan-JP, en-MV, en-MU, nl-BE, en-MW, te-IN, en-MY, mdf-RU, ee-GH, luo-Latn-KE, naq-Latn-NA, bez, dz, en-NA, ms-ID, hi-IN, nl-AW, en-NG, en-NF, os-RU, se-FI, de-CH, dje, de-BE, ee, is-Latn-IS, ca-Latn-ES, en-NL, el, en, en-NR, en-NU, eo, fr-GA, guz-Latn-KE, vai-Vaii, es, et, eu, rw-RW, en-NZ, tr-CY, shi, hsb, nd-Latn-ZW, fa, fr-FR, zh-Hant-HK, bgc, ff, en-KI, fi, sat-Olck-IN, en-KN, yue, fo, oc-Latn-FR, fr, sl-SI, en-KY, fr-CD, fy, fr-CG, fr-CF, fr-CI, pa-IN, fr-CH, jgo-Latn-CM, en-LC, fr-CM, ga, nl-CW, gd, mdf-Cyrl-RU, de-DE, sr-BA, doi-IN, gl, fr-DZ, hi-Latn-IN, bho, und, en-LS, ka-Geor-GE, en-LR, gu, gv, it-IT, ur-IN, bn-BD, fr-DJ, sg-CF, ha, jmc-TZ, he, en-MH, en-MG, pa-PK, en-IE, hi, lu-CD, vai-Vaii-LR, ca-FR, en-IL, fur-IT, ms-MY, en-IN, en-IM, hr, en-IO, ja-JP-u-ca-japanese-x-lvariant-JP, yo-NG, dje-NE, hu, oc-ES, kam-KE, hy, teo-UG, ia, id, en-JE, ig, ii, en-JM, frr, is, as-IN, it, oc-FR, fy-NL, fr-CA, se-SE, pl-PL, yue-Hans-CN, fr-BF, fr-BE, ja, fr-BJ, fr-BI, fr-BL, doi, en-KE, ig-NG, en-GD, nus-Latn-SS, hr-HR, en-GH, en-GG, sq-Latn-AL, en-GI, en-GM, ewo-Latn-CM, jv, sr-ME, de-AT, yi-Hebr-001, en-GU, mai, smn, ka, en-GY, sms, sat-Olck, ki, mas, kk, kl, km, kn, ko, ca-IT, nds-NL, en-HK, ks, sn-ZW, ku, sv-AX, kw, ky, mgh-Latn-MZ, lag-TZ, en-001, lb, lg, fur, ln, naq-NA, ksf-CM, lo, lt, lu, kok-Deva-IN, lv, zh-CN, ur-PK, en-ER, ru-Cyrl-RU, ti-ET, lv-Latn-LV, ti-ER, da-GL, ca-ES-VALENCIA, mg, ff-Latn-SL, mi, am-Ethi-ET, ff-Latn-SN, mk, ml, se-NO, mn, mr, sat-IN, en-FI, ms, mt, en-FK, en-FJ, en-FM, my, bho-IN, mdf, dsb, ks-IN, nb, nd, ne, haw-Latn-US, ln-Latn-CD, it-CH, rof-Latn-TZ, en-GB, nl, ii-CN, nn, no, en-CA, id-Latn-ID, en-CC, en-CH, os-Cyrl-GE, vai-Latn-LR, en-CK, kab, en-CM, kok-IN, oc, kam, en-CX, es-US, en-CY, ku-Latn-TR, mer, af-NA, om, ca-ES, or, en-DE, os, en-DG, mzn-Arab-IR, es-UY, en-DK, es-VE, kea-CV, en-DM, he-Hebr-IL, kn-Knda-IN, mfe, sr-Latn, khq-Latn-ML, ms-SG, dua, pa, cs-Latn-CZ, doi-Deva-IN, rw-Latn-RW, mua-Latn-CM, pl, frr-DE, ps, pt, lg-UG, uk-Cyrl-UA, ta-IN, nyn-UG, mgh, sr-Latn-RS, gd-GB, mgo, mgh-MZ, nus-SS, mk-MK, tg-Cyrl-TJ, ps-Arab-AF, qu, fy-Latn-NL, ar-DJ, brx, gsw-CH, mfe-Latn-MU, kde, ce-RU, ar-EH, ar-EG, sg-Latn-CF, ar-DZ, ebu-KE, rm, rn, ki-KE, ro, nb-NO, ar-ER, ru, et-Latn-EE, rw, kea, sq-XK, saq-KE, sa, fr-Latn-FR, sc, ta-LK, sd, se, sg, si, sk, sl, sn, uz-Arab, kgp-BR, so, ru-BY, sq, sr, su, sv, sw, it-Latn-IT, fr-YT, ta, luo-KE, ps-AF, rm-Latn-CH, sd-Deva-IN, te, nn-Latn-NO, tg, th, ti, tk, pis-SB, dyo, to, bez-TZ, tr, gsw-FR, tt, lv-LV, qu-EC, ug, ccp-IN, kgp, uk, lu-Latn-CD, hy-Armn-AM, tok-Latn-001, ur, fr-WF, tzm-MA, uz, ff-Latn-LR, kl-Latn-GL, nb-Latn-NO, el-Grek-GR, fr-VU, vi, khq, mni-Beng, gsw-Latn-CH, pa-Arab-PK, fr-TD, fr-TG, ff-Latn-MR, fr-TN, ar-AE, vai-Latn, fil-Latn-PH, cgg-UG, fr-SY, wo, zgh, teo-KE, saq-Latn-KE, sw-CD, ar-BH, kk-KZ, mni, su-ID, br-FR, xh, gl-Latn-ES, teo-Latn-UG, yue-CN, id-ID, qu-BO, ff-Latn-NE, ff-Latn-NG, th-TH, rn-BI, ro-Latn-RO, ff-Latn-GH, sk-Latn-SK, zu-Latn-ZA, fr-RE, ff-Latn-GM, lt-Latn-LT, ff-Latn-GN, mai-Deva-IN, en-ZA, kkj, no-NO, yi, en-ZM, yo, raj-Deva-IN, yrl-BR, mai-IN, nl-Latn-NL, ru-MD, wae-Latn-CH, af-Latn-ZA, vai, en-ZW, fr-SC, su-Latn-ID, gv-IM, bgc-Deva-IN, pcm-Latn-NG, ug-CN, nb-SJ, kln, fr-SN, zh, ff-Latn-GW, jv-ID, gsw-LI, os-GE, fr-RW, ta-SG, zu, zh-Hant-TW, en-WS, ru-KZ, fr-PF, hi-Latn, pcm-NG, ky-Cyrl-KG, sc-IT, ta-Taml-IN, fr-PM, brx-IN, nds-Latn-DE, bg-BG, ru-KG, ne-Deva-NP, lb-LU, ia-001, mn-Cyrl-MN, ebu-Latn-KE, it-VA, ee-Latn-GH, sr-Cyrl, seh-MZ, ebu, om-Latn-ET, smn-Latn-FI, ee-TG, en-US, ta-MY, jgo-CM, sa-IN, kok, fr-NC, fr-NE, ff-Latn-CM, dje-Latn-NE, jmc-Latn-TZ, en-VC, fr-ML, en-VG, fr-MQ, cgg-Latn-UG, en-VI, fr-MR, fr-MU, en-VU, bem-ZM, be-BY, bs-Cyrl, mua, et-EE, ksf-Latn-CM, ks-Arab-IN, km-KH, fi-FI, it-SM, sr-Latn-XK, sms-Latn-FI, en-SS, en-SX, kgp-Latn-BR, en-SZ, zgh-MA, bn-IN, en-TC, fr-KM, ff-Latn, en-TK, lo-LA, bn-Beng-BD, en-TO, ti-Ethi-ET, fr-MA, en-TT, de-LI, fr-MC, en-TV, ms-BN, sw-KE, fr-MG, chr-Cher-US, en-TZ, fr-MF, twq-Latn-NE, brx-Deva-IN, en-UG, th-Thai-TH, de-LU, fr-LU, ksb, en-UM, ksf

Up to 16 characters.

entityEntity

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

Link Item History fields
FieldTypeDescription
itemLink Item
paginationPagination
historyarray of Link Item

Ignored on update.

urlstring (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

    200 OK
    returns Long itemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/longitem/{urn}

Fields

Long item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyLong item history
valuenumber (int64)

Required on create.

entityEntity

Required on create.

urlstring (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/longitemhistory/{urn}

Fields

Long item history fields
FieldTypeDescription
itemLong item
paginationPagination
historyarray of Long item

Ignored on update.

urlstring (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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/markdownitem/{urn}

Fields

Markdown Item fields
FieldTypeDescription
urnstring (uuid)
isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyMarkdown item history
valuestring

Required on create.

Up to 65535 characters.

entitystring (uuid)

Required on create.

urlstring (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/markdownitemhistory/{urn}

Fields

Markdown item history fields
FieldTypeDescription
itemMarkdown Item
paginationPagination
historyarray of Markdown Item

Ignored on update.

urlstring (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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/moneyitem/{urn}

Fields

Money Item fields
FieldTypeDescription
urnstring (uuid)
isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

formattedValuestring
currencySymbolstring
currencyCodestring

Required on create.

One of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BYR, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EEK, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SKK, SLE, SLL, SOS, SRD, STN, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VEF, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZMK, ZWD

urlstring (uri)
entityEntity

Required on create.

unitValuenumber (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/moneyitemhistory/{urn}

Fields

Money item history fields
FieldTypeDescription
itemMarkdown Item
paginationPagination
historyarray of Markdown Item

Ignored on update.

urlstring (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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/referenceitem/{urn}

Fields

Reference Item fields
FieldTypeDescription
urnstring (uuid)
entityReferenceEntity

Required on create.

createdTimestampstring (date-time)
sortOrderinteger (int32)

Required on create.

namestring

Required on create.

urlstring (uri)
entityEntity

Required on create.

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 ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/templateitem/{urn}

Fields

Template Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

valuestring

Required on create.

Up to 65535 characters.

entityEntity

Required on create.

urlstring (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 historyREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/templateitemhistory/{urn}

Fields

Template item history fields
FieldTypeDescription
itemLong item
paginationPagination
historyarray of Text Item

Ignored on update.

urlstring (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

    200 OK
    returns Text ItemREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/textitem/{urn}

Fields

Text Item fields
FieldTypeDescription
urnstring (uuid)

Up to 36 characters.

isPublishedboolean
sortOrderinteger (int32)

Required on create.

createdTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

historyText Item History
valuestring

Required on create.

Up to 65535 characters.

entityEntity

Required on create.

urlstring (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 HistoryREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/n/v1/textitemhistory/{urn}

Fields

Text Item History fields
FieldTypeDescription
itemText Item
paginationPagination
historyarray of Text Item

Ignored on update.

urlstring (uri)

Used by: Text Item