Table of contents

Schema: homepage

Frontend schema

This schema describes the content item that is returned from the content store.

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
content_id
string

content_purpose_document_supertype
string
DEPRECATED. Use `content_purpose_subgroup`.
content_purpose_subgroup
string
Document subgroup grouping documents by purpose. Narrows down the purpose defined in content_purpose_supergroup.
content_purpose_supergroup
string
Document supergroup grouping documents by a purpose
description
or null

details
object
change_history
array

document_type
string

Allowed values: homepage, service_manual_homepage
email_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
first_published_at
or null

government_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
links
object
available_translations
Link type automatically added by Publishing API
child_taxons
Link type automatically added by Publishing API
children
Link type automatically added by Publishing API
document_collections
Link type automatically added by Publishing API
level_one_taxons
Link type automatically added by Publishing API
part_of_step_navs
Link type automatically added by Publishing API
policies
Link type automatically added by Publishing API
policy_areas
A largely deprecated tag currently only used to power email alerts.
related_to_step_navs
Link type automatically added by Publishing API
topic_taxonomy_taxons
Link type automatically added by Publishing API
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
navigation_document_supertype
string
Document type grouping powering the new taxonomy-based navigation pages
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
public_updated_at
or null

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, search-admin, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
publishing_scheduled_at
or null

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: homepage
search_user_need_document_supertype
string
Document supertype grouping core and government documents
title
string

updated_at
string

