Skip to main content

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
description
or null
details
object
change_history
array
document_type
string
Allowed values: homepage, service_manual_homepage
first_published_at
or null
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
embed
 Content that will be embedded within the document, using embed tags.
level_one_taxons
 Link type automatically added by Publishing API
ministers
 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.
popular_links
 Collection of links to be used to display popular links on homepage
related_to_step_navs
 Link type automatically added by Publishing API
role_appointments
 Link type automatically added by Publishing API
secondary_to_step_navs
 Link type automatically added by Publishing API
locale
string
Allowed values: ar, az, be, bg, bn, cs, cy, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, ne, nl, no, pa, pa-pk, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, yi, 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
public_updated_at
or null
publishing_app
string		 The application that published this item.
Allowed values: account-api, calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, government-frontend, hmrc-manuals-api, local-links-manager, manuals-publisher, maslow, performanceplatform-big-screen-view, publisher, publishing-api, rummager, search-admin, search-api, 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: account-api, calculators, calendars, collections, content-store, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licensify, performanceplatform-big-screen-view, rummager, search-api, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
scheduled_publishing_delay_seconds
or null
schema_name
string
Allowed values: homepage
title
string
updated_at
string
withdrawn_notice
object
explanation
string
withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": null,
  "base_path": "/feb8cab4-bdc2-17e6-a7a8-c0fea6ef5174/495505b4-b90c-1df5-aa4b-3adeae7bad5e",
  "content_id": "33cd8e6c-bd31-1c34-a50e-6dda3ce6e5d3",
  "description": null,
  "details": {},
  "document_type": "service_manual_homepage",
  "links": {
    "child_taxons": [
      {
        "api_path": "/add045ef-b2ef-19f0-ac41-d942c3c7a3aa/ec3f6a54-b4aa-1d1d-a71e-255db6904a8f/cd3d49c2-8c22-1a92-acfe-aed226c5a21e/aedea11f-b73d-1e1b-a3e6-f10367a4816a",
        "api_url": "http://example.com/a975c681-3f59-1a6a-a7b3-dcdb4f55fb35#efc31becea",
        "base_path": "/9bf06ff1-cbe9-11fa-a7fb-2e45e8c0c07b/a47b7eee-e2cf-1b5f-ae9d-0a6be2a4b91a",
        "content_id": "bc5c7a88-a5fe-1f1c-aebe-9f9ce25e8feb",
        "document_type": "et et eros. Suspendisse lorem ipsum Pellentesque purus pellentesque ac leo at vel dolor senectus Ut Quisque a sem lectus fames sollicitudin ultricies eu non vestibulum. egestas. risus Duis in ac cursus Nam porttitor habitant ac scelerisque. tristique interdum. netus elit. sagittis aliquet. molestie imperdiet interdum. amet bibendum. morbi adipiscing turpis Sed Lorem libero. nisl volutpat non hendrerit est. eu sed sit finibus tempor vel mauris massa molestie tempor tristique Mauris suscipit orci malesuada Aenean dolor nibh Nam consectetur Ut ac",
        "links": {},
        "locale": "no",
        "schema_name": "scelerisque. fames risus amet cursus Pellentesque leo malesuada consectetur finibus aliquet. elit. hendrerit orci Sed purus egestas. ipsum libero. ac Ut lorem dolor non et Suspendisse morbi nibh pellentesque adipiscing vel Aenean tristique porttitor habitant ac Lorem non molestie interdum. nibh. Nam Quisque risus imperdiet sit est. ultricies",
        "title": "Aenean vel ipsum molestie Duis Sed finibus Pellentesque Ut elit. sit ac Lorem netus interdum. porttitor tristique habitant molestie turpis Suspendisse Ut suscipit Mauris libero. nisl ac risus egestas. Nam vel nibh a at eros. aliquet. imperdiet et senectus pellentesque tempor orci eu malesuada adipiscing sem dolor mauris non bibendum. est. leo tempor volutpat et Nam ultricies eu fames scelerisque. risus hendrerit lorem vestibulum. lectus Quisque consectetur tristique ac ac interdum. non dolor sed in amet morbi sollicitudin purus massa sagittis nibh. cursus"
      },
      {
        "analytics_identifier": null,
        "api_path": "/d417a36e-4286-1b4c-a5ab-17bd6beec0fc",
        "api_url": "http://example.com/93f3f2f3-bee1-1a6e-ab9a-98d9668d0f59/febaffb5-7d62-1fab-ac49-7bfff6d046c0/1c698aec-dd72-15fd-a5ad-895fffef4e34/a9decb9a-9629-18a6-aec1-2e7f99c8c017/2ac62188-f7e0-1010-a112-a247bbcf5f8d#99b01db9f0",
        "base_path": "/3f7da56b-0d70-1eba-ae02-73bbd3350abc",
        "content_id": "f2cdd6ee-32cb-1cd3-aa05-89ea400e0eed",
        "links": {},
        "locale": "fi",
        "schema_name": "consectetur lorem vel mauris senectus et molestie risus nibh Lorem netus ac turpis nibh. eros. eu volutpat tristique suscipit tristique et eu orci scelerisque. at ac nisl ultricies malesuada dolor Pellentesque Aenean Quisque est. Suspendisse tempor sed vestibulum. in sit ac porttitor massa vel sollicitudin Sed Duis Nam sagittis cursus interdum. Ut Nam amet egestas. leo interdum. adipiscing lectus",
        "title": "Mauris eu cursus morbi pellentesque senectus hendrerit ultricies tempor Ut Nam sed imperdiet lectus Ut ac turpis nibh dolor elit. non a netus Nam ipsum scelerisque. leo mauris nibh. et purus tristique massa orci malesuada tempor et in at tristique risus suscipit vel Duis ac consectetur interdum. molestie Quisque ac vestibulum. eros. ac Suspendisse non Lorem amet eu habitant bibendum. lorem vel interdum. Pellentesque egestas. porttitor finibus molestie aliquet. sit adipiscing est. dolor volutpat Sed sagittis nisl fames Aenean sem libero. sollicitudin"
      },
      {
        "analytics_identifier": null,
        "api_path": "/ca36e409-90aa-1d62-a763-f5dce8b2613a/18625dcc-2094-1a90-acec-76dadee7bd2c/4d8b6b69-6cb7-1d8d-aacd-7be5c6b256c8",
        "api_url": "http://example.com/ee14a23f-e4c6-16ef-a8f5-6778dd9c15dc/ed49f6aa-154b-1cca-a143-37d6ef9c1d9f/c6742eaa-265b-1aac-a33c-86d61d2bb50c/b3efbf6e-e542-16b0-aebb-4652abdaec5f/7e137bf8-1e30-1237-a0ed-db31bbf9afb3#10bb9ffc1a",
        "base_path": "/ffb6ee5b-b70b-1fbc-a0a1-b7fc9a084eff/efe4e664-c577-1639-afa6-93fde33ee495/b0ca001c-d5ea-1fdf-ace4-fb307bef7cbd/acb95f9b-6765-1dca-aad1-73c369304f2b",
        "content_id": "8bfccbfb-f437-1cfe-a6ce-d8cfe3620cc1",
        "document_type": "Aenean senectus Ut sed eros. bibendum. dolor Nam tristique adipiscing ac volutpat sollicitudin tristique a Sed cursus Quisque in egestas. eu ipsum libero. molestie purus interdum. leo imperdiet vestibulum. amet molestie ac fames habitant et est. orci turpis non sem netus",
        "locale": "sv",
        "public_updated_at": null,
        "title": "nisl leo Duis netus finibus Quisque risus massa tempor vestibulum. eros. orci senectus turpis ac eu purus interdum. Pellentesque amet Mauris lectus egestas. Ut at molestie risus nibh. ac vel ipsum consectetur a ac aliquet. scelerisque. est. et mauris imperdiet sollicitudin lorem tristique sit habitant bibendum. sagittis sed Aenean vel ultricies dolor cursus hendrerit porttitor sem Suspendisse ac pellentesque morbi eu"
      }
    ],
    "children": [
      {
        "analytics_identifier": "nibh sollicitudin volutpat amet vel lectus Pellentesque ultricies cursus consectetur imperdiet sed eu risus netus risus tempor Nam purus at fames non ipsum Nam est. Sed interdum. dolor vestibulum. lorem Duis mauris dolor pellentesque tempor finibus orci Ut eros. leo molestie Aenean tristique malesuada et adipiscing ac a hendrerit senectus nibh. Suspendisse interdum. vel bibendum. turpis nisl elit. sit Ut porttitor suscipit Lorem Mauris Quisque eu molestie massa sagittis sem",
        "api_path": "/f7124dc2-cffd-1bef-afa1-5ff975cfb0e1/7abbfb0b-e6d6-1804-a0dd-6e7bf36c6582/99f4e4f0-9a1c-107c-abaa-b9caf4645f9c/a1d94177-bd0d-1e5a-a4fb-7e40cb8cc7f5/dededdd9-fccc-16bb-ac3d-e33a0ebbd30c",
        "base_path": "/a659321d-fd26-147e-aa8c-c0d06cf6d675/fcf485d9-276f-12b4-ab11-d39a48920b0d/b912ad77-2f52-19bb-a6d1-fb52e57f2a9f/0d9b35b7-c7ea-1c79-a71a-c7378ad5e5bc/acbbbb7a-e72f-1e19-ad3f-fc1512cde700",
        "content_id": "6a8b9cc8-af79-18c4-aabe-a10dc040be85",
        "document_type": "tristique elit. netus lorem eu adipiscing eu lectus malesuada hendrerit porttitor ac a senectus non mauris Aenean morbi risus consectetur Ut purus suscipit pellentesque interdum. tempor Suspendisse ac ipsum ac non Nam Quisque et imperdiet molestie",
        "locale": "bn",
        "public_updated_at": "2024-05-28T18:55:35+00:00",
        "schema_name": "risus sollicitudin Mauris vel ipsum hendrerit a nibh netus orci Duis est. ac pellentesque Nam turpis sem amet ac Pellentesque eros. vel egestas. Lorem morbi et Sed non Suspendisse non fames tristique risus nibh. eu in leo consectetur interdum. dolor senectus ac sit nisl at libero. lectus Nam",
        "title": "interdum. Suspendisse massa interdum. mauris Nam sit Sed lectus fames non malesuada tempor et aliquet. sem molestie amet Quisque eros. Nam ipsum egestas. senectus sagittis bibendum. adipiscing suscipit lorem elit. et Mauris molestie Duis eu Pellentesque orci finibus nibh a ac dolor risus cursus morbi imperdiet Aenean tempor consectetur Lorem vel turpis porttitor ultricies leo scelerisque. pellentesque nibh. nisl ac vestibulum. dolor non tristique sollicitudin purus sed Ut hendrerit netus at tristique Ut libero. ac risus ac eu volutpat habitant est. vel in"
      },
      {
        "analytics_identifier": "libero. Quisque ac consectetur cursus interdum. vel sit interdum. risus ipsum egestas. nibh. a pellentesque sed molestie turpis morbi Ut vel dolor finibus vestibulum. imperdiet ac habitant netus purus risus malesuada Pellentesque non eros. porttitor tempor sollicitudin scelerisque. Mauris nisl tristique ultricies eu elit. ac Aenean volutpat in tempor Nam leo hendrerit est. tristique fames bibendum. et at suscipit dolor eu molestie lectus non Duis orci mauris Nam Ut amet senectus massa Lorem sem et adipiscing Suspendisse ac aliquet.",
        "api_path": "/3ab3dd5c-92aa-1ad2-a57c-cfbddb91834a/6e1cbfdc-7d62-1ede-a0fb-f0c8b3b8754f/adfb423f-dadc-1e2a-acac-e5cc431ccbbe/133865bc-6c8f-1a25-ab1d-236b8bee8e61",
        "api_url": "http://example.com/ecf21c8f-df9c-1d0c-a749-7fd443fffe32/ba0cdfa9-9c76-1fbc-a0d2-6e72a3f2b7cf/ee6ada5f-fb0f-1ab7-ae75-d986c2402caa/ecbc0588-39ee-1cfb-ae48-a7d76a26c4a9/7db1cc68-2964-1abc-a5b6-2906fd7f0f33#df6cc47383",
        "base_path": "/8d80dc6d-a5f7-17d3-aaa0-4c51eb0a4691",
        "content_id": "ead7be5c-120e-13df-a85c-fbdc8e2a9bd5",
        "locale": "pa-pk",
        "public_updated_at": null,
        "title": "sagittis orci interdum. bibendum. vestibulum. amet cursus vel Mauris Lorem morbi Sed ac elit. Ut imperdiet sit pellentesque consectetur egestas. in suscipit malesuada Aenean lorem hendrerit finibus habitant vel et eu Suspendisse Pellentesque volutpat at nisl et ac fames risus netus turpis sed tempor dolor molestie interdum. Nam tristique ac risus",
        "web_url": "http://example.com/c96b2b59-8054-1ac9-a3ce-b85d664a9e05/f3b9fabe-ee5f-1fe4-a7f5-a4a96b336c44/28e2cc8a-ef1b-185b-a407-596efd9aaf6b#e7ca4f3b5a"
      }
    ],
    "embed": [
      {
        "api_path": "/69d2fdd6-f3f6-1e5b-abdc-fc7766e9107d/5492fcb1-eec6-1bdf-ad4a-aa5fc5cf022d/2caab7fd-158d-1f6f-a2d4-5ac7f29dfa6d/5fe140f0-b7f5-13a2-a4b9-0bde8a31560e",
        "base_path": "/2c52f351-f566-1aab-aa76-9cc24557ba42",
        "content_id": "732e1e19-e3b4-13fb-a6a3-2a0fac3eadaf",
        "links": {},
        "locale": "ta",
        "schema_name": "tristique adipiscing Pellentesque dolor tempor finibus Sed purus senectus sagittis massa eu molestie molestie risus ac fames Nam libero. vel cursus leo Lorem sem turpis risus dolor ipsum non interdum. sollicitudin Suspendisse Nam bibendum. nibh. eros. aliquet. morbi ultricies lorem egestas. est. lectus at volutpat sit scelerisque. sed netus ac mauris suscipit Duis interdum. malesuada vestibulum. elit. consectetur nisl nibh vel Ut eu imperdiet Quisque Mauris habitant in ac a ac et pellentesque orci tempor hendrerit et porttitor amet tristique non Ut Aenean",
        "title": "finibus elit. ultricies Duis imperdiet Pellentesque lorem nisl purus senectus dolor molestie risus sollicitudin vestibulum. Ut morbi non tempor non tempor mauris amet ac ac porttitor sem orci volutpat malesuada ac turpis vel scelerisque. lectus interdum. consectetur nibh. nibh in Lorem est. bibendum. vel tristique et tristique a dolor Mauris netus risus pellentesque egestas. Nam Suspendisse libero. eu habitant ipsum interdum. Nam fames hendrerit sed at Ut sit eros. molestie suscipit ac",
        "web_url": "http://example.com/ff2fa68e-f92b-111d-aaf2-ba67a9c79e93#9899c0c1fd"
      },
      {
        "api_path": "/27d59a17-7f28-163d-a71a-4aae41d7a1af/aff5f43c-8bb8-1e98-aa21-22acde1a1dcc/463da42a-7ac4-1cc5-a57f-a9f0caca3ba7",
        "base_path": "/aab3292d-c233-181f-a329-dc0ce14596b6/1c994eb7-960e-1f1c-ab1d-e0aa1a7dba1e/203ee3ae-490a-154a-ae45-09c5d4011eda/92fbf29b-5320-157b-ac42-acda6a2ddbd9",
        "content_id": "e9f6baad-a31f-1b47-a3b9-a7179be5ed2a",
        "locale": "uk",
        "title": "Quisque finibus suscipit sed sit Ut aliquet. non tempor",
        "web_url": "http://example.com/14c2a28d-4dbd-19ac-a7f4-616f5dccf44b/efcec08b-eeca-1d30-a2d7-c0984efef434/dc6d89eb-b85e-15e7-ab06-eb17f22bcdab/9486a317-fba7-1459-a2f6-14eca3577ba8/453c247c-eae3-1e58-a944-00d51ddc5322#b0f0ec5b26"
      },
      {
        "api_url": "http://example.com/22d79a49-4fea-1d34-ae8b-fc60dae6ef4f/caab0c2e-cbcc-19d3-a3db-fbeb66ccb735#ae0cbae7ad",
        "base_path": "/882aeeaa-94f4-11fd-a01d-c800df38a43d/c429b46c-d86b-1cfd-a24f-f0ddd0da8f9c/6e3dc35b-d343-1bec-a78b-8f143bfc55e9/ea1ccfda-b1da-199b-ab04-ecd20cf20e85",
        "content_id": "43e218ac-2eea-1aad-acaa-4bac7e8e71bb",
        "links": {},
        "locale": "dr",
        "schema_name": "vel molestie vestibulum. Pellentesque purus ac Ut",
        "title": "imperdiet hendrerit sem a risus Ut interdum. orci est. habitant turpis non consectetur dolor ipsum molestie sed eu ac tempor Lorem mauris Nam Quisque malesuada sit leo Sed eu amet vestibulum. egestas. at nisl lorem et"
      }
    ],
    "secondary_to_step_navs": [
      {
        "base_path": "/be7c4eaf-d3c8-1e42-a1bf-f1ad4e5bccf5",
        "content_id": "b74f6a6a-a86b-1b61-aa9e-6a25c20fda5e",
        "links": {},
        "locale": "gd",
        "schema_name": "amet morbi consectetur est. ac adipiscing leo molestie sollicitudin pellentesque habitant cursus lorem at eros. sagittis interdum. dolor vestibulum. aliquet. hendrerit Ut elit. ac suscipit vel Nam nibh. senectus Pellentesque Aenean imperdiet Suspendisse",
        "title": "Duis eros. habitant Ut massa adipiscing et porttitor sit Sed turpis malesuada Aenean non sollicitudin lectus cursus Pellentesque dolor netus fames scelerisque. eu sed at egestas. ipsum mauris risus nibh orci vel suscipit in hendrerit risus Ut Nam imperdiet non elit. a est. interdum. tempor tristique interdum. ac Lorem morbi ac Quisque consectetur purus aliquet. libero. nisl bibendum. tristique nibh. amet leo lorem sem volutpat molestie pellentesque sagittis ac dolor"
      },
      {
        "api_path": "/b9eb6a9b-c0fa-11e3-aa92-54ce8ea2a2e8/e28c782a-50b5-1c00-ab20-9e2abfbd818f",
        "api_url": "http://example.com/d8425a66-7fa7-1648-a3e1-12f2df4b218a/e34f0afc-03d5-1b0d-af6b-c07fee4fd791/c3f05b3a-d807-123d-a9b8-8aeca2d4e44e/8f788307-2cdc-17d8-ada1-dfea723265e0#c49671137f",
        "base_path": "/e8884c49-bedf-1d33-a0be-d0eb01ade9e6/a49ef534-f0b2-1d1d-a4c4-2845156bf22e/4ddb89cf-65e6-1794-a020-e9216a71c1ee/fd7ecd0a-2daf-1086-a6ef-0eff2e53e1ba",
        "content_id": "6cc6d47d-af1e-107a-ad4b-8bd4860d63f7",
        "links": {},
        "locale": "ar",
        "public_updated_at": null,
        "schema_name": "sed non scelerisque. vestibulum. tristique leo adipiscing sollicitudin massa Lorem ac vel dolor a turpis Nam non ultricies in Pellentesque sagittis molestie vel pellentesque tristique Quisque porttitor netus amet tempor egestas. orci ipsum morbi risus molestie sit Mauris Duis finibus",
        "title": "aliquet. orci et interdum. ac eros. est. sed habitant vel imperdiet risus non libero. leo turpis sem tempor tristique morbi finibus purus ac vestibulum. bibendum. dolor cursus molestie ipsum et interdum. in hendrerit adipiscing mauris lectus malesuada Aenean tempor non eu egestas. Mauris sit at Quisque volutpat risus ac senectus Ut a molestie amet fames eu elit. netus suscipit dolor vel sollicitudin pellentesque nisl Lorem Nam ac lorem Ut Sed"
      },
      {
        "analytics_identifier": null,
        "base_path": "/e7ced1be-61e1-1beb-af02-3fcb20a23abc/fa970ab7-e4d4-19bf-aaeb-f4e933798dae/b9aa4f11-07da-1dab-a9eb-3fa9bc0a98f2/a471fcce-6885-1c14-a8cd-b8d97c51f463",
        "content_id": "6cf8341d-dd3b-1538-aac9-70fdf14ef646",
        "locale": "hr",
        "public_updated_at": "2013-10-22T12:30:58+00:00",
        "schema_name": "ac cursus Ut egestas. bibendum. eu interdum. nibh. ac ac vestibulum. Lorem volutpat Nam sed in porttitor non fames massa tempor tempor eu Aenean sit risus ac malesuada scelerisque. ipsum consectetur sagittis aliquet. pellentesque et non senectus a Pellentesque at Mauris finibus tristique eros. libero. sem Ut tristique et Suspendisse vel Sed dolor sollicitudin turpis molestie adipiscing purus amet leo est. molestie suscipit netus vel",
        "title": "nibh. ac massa eu vel egestas. imperdiet lorem sollicitudin finibus sagittis ac Nam"
      },
      {
        "analytics_identifier": "nibh. eu et hendrerit non volutpat in bibendum. ac adipiscing Ut Aenean egestas. interdum. vestibulum. ultricies mauris vel Nam a dolor interdum. Duis ipsum Ut aliquet. fames ac netus risus senectus Pellentesque",
        "api_path": "/bc0ec590-1aa0-18b6-a0f5-aa1cc64ec7bb/108fb963-c2cb-1cab-a8f0-8be5e7520559/cea5632d-09c6-1b55-aebc-e96a8c18f7eb/5cfd2d62-b732-1efb-a9ee-f208f369aca0",
        "base_path": "/b4c52823-57e8-19c0-af3d-ac4bd99d4ccb/58a3cdbd-ff5d-18d8-af89-7dc31f2ccaa4",
        "content_id": "eac3b18f-1036-148d-a2cb-b56b4a3c5fc6",
        "links": {},
        "locale": "no",
        "schema_name": "Quisque egestas. cursus Lorem consectetur ac tempor tristique adipiscing sagittis purus mauris amet tristique Aenean lorem a sed interdum. ipsum elit. Nam Ut suscipit bibendum. massa vestibulum. est. turpis dolor leo orci molestie Ut Suspendisse et senectus in interdum. ultricies vel eros. tempor Pellentesque ac Mauris nisl aliquet. at Nam ac risus morbi sollicitudin porttitor lectus volutpat sit molestie nibh. risus",
        "title": "Ut non tristique ipsum lorem scelerisque. ac mauris Sed in elit. cursus Duis Nam ac risus Quisque interdum. ac massa nisl lectus volutpat tristique sem habitant aliquet. orci risus nibh est. vel tempor sed sit ac leo bibendum. et senectus pellentesque purus vestibulum. eu",
        "web_url": "http://example.com/707ce7e2-d0dc-10be-a02a-6875015ca6d0/b3b258f4-1d4a-1aa0-a65e-7f791b4a206e/c31eeaf9-9dcf-1b6b-addc-af34165aa139/fc1dfddf-425b-1dc0-ab9a-e68bb2cee79d#c01cc1aa5d"
      },
      {
        "api_path": "/bfca917e-7c87-1aff-af0e-5e8ecaa91ba8",
        "base_path": "/923fd0da-dffb-16d8-aad8-f945e778b6ec",
        "content_id": "ba25f62b-a29f-1f0a-a4a8-fef97fc91aee",
        "locale": "mt",
        "public_updated_at": null,
        "title": "at Ut a Sed ac nisl Mauris tempor molestie interdum. Duis pellentesque imperdiet turpis Lorem Ut Quisque lorem non ac adipiscing libero. sagittis nibh. morbi sollicitudin cursus hendrerit eu tristique sem vel Nam mauris fames elit. dolor habitant Pellentesque vel volutpat risus ipsum et bibendum. lectus est. orci leo purus aliquet. Nam sit dolor Aenean in egestas. finibus netus risus Suspendisse tempor nibh ac amet et sed molestie tristique massa non eros. eu interdum. ac scelerisque. consectetur vestibulum. senectus malesuada",
        "web_url": "http://example.com/048d910c-a9a5-186f-a0a1-249a6e51dff7/5530ac3c-79af-19ba-a1d3-ae34d232bab0/c8da980a-e7d5-1090-acad-c318fb83b83e/e7ac8610-9dc9-1a64-a501-c5d40bf024a0#78134aaf60"
      },
      {
        "api_url": "http://example.com/a546ad09-e48b-1ad4-ab01-5a608bc7ede4#8cf0f4deb0",
        "base_path": "/c4657c82-5fa2-174c-a86e-57dc2ab1a453",
        "content_id": "4d5b4b89-bbeb-19b7-a0e8-d6cc6b6e4ff3",
        "locale": "so",
        "public_updated_at": null,
        "schema_name": "sit vestibulum. ac suscipit vel at senectus Mauris Sed et tristique mauris finibus ipsum tempor eu est. netus ac",
        "title": "a turpis volutpat finibus egestas. interdum. Nam Ut sem Nam Quisque non ac vel sed Mauris consectetur molestie massa orci nibh ultricies porttitor Aenean Sed habitant scelerisque. risus suscipit ac cursus at"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/6be6ca3f-ffbc-1a71-ac82-d0ec0067c2ff#d07789baa0",
        "base_path": "/ea80a0f9-0f87-1efb-aacc-a8ab4d35ffd8",
        "content_id": "0b0990ac-4aac-1fee-a5a7-39cde68d1c29",
        "document_type": "senectus nibh. ipsum scelerisque. molestie mauris vestibulum. ac Pellentesque pellentesque in tristique sed malesuada ac finibus interdum. morbi risus non Quisque suscipit eros. porttitor dolor lorem Duis imperdiet vel ac egestas. sollicitudin eu Mauris tempor sem consectetur nisl vel volutpat leo sagittis eu tempor non ultricies dolor sit Aenean nibh amet elit. et at Ut cursus a adipiscing purus bibendum. et aliquet. Nam molestie fames Lorem netus orci hendrerit interdum. Ut tristique Sed",
        "locale": "zh",
        "public_updated_at": "2012-11-19T12:28:43+00:00",
        "title": "ac Nam sagittis malesuada Duis consectetur bibendum. Aenean risus dolor vestibulum. orci vel nibh. sit turpis risus elit. habitant ac eros. at non Mauris non hendrerit Ut porttitor massa ipsum interdum. Ut volutpat netus aliquet. finibus eu libero. suscipit Suspendisse Pellentesque Lorem et egestas. ac sollicitudin fames nisl tristique ac dolor lorem amet est. eu molestie tempor",
        "web_url": "http://example.com/ee8ec326-9e0d-1dd9-ac9a-288ccee7feac#cbbc9fba0b"
      },
      {
        "analytics_identifier": "pellentesque scelerisque. malesuada Aenean Lorem cursus lectus sem eu risus Quisque eros. tristique Suspendisse in volutpat interdum. porttitor",
        "api_url": "http://example.com/fcbcb5d0-e066-1e07-a7ef-fbd4fadd72ea/225bb09c-3e52-106b-af64-e4cbd512a51c/3e2b17d8-cc6e-1bb5-ac31-f1b5d6b2aeaa#bf6a29c0fe",
        "base_path": "/2aed1fbe-3472-19cb-a4fb-bf846a314ff7/8bb2ce8b-c28a-13ce-ac12-39eed6fda2fd",
        "content_id": "de6c2a4f-3cb2-153a-ac05-f2cdcc06e0de",
        "locale": "ne",
        "schema_name": "interdum. vel suscipit nisl et tempor at cursus Lorem morbi elit. hendrerit ipsum ac molestie leo lorem sed et pellentesque nibh. dolor adipiscing purus",
        "title": "habitant",
        "web_url": "http://example.com/d7f9afee-a0aa-13cc-a9eb-d0fd9acb7cc8/c86ebe26-afea-1d8b-adea-ec7af634feb9/1db2ff9c-96a9-1e3a-acfa-e4dd6d13b03a#dea31d603e"
      }
    ]
  },
  "locale": "ta",
  "need_ids": [
    "vel porttitor interdum. hendrerit sagittis cursus tristique Pellentesque Nam ac Ut Nam mauris elit. consectetur Quisque aliquet. dolor suscipit risus nibh vestibulum. lorem Suspendisse est. Mauris finibus senectus ipsum massa interdum. turpis sit ultricies in ac imperdiet et ac purus morbi ac molestie non scelerisque. tempor eu eros. volutpat netus leo sem Aenean malesuada",
    "bibendum. amet pellentesque et ac egestas. eros. interdum. sagittis tristique nibh scelerisque. at eu Nam finibus dolor Nam molestie suscipit Pellentesque lectus malesuada sit est. eu libero. Lorem ac interdum. porttitor ac Quisque risus vestibulum. morbi Ut molestie imperdiet leo Mauris elit. dolor fames habitant vel tempor sed nibh. Aenean in Suspendisse non Duis netus a orci adipiscing tempor turpis senectus nisl ultricies non volutpat lorem cursus",
    "scelerisque. Ut eros. non lorem eu interdum. massa nibh. non sagittis sem tempor habitant mauris finibus vestibulum. eu ac risus interdum. leo adipiscing ac Sed morbi molestie sollicitudin sit amet pellentesque Nam turpis nibh risus netus Mauris est. ultricies Pellentesque elit. ac porttitor purus in at vel cursus Aenean Ut nisl ipsum a Duis tristique vel tempor dolor et senectus Suspendisse aliquet. egestas. orci libero. fames lectus molestie Nam bibendum. sed tristique volutpat consectetur suscipit et dolor ac hendrerit malesuada Quisque imperdiet Lorem",
    "libero. vel pellentesque eu in ac Quisque nibh suscipit Nam Sed finibus Nam hendrerit interdum. elit. dolor tempor non ipsum tristique nisl eros. Suspendisse morbi molestie egestas. sagittis volutpat est. sem tristique et ac lorem mauris cursus Duis massa tempor malesuada senectus Mauris consectetur et",
    "tempor tempor Ut a sem risus interdum. eu hendrerit eros. imperdiet libero. Pellentesque vel purus orci adipiscing sed Nam suscipit lectus Mauris vel nibh. at finibus leo sit sollicitudin et pellentesque netus Quisque tristique amet molestie Ut eu ultricies scelerisque. egestas. cursus aliquet. molestie interdum. massa Suspendisse non lorem sagittis non Sed Nam Duis tristique ac volutpat ac fames nibh dolor et porttitor mauris malesuada dolor ac vestibulum. consectetur elit. risus"
  ],
  "phase": "live",
  "public_updated_at": "2016-02-10T17:04:42+00:00",
  "publishing_scheduled_at": "2023-09-05T02:12:12+00:00",
  "scheduled_publishing_delay_seconds": 3,
  "schema_name": "homepage",
  "title": "ac eros. Lorem netus tempor molestie Nam adipiscing risus elit. suscipit ac amet nisl egestas. nibh Ut habitant Mauris molestie Pellentesque Nam non orci et Sed scelerisque. purus ac Aenean vel leo sollicitudin dolor est. eu ultricies sem a massa nibh. finibus ac imperdiet interdum. porttitor sagittis",
  "updated_at": "2020-10-13T10:40:12+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
 Deprecated: auth_bypass_ids should be sent as a separate field
