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-publisher, 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

{
  "base_path": "/93513c7e-e65b-4ddf-92a7-33b17bb42729/3fa9503e-b95e-4aff-bb9d-4077e1fdef91",
  "content_id": "52cd7866-5029-4b83-941d-c9f3074efec9",
  "content_purpose_document_supertype": "leo sollicitudin tempor Nam Quisque scelerisque. ac Duis dolor malesuada nisl fames molestie finibus, elit. egestas. eros. tristique et sem suscipit ac tristique molestie Ut orci bibendum. et risus lorem Pellentesque non interdum. est. nibh. dolor",
  "content_purpose_supergroup": "Quisque libero. eu risus et interdum. consectetur Nam scelerisque. elit. interdum. lectus eros. est. morbi orci pellentesque suscipit Ut ac nibh sem volutpat nisl massa imperdiet mauris ipsum fames ac ultricies vel a sed vestibulum. senectus adipiscing netus Sed habitant tempor Mauris ac molestie dolor sagittis",
  "description": null,
  "details": {
  },
  "document_type": "homepage",
  "links": {
    "level_one_taxons": [
      {
        "analytics_identifier": null,
        "base_path": "/f5839d82-041b-484a-9e9e-dbc0dc97ea92/2ad8a132-d62c-4f6c-aff8-5401449a5680/2e25dc9b-22db-45ec-ab03-107ecbd74114/d672c2cf-b1fb-4dd1-aa5a-5907683b5cf8/f050dbaa-171b-46bc-b66f-6de07828a317",
        "content_id": "97206f48-c658-4e83-8564-ef3f5a952e1d",
        "document_type": "tempor ac Sed lorem porttitor",
        "locale": "hu",
        "public_updated_at": "2019-01-04T21:09:00+00:00",
        "schema_name": "ipsum volutpat Nam sed orci Quisque morbi suscipit netus libero. eu Ut et tristique sagittis mauris interdum. non habitant non Lorem dolor ac fames Nam Ut Mauris risus dolor interdum. porttitor Duis hendrerit, vel a sem leo lectus nisl Aenean tristique cursus sit turpis nibh ac finibus, vel egestas. molestie ac consectetur et bibendum. malesuada imperdiet purus risus Sed amet, eros. est. nibh. lorem elit. aliquet. ultricies Suspendisse vestibulum. scelerisque. massa ac tempor tempor at",
        "title": "molestie vel"
      }
    ],
    "policies": [
      {
        "analytics_identifier": "massa mauris dolor adipiscing et senectus scelerisque. Suspendisse suscipit leo Pellentesque eu ultricies sit sollicitudin tempor malesuada finibus, tristique Aenean vel in, ac eu Nam imperdiet lectus Quisque sed Lorem non lorem netus habitant libero. orci ac nibh tempor Ut nisl nibh. purus risus est. elit. sem non porttitor risus Ut vestibulum. amet, dolor aliquet. pellentesque volutpat Sed Duis ipsum bibendum. ac sagittis tristique hendrerit, at molestie morbi ac vel a Mauris fames et cursus turpis interdum. interdum. molestie egestas. eros. Nam consectetur",
        "api_path": "/5d399012-6381-4712-9914-b1a5e0e707f0/93391be1-36a6-47eb-8e1f-d8ab9de572df/bc3fc77f-d7d5-438a-9b43-22c09f062ac8",
        "base_path": "/2da70e41-6dbc-40d1-b777-272c45a36539/5887ebe3-7130-4664-b5a6-99265f96661d/044e3d87-3aee-4b6c-899b-dcab2af4f8be/2c53880d-1cb8-41db-8acc-ee261800d6ce",
        "content_id": "daee9b23-a243-4b7d-8419-c79b692fe613",
        "locale": "ms",
        "public_updated_at": null,
        "title": "a cursus Pellentesque Aenean sit et nisl amet, in, Lorem molestie ipsum Nam et dolor turpis eu porttitor risus interdum. senectus aliquet. tristique Ut vel Sed bibendum. scelerisque. ac vel ac volutpat eu Ut elit. non Suspendisse pellentesque adipiscing mauris sem fames Duis imperdiet ac Mauris interdum. vestibulum. sollicitudin dolor orci nibh hendrerit, ac at risus tempor consectetur non eros. libero. tempor lectus leo sed massa nibh. habitant Quisque molestie ultricies netus malesuada purus tristique egestas. lorem Nam suscipit finibus, est. sagittis"
      },
      {
        "base_path": "/e65a7c2a-9677-445c-a3f9-501e15a19deb",
        "content_id": "53bef090-f91e-48fb-a1f5-91282bf9d0d1",
        "links": {
        },
        "locale": "en",
        "title": "lorem tempor cursus ac finibus, at Mauris purus vel nibh. sollicitudin fames ac tristique nibh netus ac est. volutpat aliquet. non malesuada vel Aenean non Lorem sed scelerisque. morbi interdum. molestie tristique Suspendisse libero. hendrerit, Nam eu ipsum Quisque dolor orci eu sit bibendum. risus molestie pellentesque porttitor sagittis turpis adipiscing ultricies vestibulum. sem consectetur Ut imperdiet Nam in, elit. et massa"
      },
      {
        "api_path": "/2998a8c8-6f91-43c3-94ab-9f965ced1905/081c5cdd-0a69-4285-a0ce-ced179d0cf90/96458373-7ca6-40b1-a84b-9c6eb1086c10/a2ef5af2-4471-4e8e-92ed-ef1b00357e64/ac61717b-32f5-4f5b-ba06-34e0ff33a709",
        "base_path": "/353a101b-0f7f-48c9-a760-466d1f0715fb/e1af3af2-0243-4f22-8f26-7534879336b4",
        "content_id": "2f909d38-f378-4789-8558-d8bf1cc971d0",
        "document_type": "ultricies molestie",
        "links": {
        },
        "locale": "si",
        "public_updated_at": "2018-09-26T02:48:05+00:00",
        "title": "dolor hendrerit, Lorem interdum. tempor"
      },
      {
        "api_path": "/ab5ed042-9f6d-495e-a884-bf03aa74c6ee",
        "api_url": "http://example.com/15a135e0-0c6c-4cd9-83b2-2c2bce1c4ecb/f1bbdadb-4cf0-443f-907a-81338b2704a2/db0757cd-cb40-4fce-ba18-62164d9f23b6#dba009e07aea9415803c3b76cf0258b8",
        "base_path": "/3f7fc157-486f-49cc-b6b6-9bb54aa4d351/c37b9735-ae3b-409b-ab3a-f02a4af8ea98/2a274c80-5df6-4646-a227-b2cf59f6d014/9735a944-221e-43b9-80c2-feef3cb43e8d/8623b2b3-51fd-45c9-8f8c-81380dbb200c",
        "content_id": "68c4926c-9b75-4a09-920f-44a0300ff13a",
        "links": {
        },
        "locale": "sk",
        "schema_name": "tempor lorem ac senectus fames Pellentesque libero. eros. malesuada Ut finibus, non cursus sollicitudin ipsum dolor nibh nisl imperdiet risus non Nam lectus sed egestas. ultricies adipiscing amet, vel Nam sit sem interdum. habitant Ut sagittis Sed Aenean in, vel Duis porttitor orci tristique suscipit dolor mauris est. Quisque tempor leo bibendum. ac eu pellentesque interdum. scelerisque. volutpat Mauris netus et et purus at risus eu Suspendisse hendrerit, massa ac consectetur ac nibh. aliquet. elit. vestibulum. Lorem tristique turpis morbi molestie a molestie",
        "title": "vel senectus elit. Nam Ut leo a Ut cursus ultricies ac eu libero. imperdiet morbi Nam adipiscing tristique ac mauris finibus, lectus porttitor consectetur massa tempor aliquet. molestie sem bibendum. purus turpis sollicitudin interdum. Lorem et eros. suscipit Suspendisse sit nisl egestas. Aenean sed molestie amet, habitant et"
      },
      {
        "analytics_identifier": "ultricies mauris eu risus molestie fames ac sem Nam Pellentesque lectus egestas. malesuada morbi tristique est. finibus, dolor tristique pellentesque turpis adipiscing",
        "api_url": "http://example.com/bb0a01a1-fe29-4db9-8bc9-233ea12e4c58/c81c8427-f994-49f3-bd88-56e43051c234#559dceb825c0383adfa2395cd2b157c6",
        "base_path": "/dc8ccbb3-aa79-4149-8490-57ffa5fb37b3",
        "content_id": "2fa87197-8bdc-4b81-b878-5c1d8f8698ed",
        "links": {
        },
        "locale": "bn",
        "title": "finibus, est. libero. vel ac turpis Duis malesuada non Suspendisse risus molestie Quisque Mauris ac vestibulum. Nam in, tempor Ut sit Sed imperdiet scelerisque. aliquet. Aenean Nam eros. ac senectus netus risus Pellentesque nibh. sed et sollicitudin sagittis hendrerit, purus amet, massa fames tristique interdum. molestie vel sem eu interdum. adipiscing lorem egestas. consectetur volutpat",
        "web_url": "http://example.com/d017046a-5ef2-477f-bd48-fe63f2bcae0c/4d8acf64-823d-409d-9aa3-301423d51403/342891b4-5336-4ce3-ac10-936d40bc4378/620bfe84-457d-489a-b1e2-acc9b331aefd/af65872b-f527-44fc-8a93-a96391cf870e#b794e4a7ca38b1894e76b03e2899c436"
      },
      {
        "analytics_identifier": "interdum. sed nibh et Suspendisse tempor sit Duis turpis habitant tristique tristique cursus ultricies imperdiet egestas. sagittis dolor orci dolor est. vestibulum. ipsum massa pellentesque Pellentesque Nam Lorem eros. consectetur senectus mauris fames adipiscing risus eu Mauris eu ac Ut risus malesuada morbi interdum. leo lectus in, lorem Ut Sed vel Quisque non ac finibus, elit. Nam sem scelerisque. purus aliquet. molestie nibh. volutpat ac a nisl Aenean ac molestie porttitor netus",
        "api_path": "/3a6acb96-a2cf-4b53-bd04-fd1bc9906be3/6c8a7610-fdfd-4483-8ffa-110e6bf94d8b/23e7fd40-aecc-427e-9ebe-84a90f035f65/490ed1e4-a8d6-4bad-9c20-045b75dc575f",
        "api_url": "http://example.com/18626175-e1e8-4d89-9f75-cfb86979e071/033281a8-5069-449d-a547-60f24bd08207/f4b74cdf-fef6-42e1-a62c-6ffd28c34d4b#79960a8266532be769fcb41eb17ce013",
        "base_path": "/79d9eff5-ec1f-467d-a8c6-2c28d31675cd/5f5faf8f-10b9-4db7-a13c-0d53c73e1443/a29edc50-e4e5-4d24-b89e-5317b35a3266",
        "content_id": "3dee8bf8-c443-4ff9-9553-a9bfa6d532db",
        "locale": "tr",
        "public_updated_at": null,
        "schema_name": "suscipit libero. dolor lorem tristique egestas. Lorem vestibulum. turpis Nam Sed Suspendisse aliquet. malesuada adipiscing vel interdum. fames netus dolor pellentesque Pellentesque risus volutpat nibh. purus risus Duis molestie ac sem Ut consectetur sit leo amet, nisl molestie cursus Quisque a in, sagittis ac sed scelerisque. ipsum imperdiet eros. morbi Aenean eu non hendrerit, massa sollicitudin vel finibus, ac interdum. orci elit. habitant at nibh tempor porttitor eu ac et bibendum. Mauris tempor tristique lectus et Nam Ut ultricies senectus est. non mauris",
        "title": "tristique nibh. consectetur fames interdum. bibendum. elit. libero. Pellentesque aliquet. risus malesuada Quisque eu cursus non eros."
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/181384df-6555-49f8-a2b9-e40dcf210b4d#bf7a9aaded98ce8cdfed6bee7d4f68aa",
        "base_path": "/de2723eb-e950-45c5-8fec-2e9b7bfe894f/55c04a5d-bd2b-43b1-9afa-fc279da318b2/2ceb85d1-4221-47e3-ae72-3b1493a8a181/8a1ce91d-5d1c-4940-a666-a137ee7d2ebc/6a8a0669-8019-4f22-a79f-b6b9b059310f",
        "content_id": "c1ebbad6-ff9e-46b0-a8c2-7c74a0ffd16f",
        "document_type": "interdum. Mauris non lectus non a sem sagittis tempor bibendum. dolor risus ipsum netus elit. lorem cursus suscipit nibh Ut ultricies consectetur ac massa libero. ac habitant orci Sed vestibulum. dolor sit eros. malesuada hendrerit, tempor tristique et volutpat nisl adipiscing vel Duis pellentesque aliquet. sed risus Ut Nam Nam eu fames",
        "links": {
        },
        "locale": "es",
        "title": "dolor nibh. ac tempor non habitant sollicitudin ultricies senectus Ut massa ac vel molestie risus et molestie consectetur ac Mauris sem Pellentesque elit. risus scelerisque. sagittis tristique Aenean sit et malesuada cursus a adipiscing egestas. Duis Nam Suspendisse fames mauris pellentesque lectus nibh vestibulum. finibus, interdum. ac vel nisl porttitor leo tristique at tempor lorem amet, sed dolor Lorem Quisque Sed est. ipsum eu imperdiet netus orci Ut turpis aliquet. interdum. non in, libero. volutpat",
        "web_url": "http://example.com/9d7c2fe6-5fbd-44ce-99be-90dd6d6239c3#2d9137fcd2c3ca906c11f6184b38199a"
      }
    ],
    "policy_areas": [
      {
        "api_path": "/d5e225a2-e74a-4f48-9041-f4d1e5608e44/7a3190bb-7e87-4cc2-bdd8-b63b75dbd05e/f0f005b9-8740-4f36-a669-974365419214/a1fd7cb0-31cc-46e9-a371-106e17eabfca",
        "base_path": "/45916c32-88a8-491d-8f57-b83f2cb8aaa6/bc86c3ce-7817-45d7-bcd6-379f7dff1121/65c18279-ed10-418d-9d95-a11f07ec2a64",
        "content_id": "ae9dfa86-a515-44d7-ba7b-ec6a9b28a663",
        "document_type": "hendrerit, turpis risus suscipit massa Lorem leo sed egestas. sollicitudin sem libero. malesuada tempor Quisque orci et dolor nibh. vel non sagittis ac dolor porttitor ultricies molestie amet, Ut sit ac tristique ac risus est. imperdiet aliquet. eu tristique bibendum. purus mauris ipsum Ut fames scelerisque. ac Nam consectetur Mauris pellentesque a eros. finibus, netus morbi adipiscing lorem lectus interdum. cursus at vel habitant et Aenean volutpat in, molestie Pellentesque vestibulum. elit. nisl Duis interdum. Sed nibh tempor senectus Suspendisse non Nam eu",
        "links": {
        },
        "locale": "ms",
        "public_updated_at": "2018-11-24T02:56:14+00:00",
        "title": "sollicitudin dolor leo Nam morbi finibus, dolor libero. Ut sed a orci ac habitant sagittis tempor turpis porttitor adipiscing Nam senectus et Lorem ac tempor Pellentesque nisl Quisque eros. mauris lorem pellentesque vel eu Ut massa ipsum tristique tristique vestibulum. et consectetur ac non",
        "web_url": "http://example.com/b0ae7ecf-4bc5-45df-8c25-a1f4e224f7ed/988885a5-7ce5-4abc-8744-d7bea036ffe2/13cd7085-f967-450a-9281-5ae66ec7f6cd#fd6e1624b145e51e4b94d94857036a1e"
      },
      {
        "api_path": "/cf75771b-c8a4-4d41-bd6f-7689ea7393e8/6ec0bb30-5e7c-4cf7-8fe8-f3b64832a211",
        "base_path": "/3cb791a6-35d8-456b-8a4f-b31af50b9bc7/d76e2560-5bdb-410d-b854-68bf80f2bdbd",
        "content_id": "0363de37-9412-4068-9f66-4a49d2863dbc",
        "locale": "ja",
        "public_updated_at": null,
        "schema_name": "egestas. porttitor orci lectus Sed ac molestie sem nisl tempor dolor libero. eu mauris vestibulum. risus Ut et suscipit sed pellentesque amet, tristique ac fames sollicitudin ipsum interdum. molestie leo netus Ut Nam eu hendrerit, cursus interdum. Quisque Pellentesque ac eros. turpis consectetur et tempor elit. in, sit non scelerisque. vel Suspendisse a purus volutpat habitant Nam vel adipiscing non senectus est. Duis ultricies risus imperdiet massa aliquet. malesuada dolor Lorem ac Mauris morbi tristique lorem finibus, nibh sagittis",
        "title": "consectetur non Nam elit. sollicitudin risus molestie molestie Mauris nibh nisl Suspendisse Quisque amet, est. sem ipsum eros. libero. vel ultricies Duis morbi dolor scelerisque. senectus eu tempor vestibulum. Aenean Ut purus eu Nam egestas. sagittis Ut ac ac tristique porttitor nibh. imperdiet lorem ac non et risus tempor adipiscing interdum. leo bibendum. at in, mauris sed pellentesque fames hendrerit, massa Sed netus aliquet. cursus Lorem",
        "web_url": "http://example.com/3e4fe61a-af2c-4f58-9b3c-58b20ed63ed4#3d6f6a407cce905a42dbd9322d199f42"
      }
    ],
    "related_to_step_navs": [
      {
        "api_url": "http://example.com/1b94682f-ade5-41f4-b712-d4fbce705635/d72075c0-b2b9-4069-98d1-07353f228363/d77a03a5-871d-4c86-b52d-fa2ed9866afd/f919cd74-bc9d-44e5-b18b-e5469cd0d6c2/95386f42-7583-42a3-a5c7-829735b18926#b108205d8543483b1d9dc60e93fc37a2",
        "base_path": "/c8673fd8-4cf5-4718-bbf5-b56e28b58270/4149c2db-1f72-4d5f-a000-63820f7a9891/db7b37c1-3ec3-416d-971f-1ff9f79f228d/dcd26e39-4b3c-46e3-bcff-ba159ffab974",
        "content_id": "626c82e7-e90f-4a09-9d14-249d8f506b24",
        "links": {
        },
        "locale": "sr",
        "public_updated_at": null,
        "schema_name": "eros. ipsum purus Sed libero. porttitor tempor morbi massa Mauris lorem ac sem molestie nisl Nam et sit aliquet. cursus Aenean interdum. imperdiet ultricies habitant ac et non risus interdum. nibh. suscipit pellentesque in, Suspendisse vel tempor adipiscing sollicitudin molestie",
        "title": "Pellentesque est. nibh. sem in, Sed Duis Ut bibendum. non Lorem suscipit tempor mauris Mauris a tempor lectus interdum. cursus molestie ac ac ipsum at dolor non Nam consectetur eu risus tristique imperdiet porttitor egestas. scelerisque. netus malesuada vestibulum. Aenean sed Nam adipiscing ultricies Suspendisse lorem interdum. purus ac senectus sagittis",
        "web_url": "http://example.com/b4d23000-f155-44c4-baf6-83f0e0c63d1c/eb57dec6-dfdc-4eac-98c7-faede38d219c#3768136c387b5c5a2d4c10772059ff81"
      },
      {
        "base_path": "/5257e63b-89f5-4850-9f40-5a1158b2e814/b2c7f602-5f4b-4c60-ad42-d08e9ca9c17b",
        "content_id": "ef86320a-4415-4b84-a81a-bc9c510db9fd",
        "document_type": "aliquet. tempor sagittis nibh. tristique Quisque lectus a massa Ut nisl dolor scelerisque. tempor sollicitudin egestas. orci Sed Duis leo hendrerit, Ut at dolor Lorem vestibulum. molestie lorem ac malesuada Nam Nam elit. non",
        "links": {
        },
        "locale": "el",
        "public_updated_at": null,
        "schema_name": "egestas. amet, Suspendisse tempor ipsum molestie tristique tristique aliquet. interdum. malesuada Mauris fames Aenean Quisque habitant Pellentesque leo in, nibh et ac ac ac lorem non eros. sed volutpat Ut consectetur Duis netus ac Nam Lorem turpis risus sit bibendum. scelerisque.",
        "title": "",
        "web_url": "http://example.com/956c297a-1b85-4c0d-9a13-b3017dc44ae3/5d67d497-257b-4fa3-8baf-383f9dcfd819/c91aa12c-12da-416e-90c7-df9243dc759b/59e99c0f-7cc8-4579-85ae-1881393d6e50#93ad095ae9f4c512871ad5361f0c592e"
      },
      {
        "analytics_identifier": "senectus interdum. nibh eu ac vel ac mauris suscipit molestie risus in, eu libero. et hendrerit, a sed eros. tempor leo ultricies aliquet. amet, molestie risus Nam Nam egestas. interdum. Ut nibh. scelerisque. dolor Mauris non turpis tempor pellentesque at lectus sollicitudin ac nisl consectetur massa vestibulum. sem imperdiet morbi sagittis Sed ipsum non porttitor Duis fames finibus, Lorem bibendum. est. ac tristique cursus Quisque dolor Suspendisse purus orci Pellentesque Aenean volutpat",
        "api_path": "/6a117701-8b83-4b9c-9a48-591bff6e3215/b9bb3784-bba6-4804-977a-554ec365f30e",
        "base_path": "/62a3d669-adac-4a6a-b130-5f2981461bfd/068bb8c0-7fe2-4221-babf-273686a1d55c/4ac96c81-46cf-42a8-b349-22e7986cf47b",
        "content_id": "98dd2d0f-4855-441e-b68e-b146528ad829",
        "document_type": "sollicitudin risus interdum. interdum. eu sed mauris purus ultricies Sed porttitor consectetur tristique est. massa molestie dolor vestibulum. amet, non Aenean et tristique suscipit fames nibh. Nam Nam turpis ac vel Pellentesque Suspendisse a bibendum. Ut pellentesque morbi volutpat finibus,",
        "locale": "sr",
        "schema_name": "egestas. Suspendisse vel purus Quisque risus et nibh. Pellentesque massa turpis dolor Nam molestie sagittis ac Nam sit Lorem habitant eu adipiscing sem nisl tempor finibus, est. orci ac vel amet, Ut non imperdiet tristique tempor at aliquet. pellentesque Mauris cursus elit. eu porttitor et interdum. ipsum a dolor leo morbi bibendum. Ut sed mauris ultricies risus interdum. libero. consectetur Sed ac malesuada vestibulum. suscipit nibh ac in, senectus tristique",
        "title": "amet, fames purus sit adipiscing vel ultricies interdum. et aliquet. tristique cursus consectetur Suspendisse nibh. sollicitudin"
      }
    ],
    "topic_taxonomy_taxons": [

    ]
  },
  "locale": "et",
  "navigation_document_supertype": "porttitor interdum. dolor libero. ipsum lectus hendrerit, habitant molestie tempor Lorem orci sed non non amet, ac a cursus pellentesque vestibulum. vel nisl est. Pellentesque turpis tempor interdum. nibh sagittis nibh. in, consectetur finibus, massa purus malesuada vel et Nam Ut volutpat Sed egestas. ac sem eu lorem ultricies et Mauris dolor fames eros. leo Aenean bibendum. morbi senectus elit. ac netus Duis Ut imperdiet mauris molestie tristique sit sollicitudin Suspendisse Quisque ac adipiscing tristique at eu Nam suscipit scelerisque. risus aliquet. risus",
  "public_updated_at": "2018-10-21T00:13:42+00:00",
  "rendering_app": "email-alert-frontend",
  "scheduled_publishing_delay_seconds": 9,
  "schema_name": "homepage",
  "title": "finibus, tempor at et sagittis eu et Ut vel purus sit dolor consectetur aliquet. hendrerit, egestas. lorem vel morbi ac non nibh. dolor sollicitudin Duis Aenean tristique interdum. cursus ac scelerisque. ac mauris volutpat ultricies pellentesque elit. nisl tempor interdum. molestie Ut vestibulum. est. fames ipsum netus Nam risus in, suscipit eu porttitor Suspendisse libero. eros. Lorem habitant senectus tristique molestie orci adipiscing Sed leo risus sed amet, massa a Nam non ac bibendum.",
  "updated_at": "2018-10-09T11:32:27+00:00",
  "user_journey_document_supertype": "Nam eu libero. et Ut a est. aliquet. imperdiet eu ultricies consectetur hendrerit, purus Quisque nibh. interdum. massa Nam Pellentesque fames dolor non Ut Mauris volutpat morbi malesuada elit. sit interdum. bibendum. tempor leo vel vestibulum. at dolor in, adipiscing ac sagittis ac molestie tristique pellentesque orci ac finibus, sed risus Duis tempor porttitor Aenean Sed netus scelerisque. ipsum senectus amet, tristique cursus mauris vel risus",
  "withdrawn_notice": {
  }
}

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.
bulk_publishing
boolean

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-publisher, 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": {
  },
  "analytics_identifier": "et sem a eu sollicitudin Lorem lectus tempor Suspendisse scelerisque. sit at lorem interdum. pellentesque purus cursus",
  "base_path": "/10703224-57ba-417d-9efa-ccc1a2a9f0a9/a675e380-a72f-4ff9-b995-8a6182ceaf08/e3f21b65-04ea-4b73-a1ca-98dfdf97f8dd",
  "change_note": null,
  "description": null,
  "details": {
  },
  "document_type": "service_manual_homepage",
  "first_published_at": "2018-11-30T12:41:52+00:00",
  "links": {
  },
  "phase": "beta",
  "previous_version": "",
  "publishing_app": "hmrc-manuals-api",
  "rendering_app": "email-campaign-frontend",
  "routes": [
    {
      "path": "Aenean purus vel risus Nam netus adipiscing pellentesque sem fames et est. leo hendrerit, Suspendisse bibendum. tempor amet, mauris interdum. Ut sed turpis libero. egestas. at non Pellentesque tristique eu vestibulum. nibh ac habitant elit. lectus non sit risus eu molestie ipsum eros. volutpat Nam ultricies Sed senectus Lorem interdum. ac consectetur Mauris porttitor suscipit Duis tempor imperdiet dolor ac morbi malesuada molestie sollicitudin",
      "type": "exact"
    },
    {
      "path": "Nam sollicitudin Duis Ut Lorem pellentesque leo ipsum imperdiet habitant interdum. tempor morbi Quisque Suspendisse eu non ac lorem et sed tempor egestas. eros. ultricies elit. orci nibh vel hendrerit, Nam risus molestie sagittis Mauris volutpat purus amet, cursus fames senectus sem ac sit lectus molestie eu massa scelerisque. bibendum. Pellentesque ac adipiscing finibus, tristique mauris turpis est. nisl porttitor vel Ut ac aliquet. in, Sed netus dolor malesuada non tristique interdum. Aenean libero.",
      "type": "prefix"
    },
    {
      "path": "tristique cursus ipsum netus Duis purus senectus risus Lorem sed interdum. Quisque hendrerit, scelerisque. Ut eros. bibendum. Aenean non adipiscing egestas. sollicitudin dolor risus Pellentesque habitant imperdiet est. consectetur at lorem Suspendisse amet, lectus ultricies sit dolor turpis nisl suscipit fames tempor libero. ac malesuada molestie tristique Mauris leo et finibus, ac tempor vel nibh. vestibulum. nibh molestie",
      "type": "exact"
    },
    {
      "path": "mauris sagittis non habitant cursus Sed risus ac et consectetur senectus purus Suspendisse dolor libero. Mauris netus ac Nam sem morbi lorem vestibulum. scelerisque. sollicitudin dolor sit amet, hendrerit, finibus, tempor",
      "type": "prefix"
    },
    {
      "path": "dolor orci amet, pellentesque tempor senectus vel cursus nibh. tristique netus a finibus, volutpat nisl lectus aliquet. sit elit. est. Nam eu vestibulum. sagittis ac adipiscing lorem ac sollicitudin eros. Mauris in, porttitor Nam Pellentesque turpis purus Lorem Aenean ac tristique tempor nibh Ut mauris ipsum imperdiet massa Duis risus sed non suscipit sem non Suspendisse et et vel dolor molestie leo habitant hendrerit, interdum. ac Sed eu ultricies risus egestas. morbi interdum. at bibendum. scelerisque. malesuada molestie Quisque libero. fames consectetur Ut",
      "type": "exact"
    },
    {
      "path": "cursus fames senectus ipsum dolor nisl volutpat adipiscing Aenean Mauris lectus et Nam non orci nibh. est. tristique porttitor massa imperdiet ac interdum. et aliquet. eu Nam Sed sit ac Ut dolor ultricies Pellentesque egestas. a elit. scelerisque. sed sem molestie sagittis molestie Suspendisse amet,",
      "type": "exact"
    },
    {
      "path": "nibh Ut habitant lectus libero. Ut tempor ac sem Pellentesque at suscipit consectetur est. nibh. sollicitudin Nam amet, ipsum malesuada Quisque leo hendrerit, interdum. vestibulum. turpis et netus Duis ultricies Nam volutpat nisl senectus interdum. massa lorem non pellentesque elit. Sed in, purus egestas. fames non eros. bibendum. ac aliquet. Suspendisse Lorem dolor ac",
      "type": "prefix"
    },
    {
      "path": "sit vel hendrerit, Nam eu tristique senectus leo libero. Lorem risus tempor turpis eu egestas. massa sed at",
      "type": "exact"
    },
    {
      "path": "bibendum. ac mauris massa amet, vestibulum. est. sollicitudin at elit. orci ac sit Nam tempor senectus interdum. nisl a tempor et interdum. risus adipiscing consectetur ac molestie dolor sem Aenean vel habitant volutpat nibh. non non Mauris tristique Ut nibh Lorem in, Ut lectus pellentesque hendrerit, et turpis sagittis Sed eros. malesuada ipsum ac Duis Nam molestie porttitor lorem scelerisque. fames Pellentesque vel libero. eu eu sed dolor cursus egestas. morbi imperdiet Suspendisse leo risus aliquet. netus ultricies tristique purus Quisque suscipit finibus,",
      "type": "exact"
    },
    {
      "path": "Sed Ut sit non lorem Duis vestibulum. egestas. dolor Ut ipsum dolor ac sem massa sed adipiscing sollicitudin Lorem lectus elit.",
      "type": "exact"
    }
  ],
  "schema_name": "homepage",
  "title": ""
}

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

Attributes

bulk_publishing
boolean

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "bulk_publishing": true
}