user_journey_document_supertype
string
Document type grouping powering analytics of user journeys
user_need_document_supertype
string
DEPRECATED. Use `content_purpose_document_supertype`.
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": "ac in, interdum. Sed ac Quisque bibendum. pellentesque aliquet. est. Duis tempor libero. tempor vel Nam molestie fames scelerisque. dolor morbi dolor eu Aenean habitant nisl volutpat nibh elit. risus porttitor Ut et at mauris orci consectetur finibus, malesuada Lorem Suspendisse cursus leo suscipit eros. senectus sagittis sollicitudin Pellentesque interdum. eu sem vestibulum. sit non massa non nibh. Mauris molestie ac risus a egestas. sed imperdiet ipsum adipiscing vel hendrerit, ac amet, purus tristique et lectus turpis Ut lorem ultricies Nam netus tristique",
  "base_path": "/5b0e5d62-49b2-43b7-a7e3-f2d97ca9db19/cefe09ae-e002-49ba-8e23-05ead08c9da8/47117d86-6b64-4836-9e23-2b1b6f8c378a",
  "content_id": "c2d14032-f378-49d9-80fa-a09d134ab717",
  "content_purpose_document_supertype": "leo bibendum. nibh. ac Mauris ipsum volutpat adipiscing purus risus nisl consectetur Quisque eros. sollicitudin sem turpis",
  "content_purpose_subgroup": "pellentesque eu senectus lorem tempor volutpat hendrerit, massa cursus Duis consectetur sagittis ac interdum. nibh. suscipit elit. fames adipiscing molestie finibus, Nam Mauris netus porttitor habitant imperdiet ac interdum. malesuada in,",
  "content_purpose_supergroup": "interdum. a eu finibus, elit. pellentesque vel non sagittis leo non ac lorem ac aliquet. bibendum. vel purus malesuada et in, at nibh. Mauris ac molestie est. risus sed turpis adipiscing Ut morbi sem netus cursus Sed fames eu Nam tempor sit ultricies senectus volutpat ac vestibulum. Nam risus Aenean habitant molestie amet, Duis tristique egestas. nisl Quisque sollicitudin dolor scelerisque. suscipit tempor dolor imperdiet lectus Lorem consectetur et ipsum mauris orci Pellentesque porttitor eros. massa libero. nibh Ut",
  "description": "tempor sem porttitor Pellentesque finibus, risus sit nibh leo a nibh. sed volutpat libero.",
  "details": {
  },
  "document_type": "service_manual_homepage",
  "email_document_supertype": "libero. turpis lorem morbi Mauris netus leo sit molestie sagittis est. imperdiet Nam interdum. malesuada non massa mauris tempor amet, Suspendisse aliquet. in, scelerisque. nibh. dolor orci vestibulum. sollicitudin",
  "first_published_at": "2018-04-25T14:50:46+00:00",
  "government_document_supertype": "ac Sed adipiscing interdum. Ut a vel risus ac eros. pellentesque massa sit morbi Lorem tristique non scelerisque. Mauris risus purus suscipit ac orci libero. egestas. non sagittis vestibulum. netus in, amet, sed volutpat fames interdum. porttitor Quisque Duis malesuada lectus Pellentesque dolor eu ipsum nisl eu at aliquet. est. turpis sem Aenean et senectus bibendum. Nam nibh. ac Nam molestie tempor ultricies nibh leo sollicitudin Ut vel lorem elit. tempor habitant finibus, consectetur hendrerit, Suspendisse imperdiet mauris",
  "links": {
    "child_taxons": [
      {
        "api_path": "/6796e562-60ec-4c37-baa3-2d8f511c0fce",
        "base_path": "/8ad59971-8f16-415b-9148-e4719ad18400/fe3ba471-11a4-4647-8ae2-d222085cc8f0/64e7ffdc-19ce-4e18-9026-98cbfaf3dcd3/175875a3-e05d-4dc1-845d-be3eed841e67",
        "content_id": "f63ea33a-c4eb-42d4-87ac-7bbe0d3eda49",
        "document_type": "netus vel interdum. eros. mauris cursus libero. molestie sed ac nisl et sem Lorem tempor aliquet. ac est. Ut morbi non tempor",
        "locale": "et",
        "title": "sagittis risus morbi est. in, nibh. non eu Ut amet, habitant non vel consectetur Lorem ac fames Sed vel Nam tempor tempor volutpat hendrerit, netus et ac sed Ut pellentesque massa Nam molestie scelerisque. interdum. tristique et a egestas. at ac nibh interdum. lectus bibendum. vestibulum. orci Pellentesque lorem leo ac turpis Quisque eros. molestie mauris nisl ultricies sollicitudin Mauris Duis cursus finibus, adipiscing suscipit ipsum aliquet. risus elit. dolor purus libero. Suspendisse tristique eu Aenean sem malesuada imperdiet dolor"
      },
      {
        "api_path": "/a7ec58a8-e633-4d93-b5b9-dea89149ab4a/118dcf32-63aa-4519-a60d-d8cac7b86555/00a95895-d819-48d6-aeb6-d08bfa0ea04b",
        "api_url": "http://example.com/bd64af44-9b8d-4d26-bb72-9cba34d33d62/3f70802c-b2be-47b8-86d3-86168680740d/e49d7196-3990-4f6f-8938-5a612a9ae7a0/d1f75ba7-6eec-47ce-b078-a30b1683d161#bdac646854032844fd07a901b082f13e",
        "base_path": "/5547d9c3-dd93-4439-b63a-4407460523a5/b7bec3fa-c759-4e7e-9f3b-5ef81ea9b2b8/ff946a84-982a-4f88-9450-eed8f226ebf2/bbd7bade-7328-4b96-bc2a-6f9c2b4f1fd1/640af1ea-f5b6-4407-a27e-a201b0f714da",
        "content_id": "cc66e651-6926-4678-9645-adfab037573a",
        "document_type": "vel scelerisque. Aenean Pellentesque ac netus tristique morbi at eros. Nam",
        "locale": "ps",
        "schema_name": "Nam vel vestibulum. hendrerit, habitant Sed purus morbi eu Suspendisse molestie Pellentesque sit sollicitudin non adipiscing Ut pellentesque tristique tempor risus Ut vel bibendum. Duis sem sed ac lorem in, porttitor tempor eu at nisl aliquet. elit. scelerisque. nibh. ac ac malesuada interdum. fames Aenean nibh netus orci cursus tristique mauris suscipit consectetur",
        "title": "turpis netus vel nibh risus tristique Nam suscipit Ut tempor vestibulum. ac fames risus tristique eu non Duis et dolor aliquet. interdum. imperdiet Aenean Lorem ac volutpat Mauris scelerisque. at elit. porttitor hendrerit, ac finibus, sem tempor sed molestie nibh. ipsum consectetur sagittis a Quisque bibendum. pellentesque egestas. eu morbi orci massa libero. mauris non Ut dolor ac purus sit in, vel senectus cursus lorem Suspendisse molestie interdum. est. leo adipiscing amet, habitant ultricies nisl Nam lectus sollicitudin eros. Pellentesque et Sed malesuada",
        "web_url": "http://example.com/d771840b-96c7-4db5-a77d-d792cefb44e2#24eeee9ed703a82e47b4195278f5a797"
      },
      {
        "api_path": "/5cc1a4ee-59bd-4ed9-b291-df5dc0d0c4ed/0a5c694d-09d5-49ad-9fa7-229decaca57f/731e6b2f-62a2-451c-be6b-b7f5e937d68f/ab14c18b-5ffe-48f7-99c1-2265069f0b9a",
        "base_path": "/b3d0f049-499d-49dc-bed5-ca226fb34c29/19e2fc10-d3f5-4af0-a84b-364fb8d42c16/c3adf11d-95f0-4311-b12b-14151d5379bf/e92c934b-7af4-4854-ad7d-a96f8d7910d2",
        "content_id": "2d497fd1-b2cc-4cf6-8a02-360c7c676712",
        "document_type": "fames morbi finibus, imperdiet nibh. Mauris orci adipiscing scelerisque. suscipit porttitor tristique malesuada massa eu mauris eros.",
        "links": {
        },
        "locale": "zh-tw",
        "public_updated_at": null,
        "schema_name": "tempor volutpat netus massa egestas. ac Pellentesque aliquet. est. sit suscipit Lorem dolor nibh. libero. a Ut sagittis porttitor nisl eu senectus finibus, non vel at molestie non ultricies mauris vestibulum. Mauris ac ipsum pellentesque risus Sed elit. hendrerit, orci sed cursus sem Suspendisse nibh Nam scelerisque. Nam tempor Ut et imperdiet vel interdum. eros. amet, et tristique ac adipiscing fames eu in, morbi Duis lectus Aenean dolor leo risus consectetur Quisque tristique turpis habitant purus",
        "title": "Aenean non vel sollicitudin lorem aliquet. nisl egestas. molestie Quisque senectus Lorem suscipit finibus, ac purus Mauris interdum. habitant Ut eu bibendum. cursus sit nibh. dolor vestibulum. eros. consectetur Duis sagittis dolor Pellentesque Nam pellentesque risus libero. non eu leo mauris massa Nam a tempor nibh interdum. lectus ac turpis imperdiet hendrerit, tristique risus ultricies ipsum Ut ac amet, est. tristique ac sed fames adipiscing et"
      },
      {
        "analytics_identifier": null,
        "api_path": "/7fbbfdff-38e5-49a5-8e35-4d1b857edd10",
        "base_path": "/cfb48d7d-da22-42e1-8bc0-b59efec74cfc/0a3a3c97-0b3e-493d-a422-b2dab2173185/15040ff8-00ac-4d24-a072-ceecddfdd281/9fa3e8eb-52d9-4b9d-9be5-de53d28a193c/c17df8c7-1b03-4df3-b75a-3481d09e9f3d",
        "content_id": "89a7445c-843f-47ee-8748-41e92bda16ce",
        "locale": "lv",
        "public_updated_at": null,
        "schema_name": "ac nibh. at volutpat est. vestibulum. dolor et sollicitudin leo risus interdum. fames non sit tristique Nam Lorem Ut Mauris Duis malesuada lectus hendrerit, interdum. Quisque molestie vel ac ac cursus egestas. Nam orci morbi purus non turpis amet, imperdiet porttitor Aenean et in, eros. nibh ipsum tristique libero. eu molestie massa sem ultricies senectus elit. nisl Suspendisse tempor scelerisque. dolor netus sed Pellentesque vel suscipit Sed bibendum. pellentesque risus mauris habitant consectetur aliquet. finibus, ac tempor a",
        "title": "malesuada purus risus a interdum. Pellentesque leo finibus, Ut eros. aliquet. tristique Sed volutpat ipsum orci risus Suspendisse adipiscing tempor molestie sed Nam sem ac dolor scelerisque. non in, et Quisque vestibulum. nibh Nam egestas. tempor morbi pellentesque porttitor molestie ac vel ac senectus vel Duis netus ultricies sagittis nibh. tristique nisl",
        "web_url": "http://example.com/8a3bff3e-e993-4a17-9619-debec6d5b78b/679ad41c-e214-4833-9b3c-f469af620e99/404c5547-0f3c-4b16-abad-d988b5fb146f/d7b32323-a58f-420e-92f1-ab234be0f962#b0636fef283bef4cdb817359abdcd05e"
      }
    ],
    "policies": [
      {
        "base_path": "/eba1f4e2-60ad-402e-a5cb-419ce28cd80d/6a1b10b6-69ed-4514-86be-8f0028afa721/43f9c7d1-21d3-4de8-bac5-0a8057684061/6eddfa5c-9f8b-4b86-a648-2b052ac406eb",
        "content_id": "95328285-5f4d-4490-bfb7-5ad6d7f22823",
        "document_type": "nibh. netus lorem amet, bibendum. molestie adipiscing est. eu sagittis fames vestibulum. nibh habitant ipsum sem porttitor dolor turpis Pellentesque Mauris ac ultricies scelerisque. pellentesque Aenean eu morbi",
        "links": {
        },
        "locale": "ko",
        "public_updated_at": "2018-07-11T10:50:08+00:00",
        "title": "ac turpis interdum. Duis Aenean adipiscing tempor non dolor ultricies eros. tempor Ut habitant egestas. sem massa ac fames et ac nibh risus aliquet. porttitor ipsum Sed dolor volutpat nibh. a Pellentesque pellentesque eu hendrerit, consectetur lectus Mauris scelerisque. bibendum. suscipit non sit morbi finibus, tristique Quisque",
        "web_url": "http://example.com/986b7586-56ba-449d-af68-62bba343e521/0d1e05a6-a800-46be-8f38-88f9f62d5600#8b80d2984912c2851b685d79ace9f5e6"
      }
    ],
    "related_to_step_navs": [
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/827785f5-7b82-49a2-a1ed-59a6ea289e05/9101b670-3267-4ae0-962b-320095d431e3/63a5c7db-4902-463f-ac63-2d6340120c06/16ec7edb-da12-4bbd-9fa0-2ee3aa09c70c/534885d3-937f-4a1a-9318-faec68fcf4ea#6a4d05897d9a2fc1fe63970640649610",
        "base_path": "/a1266617-9361-4089-a5d3-651a66e62ed7/6b6d6874-ea93-48fc-9e62-3de337e2b2c6/40b13907-770f-4008-b428-3626bd7639d4/7445ebfe-75d9-4597-ad94-29cbd760774c",
        "content_id": "32bdebe1-2cee-486b-8c18-375324c58cb6",
        "links": {
        },
        "locale": "zh-tw",
        "schema_name": "Ut interdum. ac bibendum. suscipit nibh. Quisque Ut mauris molestie Suspendisse libero. purus a tristique ac sed lectus massa molestie ac amet,",
        "title": "orci ac purus Pellentesque a finibus, eros. cursus et ac at interdum. lectus morbi vestibulum. massa aliquet. risus ac Suspendisse libero. risus molestie volutpat scelerisque. leo vel dolor bibendum. sit Sed amet, lorem tempor nisl dolor malesuada",
        "web_url": "http://example.com/e082d92c-dc17-4785-b058-a56ee32953cd/9fdd0930-06cc-4897-9b9e-51bb158e53a6/e60b6a86-dabe-4bda-bf18-0bd18cc9ccfb/77eb8399-cf02-49a7-8e84-71a21197af04#0e38d1a09865e05d56a99264d9846922"
      },
      {
        "analytics_identifier": "Mauris suscipit nibh. vel dolor cursus orci bibendum. Duis libero. risus turpis adipiscing fames leo ipsum scelerisque. Quisque et in, sagittis risus sed sollicitudin Sed ac non",
        "api_url": "http://example.com/46ba7424-ed93-4f4a-bb16-50336ac998dc/bac09992-631a-4fef-ae58-a662058426d6/60886da2-5da8-44e7-a8c1-0fcda60240c4#c0df7e26475fce3e507e71233760ab15",
        "base_path": "/37777662-89b6-46a8-809b-4a95b4d880b6",
        "content_id": "6b5bd865-c50a-40d8-8935-f0b459d46f68",
        "links": {
        },
        "locale": "ka",
        "public_updated_at": null,
        "schema_name": "Mauris sit tempor pellentesque malesuada sem eu netus ipsum Aenean tristique imperdiet risus libero. ac molestie tristique dolor lectus elit. ultricies et risus Quisque scelerisque. sed senectus aliquet. purus et lorem egestas. morbi mauris est. ac orci fames hendrerit, sagittis ac molestie at vel eros. cursus Lorem porttitor finibus, interdum. nibh a leo ac vel Nam in, dolor Nam suscipit bibendum. eu volutpat adipiscing massa vestibulum. habitant tempor Duis",
        "title": "elit. ac Nam purus morbi tristique nibh. est. ultricies lectus in, interdum. pellentesque sem nisl vel Quisque sed ipsum libero. amet, dolor imperdiet adipiscing ac Duis volutpat sollicitudin dolor egestas. risus non turpis mauris nibh Sed fames eros. porttitor et netus eu leo Mauris Ut sagittis malesuada interdum. Aenean non et finibus, hendrerit, molestie consectetur molestie lorem Pellentesque Lorem risus sit tempor ac a vel at bibendum. tempor ac orci scelerisque. suscipit Suspendisse eu Ut Nam tristique habitant massa senectus"
      },
      {
        "base_path": "/d4f94f6f-ef0c-408c-9344-bc70c98af35e/a7aee338-2a61-4a4d-91ca-4ddd9ab0b070/c68914f7-4d56-4dd3-8e28-376f73052055/7b11d0a1-1081-4e43-a1a1-407f9f12ee93/0a12d8a5-1b29-4ebf-b4e7-4051215fe366",
        "content_id": "003a2bdc-cfe9-4572-a35e-c813f9e553d5",
        "links": {
        },
        "locale": "sr",
        "public_updated_at": "2018-07-15T20:32:23+00:00",
        "title": "tempor",
        "web_url": "http://example.com/c4ea5a75-d2da-4e56-9a80-8f16b6c303a3#e2eeb32e655af43a22d76884283264ba"
      },
      {
        "api_path": "/33df86dd-9a9c-4d82-a00f-64a0b0b53cac/efd9534d-fe5c-4da4-b99d-8708dd340e8a/d436412e-f42f-4f33-9ebd-fca9ecdd2104/904a46b8-5245-4c68-ba90-a0fceb49b091",
        "base_path": "/dd8332df-0a00-443b-bca9-2c6296031601",
        "content_id": "5f546be2-0771-4d19-a51b-384a681e806d",
        "document_type": "Quisque non Sed in, amet, ipsum sed Suspendisse vel libero. imperdiet nibh. molestie ac scelerisque. interdum. sit a tristique porttitor Lorem risus tempor cursus elit. interdum. suscipit et leo morbi nisl Mauris aliquet. Ut bibendum. est. nibh netus senectus sem massa adipiscing lectus eros. Duis egestas. vestibulum. malesuada lorem at molestie ac Nam Aenean purus ac eu habitant tristique dolor risus mauris dolor turpis pellentesque sagittis hendrerit, sollicitudin volutpat Pellentesque et consectetur finibus, orci tempor Nam fames ultricies non Ut ac eu vel",
        "locale": "th",
        "schema_name": "senectus massa malesuada ac Nam Lorem ultricies mauris eu elit. risus Suspendisse tristique tristique et adipiscing finibus, scelerisque. Nam nibh. tempor Quisque sem in, Ut cursus Pellentesque sit",
        "title": "morbi malesuada Nam amet, Quisque tempor at nibh. netus dolor scelerisque. sed egestas. Sed risus ultricies Duis ac pellentesque interdum. senectus sollicitudin turpis vestibulum. non purus lorem ac ac tristique elit. orci est. porttitor fames nisl leo Nam lectus tristique interdum. Ut adipiscing mauris habitant et consectetur eros. nibh non aliquet. tempor Ut finibus, volutpat vel sem vel Mauris Pellentesque eu Aenean cursus et a suscipit Lorem in,",
        "web_url": "http://example.com/e5bf48a5-bf20-48e7-8512-6d1e6649c783#66e7cd859d2ac4693425c5a8f14c3031"
      },
      {
        "analytics_identifier": "eros. Sed lorem egestas. finibus, Aenean cursus aliquet. malesuada elit. molestie ipsum Quisque bibendum. nisl fames tempor tristique et est. ac at Nam ac mauris imperdiet sit consectetur molestie et habitant adipiscing lectus in, amet, tempor risus sem non ac Duis libero. vel interdum. vel Mauris tristique Ut senectus hendrerit, dolor massa eu vestibulum. suscipit purus orci nibh. leo interdum. sed scelerisque. a ac nibh netus morbi Lorem pellentesque dolor porttitor eu Suspendisse Ut volutpat sagittis turpis risus Nam non sollicitudin ultricies Pellentesque",
        "base_path": "/2034f68f-3ef0-4f96-98d0-9704224bc62d/4f74222a-4fb9-4494-875d-f3d493369c6b/55660f0e-b3f3-4619-85d5-3e8bf02e046e/0fcd85f4-e270-4452-93c3-65e695fc9bd1/485ef8d7-f7f5-4ee5-83a1-c10d1ac6f0da",
        "content_id": "7f78c218-5d93-4923-9ea8-f646f3194088",
        "locale": "tk",
        "schema_name": "vel ultricies",
        "title": "dolor sem at libero. habitant sollicitudin ipsum Nam Lorem nibh. morbi dolor nisl purus scelerisque. interdum. elit. cursus et tempor egestas. imperdiet Aenean consectetur vestibulum. finibus, molestie lectus Quisque orci volutpat Ut est. vel aliquet. sed sit adipiscing ac amet, Sed lorem turpis ac non a malesuada netus suscipit risus hendrerit, interdum. molestie bibendum. ac ultricies Mauris risus eu tristique Suspendisse et Duis leo nibh porttitor massa tristique eros. mauris eu fames senectus Ut non tempor vel",
        "web_url": "http://example.com/000b9f2b-0a2d-4d3f-b48c-7173d828ddb5/c1a3898a-104e-43c9-b6e1-68bb6a5f31b3/4f804a13-964e-4d7f-aa2b-6c4d3ba95960/53b02c20-d25d-40d7-98b6-86d89e329dbd/67bf46bb-9106-4080-b0dd-befec96afb96#9b3162596afdd97d864f8118ebf178bc"
      },
      {
        "api_path": "/1702305f-66b4-44c6-b73d-89ccd682665e/cf2f6742-f512-4e73-9752-67d0ac63a964/48165246-2f69-4394-a055-0706464feabe/a3421f07-568f-4de8-ac0d-b0e046fd4de0",
        "base_path": "/4f86cff2-2bc8-43c5-9c47-6761c7c6837d/6581aac0-c8f2-4690-85ab-a2065fe363ed",
        "content_id": "fa63c2c8-38c8-4263-8613-5a5cbb6b175a",
        "links": {
        },
        "locale": "si",
        "title": "orci Nam hendrerit, sollicitudin turpis morbi tempor est. aliquet. Nam dolor nibh. leo risus a suscipit finibus, purus vel Ut imperdiet in, et malesuada habitant lectus sit scelerisque. lorem interdum. eros. volutpat vestibulum. egestas. elit."
      }
    ]
  },
  "locale": "es-419",
  "need_ids": [
    "egestas. sagittis ac nibh bibendum. at hendrerit, sem molestie Suspendisse vel eu et non tristique tempor cursus malesuada non habitant dolor imperdiet finibus, lectus Nam libero. sed orci purus pellentesque nibh. porttitor et risus Ut mauris netus Mauris vel elit. Aenean Sed Ut in, ac consectetur sit suscipit Pellentesque amet, lorem morbi ac molestie aliquet. Quisque interdum. tempor Duis senectus massa nisl risus eu dolor turpis leo a adipiscing ipsum vestibulum. est. interdum. scelerisque. eros. tristique ac",
    "eu malesuada suscipit purus eros. massa dolor senectus Nam lectus et Aenean nibh. risus interdum. mauris aliquet. tempor hendrerit, pellentesque nibh ipsum vel tristique netus tristique adipiscing ac egestas. ac ac sed est. orci et turpis sem fames libero. a non porttitor Quisque interdum. Ut vestibulum. ultricies Duis Pellentesque lorem nisl Nam sit tempor sollicitudin sagittis Suspendisse vel ac elit. molestie imperdiet at habitant Mauris eu scelerisque. finibus, leo bibendum. non morbi cursus Sed Ut amet, dolor risus Lorem volutpat in, molestie consectetur",
    "in, volutpat Suspendisse dolor eu ultricies finibus, tempor mauris suscipit habitant sit porttitor tristique Duis interdum. tristique ac sollicitudin netus Aenean cursus nibh libero. non purus Sed interdum. bibendum. ipsum pellentesque nibh. vestibulum.",
    "et dolor suscipit purus Nam tristique leo Sed Ut a ipsum volutpat Mauris scelerisque. et bibendum. ac tempor finibus, nibh. netus ac non fames Quisque risus Ut massa nisl tristique sagittis sit dolor Suspendisse",
    "tempor ac et Duis tristique Aenean molestie volutpat morbi sagittis ac eu massa aliquet. pellentesque est. vel malesuada sed Mauris at hendrerit, Nam porttitor et risus vestibulum. a",
    "interdum. vel tempor tristique sed Duis ultricies consectetur risus Lorem ac mauris Mauris elit. amet, orci eu Nam a vel porttitor volutpat eu interdum. bibendum. molestie netus tempor imperdiet at sollicitudin habitant fames Ut pellentesque leo Nam sit sem libero. morbi Aenean dolor Ut non sagittis ac scelerisque. nibh lectus ipsum senectus est. eros. finibus, lorem"
  ],
  "public_updated_at": null,
  "publishing_scheduled_at": null,
  "rendering_app": "static",
  "scheduled_publishing_delay_seconds": null,
  "schema_name": "homepage",
  "search_user_need_document_supertype": "sem Suspendisse ac imperdiet eu mauris lorem nisl tristique ultricies molestie est. risus hendrerit, Lorem molestie amet, dolor non eros. sit",
  "title": "risus Lorem consectetur eu sed molestie finibus, adipiscing in, interdum. orci Ut suscipit risus massa eu Ut netus nibh. pellentesque malesuada sem cursus tristique turpis sit Aenean imperdiet lectus egestas. volutpat Duis ipsum tempor ac habitant ac ac leo porttitor bibendum. at purus Nam fames Suspendisse aliquet. molestie scelerisque. et dolor est. Mauris amet, nisl senectus ac a sollicitudin tristique non mauris Quisque hendrerit, ultricies dolor tempor vel vel nibh non Pellentesque lorem Sed Nam elit. vestibulum. et eros. interdum. sagittis libero. morbi",
  "updated_at": "2018-06-13T11:54:37+00:00"
}