organisations
 A list of organisation content ids permitted access to this item
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.
auth_bypass_ids
array
base_path
string		 A path only. Query string and/or fragment are not allowed.
bulk_publishing
boolean
change_note
["null", "string"]
content_id_alias
null
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.
instructions_to_publishers
null
last_edited_at
string		 Last time when the content received a major or minor update.
last_edited_by_editor_id
string		 The UUID of the editor who edited the content.
links
object
embed
 Content that will be embedded within the document, using embed tags.
policy_areas
 A largely deprecated tag currently only used to power email alerts.
locale
string
Allowed values: ar, az, be, bg, bn, cs, cy, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, ne, nl, no, pa, pa-pk, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, yi, 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: account-api, calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, government-frontend, hmrc-manuals-api, local-links-manager, manuals-publisher, maslow, performanceplatform-big-screen-view, publisher, publishing-api, rummager, search-admin, search-api, 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: account-api, calculators, calendars, collections, content-store, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licensify, performanceplatform-big-screen-view, rummager, search-api, 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": [
      "bfeb8cab-4bdc-127e-a67a-8c0fea6ef517",
      "4495505b-4b90-1cdf-a5a4-b3adeae7bad5",
      "ed3cd8e6-cbd3-11c3-a450-e6dda3ce6e5d",
      "3daf01af-d8dd-1045-aefb-2ef9f0c41d94",
      "2c3c7a3a-aec3-1f6a-a54b-4aad1d71e255",
      "db6904a8-fcd3-1d49-ac28-c22a92cfeaed"
    ]
  },
  "base_path": "/8f81eaed-ea11-1fb7-a3de-1b3e6f10367a/4816aaa9-75c6-1813-af59-a6a7b3dcdb4f/55fb35ef-c31b-1ece-aab9-bf06ff1cbe91",
  "bulk_publishing": true,
  "change_note": null,
  "details": {},
  "document_type": "service_manual_homepage",
  "last_edited_at": "2012-07-03T15:16:29+00:00",
  "last_edited_by_editor_id": "netus et ac eros. sed sagittis et consectetur molestie tempor imperdiet purus nisl tristique fames ac malesuada pellentesque Mauris hendrerit porttitor in vel bibendum. ipsum a amet senectus turpis Aenean lectus Nam dolor Pellentesque mauris tristique habitant ultricies orci non eu risus Suspendisse volutpat aliquet. Quisque nibh tempor leo finibus lorem molestie eu risus Sed nibh. dolor",
  "phase": "live",
  "previous_version": "ultricies hendrerit turpis egestas. Nam vel habitant est. vel molestie orci nibh. Ut et sit Ut fames interdum. lectus sed dolor scelerisque. massa risus dolor Nam vestibulum. amet non consectetur Aenean sem tristique ac finibus adipiscing libero. bibendum. suscipit porttitor morbi Quisque risus sagittis molestie cursus imperdiet elit. Suspendisse ac eu Pellentesque volutpat et nibh senectus aliquet. tempor lorem ac nisl leo Duis eu non",
  "publishing_app": "smartanswers",
  "rendering_app": "whitehall-frontend",
  "routes": [
    {
      "path": "ac lectus tristique Ut sit ac sollicitudin purus ipsum interdum. hendrerit imperdiet finibus scelerisque. mauris amet ac vestibulum. nisl in risus malesuada sed porttitor eu molestie eu Aenean sagittis suscipit molestie fames leo Quisque vel aliquet. elit. cursus libero. turpis risus et at egestas. dolor adipiscing tempor",
      "type": "prefix"
    },
    {
      "path": "Ut",
      "type": "prefix"
    },
    {
      "path": "turpis nibh Aenean nibh. Ut Ut Lorem vestibulum. libero. Sed netus molestie bibendum. ac Suspendisse adipiscing ac interdum. Duis non leo mauris dolor imperdiet orci suscipit Mauris ipsum egestas. volutpat tristique et sit at eros. risus scelerisque. risus tempor cursus hendrerit Pellentesque in Nam ultricies pellentesque aliquet. non Quisque dolor porttitor et fames ac purus Nam",
      "type": "prefix"
    },
    {
      "path": "ac lorem fames dolor adipiscing sit Nam ultricies elit. ac molestie Sed et tempor non purus imperdiet interdum. turpis Ut vestibulum. sollicitudin consectetur et est. morbi eu hendrerit Pellentesque amet tristique dolor senectus mauris cursus bibendum. aliquet. pellentesque",
      "type": "prefix"
    },
    {
      "path": "amet porttitor in ipsum finibus interdum. lorem Mauris ac a volutpat eu vel est. massa dolor aliquet. cursus libero. et Nam adipiscing lectus non sollicitudin bibendum. vestibulum. suscipit Lorem vel netus scelerisque. et eu nisl ultricies risus interdum. imperdiet consectetur ac ac ac mauris nibh Duis malesuada Suspendisse Quisque habitant purus sem leo Ut tempor molestie nibh. sit dolor",
      "type": "exact"
    },
    {
      "path": "habitant sagittis imperdiet vel cursus lorem egestas. sed dolor ac morbi tempor Suspendisse nisl porttitor consectetur tempor Nam vel orci et a molestie risus mauris volutpat est. sollicitudin finibus Ut ac risus at scelerisque. massa tristique ipsum bibendum. lectus purus vestibulum. Lorem Aenean ac hendrerit nibh. interdum. non molestie et Mauris leo Duis tristique Quisque eros. ultricies elit. malesuada turpis fames ac adipiscing aliquet. libero. sit senectus in pellentesque interdum. eu amet non sem Ut dolor eu suscipit Sed nibh netus Pellentesque Nam",
      "type": "prefix"
    },
    {
      "path": "at Lorem orci sem lectus nibh Aenean Ut tristique amet aliquet. sed est. scelerisque. ipsum cursus sollicitudin et vel senectus adipiscing dolor lorem nisl mauris egestas. eros. volutpat pellentesque bibendum. ac interdum. ac dolor Mauris hendrerit risus non ac morbi eu ac turpis eu porttitor Sed ultricies Ut tempor risus elit. finibus libero. netus",
      "type": "exact"
    },
    {
      "path": "Lorem mauris Mauris eu lectus molestie interdum. morbi volutpat et vel Pellentesque Quisque non",
      "type": "exact"
    }
  ],
  "schema_name": "homepage",
  "title": "Ut in Mauris Lorem interdum. sit molestie Aenean ac vestibulum. vel malesuada tempor purus senectus risus ac Quisque at Sed eu eros. sed fames lorem consectetur bibendum. scelerisque. leo adipiscing sagittis ac ultricies habitant morbi tempor egestas. elit. et libero. finibus"
}

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

Attributes

bulk_publishing
boolean
links
object
popular_links
 Collection of links to be used to display popular links on homepage
previous_version
string

View this schema on GitHub

Random example

{
  "bulk_publishing": true,
  "links": {},
  "previous_version": "eu Quisque sed pellentesque ultricies dolor Nam imperdiet vel dolor lorem a tempor libero. molestie volutpat Suspendisse Duis ac sagittis Ut porttitor nibh. ipsum aliquet. nibh cursus non est. leo interdum. massa tristique eros. risus finibus Aenean ac scelerisque. sem risus Mauris at ac adipiscing morbi elit. senectus vestibulum."
}