Skip to content
Baack

Entity

A content entity, similar to a page with a collection of content items of differing types

Browse the docs

Endpoints

  • GET/v/v1/entityview/{urn}

    Endpoint used for viewing rendered content entities with content items transformed. This endpoint is intended to be used by content clients and supports access via roles. See the PermissionRole endpoint for details of creating a role with read access to the entity. Multiple clients can then be assigned the role which mustuse the READ permission label. This allows client access from installed apps using a restricted API Client as company level access tokens have admin permissions.

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

    200 OK
    returns EntityREAD_SUCCESS
    404 Not found
    returns ErrorNOT_FOUND
    curl -H "Authorization: Bearer $BAACK_API_TOKEN" \
      https://api.baack.co/v/v1/entityview/{urn}
  • GET/n/v1/entity/{urn}

    Content entity endpoint with support for multiple content types associated with an entity. An Entity is analogous to a web page or screen in an app. The entity holds all content associated with a specific scope to render all content in a view. Entities are addressed with a UNIX style path selector. Entities support localisation and variants to support A/B content splits. Entities with variants overlay the default variant when selected on rendering. Entities also support the concept of publication state. When created entities are in a pre-publication draft state. Publication is handled by setting the state and publication time to allow for content to be scheduled for publication in the future. See the rendered entity endpoints for rendered views including template item expansion. This endpoint and associated items are intended for managing entities and their items rather than rendering the content.

    Parameters

    urn (path, required)
    String representation of a Unique Resource Name. Typically a UUID with 36 characters.

    Responses

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

Fields

Entity fields
FieldTypeDescription
ownerCompany

Required on create.

jsonsarray of JSON Item

Ignored on update.

imagesarray of Image Item

Ignored on update.

markdownsarray of Markdown Item

Ignored on update.

referencesarray of Reference Item

Ignored on update.

templatesarray of Template Item

Ignored on update.

latLongsarray of Latitude / Longitude item

Ignored on update.

languagestring

Required on create.

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.

updatedTimestampstring (date-time)
urlstring (uri)
urnstring (uuid)

Required on create.

Up to 36 characters.

longsarray of Long item

Ignored on update.

dateTimesarray of Date Time Item

Ignored on update.

textsarray of Text Item

Ignored on update.

moneyarray of Money Item

Ignored on update.

doublesarray of Double Item

Ignored on update.

publishTimestampstring (date-time)
namestring

Required on create.

Up to 1024 characters.

variantstring

Up to 128 characters.

booleansarray of Boolean Item

Ignored on update.

linksarray of Link Item

Ignored on update.

statusstring

Required on create.

One of: DRAFT_UNPUBLISHED, PUBLISH_PENDING, PUBLISH, PUBLISHED, PUBLISHED_WITH_DRAFTS

Used by: Boolean Item, Company, Date Time Item, Double Item, Entity List Item, Group, Image Item, JSON Item, Latitude / Longitude item, Link Item, Long item, Message Thread, Money Item, Reference Item, Search Item, Task, Template Item, Text Item