Publisher content schema

This is what publisher apps should send to the publishing-api in This is what a publishing application sends to the publishing-api in a put_content call.

Attributes

access_limited
object
auth_bypass_ids
A list of ids that will allow access to this item for non-authenticated users
users
array

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
change_note
["null", "string"]

description
or null

details
object
document_type
string

Allowed values: homepage, service_manual_homepage
first_published_at
string
The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application.
last_edited_at
string
Last time when the content received a major or minor update.
links
object
policy_areas
A largely deprecated tag currently only used to power email alerts.
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
previous_version
string

public_updated_at
string
When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.
publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, search-admin, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
routes
array

schema_name
string

Allowed values: homepage
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "3bb02819-e365-4c39-a200-17fbbee74b8d",
      "b0a1f3ed-b901-4301-8629-09fed7a3737b",
      "e8dca1a7-d72d-4694-a448-b3d7f269c8d2",
      "5be790bd-a5f1-4abf-b539-d650571dfedc"
    ],
    "users": [
      "vel sem Nam non elit. vestibulum. eu adipiscing purus bibendum. Suspendisse a lorem dolor turpis malesuada netus lectus Ut morbi risus tristique fames vel Sed Duis senectus porttitor hendrerit, libero. at ac cursus sagittis tempor et volutpat Quisque dolor suscipit eu Nam in, Aenean interdum. interdum. habitant sollicitudin Pellentesque tristique ipsum scelerisque. Ut non finibus, risus ac nisl nibh mauris"
    ]
  },
  "analytics_identifier": "elit. vel tristique et Quisque et risus mauris in, vel at sit interdum. leo sem porttitor interdum. risus Ut non ipsum volutpat ultricies massa Aenean sed molestie molestie a orci nibh. suscipit nibh non eu lectus bibendum. tempor eu consectetur ac purus Nam Nam hendrerit, sagittis Ut Mauris tempor vestibulum. ac nisl eros. dolor ac libero. lorem amet, Pellentesque Sed cursus pellentesque turpis malesuada egestas. Lorem fames finibus, scelerisque. imperdiet senectus est. morbi Duis habitant netus tristique Suspendisse",
  "base_path": "/d5e118fa-5704-496a-807e-6595f3016c3a/2e48c95a-99ad-47e2-9cd0-3fe8dbc40d2d",
  "description": "tempor lorem dolor ac molestie interdum. risus Mauris amet, cursus Duis interdum. dolor nibh. eu adipiscing eu tempor sit libero. Ut et aliquet. egestas. finibus, porttitor",
  "details": {
  },
  "document_type": "service_manual_homepage",
  "first_published_at": "2018-06-01T10:56:05+00:00",
  "last_edited_at": "2018-06-19T21:59:25+00:00",
  "links": {
  },
  "publishing_app": "specialist-publisher",
  "redirects": [
    "suscipit in, ac sem egestas. porttitor Quisque mauris hendrerit, morbi sit volutpat Mauris tempor et turpis Nam a dolor Pellentesque netus est. sed",
    "et risus aliquet. hendrerit, consectetur vel bibendum. fames Nam Lorem mauris nibh. habitant volutpat amet, in, ultricies sagittis ac eros. Quisque molestie Aenean senectus eu interdum. Mauris turpis a Nam egestas. libero. Duis Ut dolor netus tristique non vestibulum. sed dolor adipiscing purus at Suspendisse nisl Ut malesuada est. sit tempor porttitor nibh cursus lorem massa Pellentesque elit. molestie Sed sem tempor eu lectus morbi ac pellentesque ac ac interdum. vel risus tristique suscipit non et",
    "Ut tempor purus elit. in, molestie turpis finibus, non at nibh. ac nisl dolor Suspendisse interdum. Aenean",
    "lorem leo tristique tempor a Nam eu senectus orci vel malesuada at imperdiet adipiscing est. morbi et tristique in, habitant netus molestie sed ipsum Sed lectus Suspendisse massa cursus porttitor fames hendrerit, finibus, ac consectetur elit. Pellentesque et sit vel Nam ac pellentesque ultricies Lorem nibh. nibh suscipit interdum. libero. mauris sagittis scelerisque. risus Ut Mauris dolor Quisque bibendum. vestibulum. Duis interdum. molestie aliquet. non Aenean turpis nisl egestas.",
    "vel nibh massa leo Ut eu sem senectus aliquet. tempor ac consectetur scelerisque. risus nisl sed Suspendisse et in, libero. tristique Quisque lorem Sed orci eros. at egestas. sagittis hendrerit, amet, malesuada lectus turpis Ut interdum. non interdum. morbi vestibulum. Lorem elit. ac et vel Nam Nam molestie fames",
    "bibendum. nibh. ac est. leo in, interdum. Mauris suscipit a eros. adipiscing nibh risus Nam sagittis ac dolor morbi vel dolor Ut Aenean et lectus ipsum sollicitudin at elit. ac Duis tristique Quisque et habitant ac non Nam risus senectus purus sit volutpat turpis sed pellentesque Lorem netus sem imperdiet fames Suspendisse malesuada egestas. Ut eu consectetur lorem eu hendrerit, tempor libero. non Pellentesque scelerisque. ultricies tempor orci molestie aliquet. nisl vel massa vestibulum. molestie interdum.",
    "sem dolor nibh. massa Ut bibendum. Suspendisse orci ac Lorem elit. nibh ac at sed turpis tempor vestibulum. Pellentesque malesuada Nam sollicitudin vel risus eu a volutpat molestie eu senectus suscipit tristique eros. Quisque adipiscing libero. nisl habitant lorem sagittis leo morbi fames cursus Duis porttitor interdum. non est. Sed egestas. non scelerisque. ipsum aliquet. tristique et in, Nam vel et consectetur amet, Mauris mauris",
    "adipiscing Nam sollicitudin dolor suscipit porttitor scelerisque.",
    "orci porttitor non aliquet. sollicitudin Duis sagittis interdum."
  ],
  "rendering_app": "collections",
  "routes": [
    {
      "path": "Mauris adipiscing purus morbi malesuada nibh Nam eu scelerisque. a pellentesque porttitor lorem est. volutpat ipsum dolor ac Aenean senectus eros.",
      "type": "exact"
    },
    {
      "path": "eu ac netus malesuada non ac ac sit lectus Nam habitant interdum. vel lorem tempor vel egestas. at Aenean est. Mauris sem scelerisque. et tristique consectetur Pellentesque sagittis senectus suscipit finibus, ac pellentesque risus ipsum mauris orci bibendum. nibh. cursus dolor in, non volutpat vestibulum. dolor et libero. molestie Quisque turpis",
      "type": "prefix"
    },
    {
      "path": "massa habitant eu Nam porttitor leo a ultricies Ut volutpat finibus, sed adipiscing suscipit hendrerit, sem cursus et risus vestibulum. non et vel dolor tempor malesuada sit vel risus turpis Ut non ac Pellentesque scelerisque. mauris egestas. molestie pellentesque morbi aliquet. ipsum netus Suspendisse nibh Duis tristique at fames amet, nibh. est. tempor bibendum. senectus elit. sagittis tristique consectetur libero. ac dolor orci Aenean Mauris lorem ac purus interdum. nisl eu eros. ac Quisque in, molestie Nam interdum. lectus sollicitudin Lorem Sed imperdiet",
      "type": "prefix"
    },
    {
      "path": "est. ultricies Mauris ac dolor eu aliquet. eros. tempor vestibulum. Nam mauris sem et et elit. ac lorem lectus molestie tempor nibh bibendum. sollicitudin orci hendrerit, molestie Quisque senectus ac scelerisque. Duis massa risus non consectetur vel tristique fames tristique pellentesque ac Pellentesque Sed",
      "type": "exact"
    }
  ],
  "schema_name": "homepage",
  "title": "Sed pellentesque egestas. senectus Mauris porttitor non ac tempor eros. lorem tristique suscipit consectetur dolor risus cursus interdum. ac adipiscing risus nibh. dolor elit. vel mauris leo ac ac vestibulum. Nam non Lorem Ut purus amet, bibendum. sollicitudin a orci Pellentesque Aenean at netus molestie lectus sed Ut Suspendisse Quisque Nam et aliquet. Duis scelerisque. vel hendrerit, sit massa finibus, volutpat tristique nisl malesuada fames et est. turpis tempor eu sagittis interdum. molestie libero. morbi imperdiet sem ipsum ultricies eu nibh habitant in,",
  "update_type": "major"
}

The links for this item. This is what a publishing application sends in a patch_links call.

Attributes

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "links": {
  }
}