Table of contents

Schema: unpublishing

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
alternative_url
["string", "null"]

change_history
array

explanation
["string", "null"]

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.
unpublished_at
string

document_type
string

Allowed values: unpublishing
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
mainstream_browse_pages
Powers the /browse section of the site. These are known as sections in some legacy apps.
meets_user_needs
The user needs this piece of content meets.
ordered_related_items
Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.
ordered_related_items_overrides
Related items, can be any page on GOV.UK. Overrides ‘more like this’ automatically generated links in the beta navigation.
organisations
All organisations linked to this content item. This should include lead organisations.
parent
The parent content item.
policies
Link type automatically added by Publishing API
policy_areas
A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
The organisation that published the page. Corresponds to the first of the 'Lead organisations’ in Whitehall, and is empty for all other publishing applications.
taxons
Prototype-stage taxonomy label for this content item
topics
Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.
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, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, designprinciples, 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
schema_name
string

Allowed values: unpublishing
title
string

updated_at
string

user_journey_document_supertype
string
Document type grouping powering analytics of user journeys
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "base_path": "/e070ee61-dfbb-4280-81b8-d8ce08c9a3e6/48b0b7eb-ad3a-452b-8a85-b355e18aeeb7/542d1c83-2d18-4951-b037-0d1237f02c1e/e10d027b-27f5-4154-a701-7ad9570cf79c/b3648241-c528-48c5-8d46-387d595013c8",
  "content_id": "b9c6e43e-a0ab-44b8-934f-958c1d5aa71e",
  "description": null,
  "details": {
    "alternative_url": "http://example.com/3952bfba-6852-429d-8c9a-49260d29638f/d0956ef3-2fd2-4b07-875f-c1e0374d8895/dec557b1-e5f0-4af7-9ab2-ec0a265324fd/1a3727a7-79c1-44c9-821a-ee27daf11159/36c0f78b-1b5b-431a-8563-c76cd64ed807#06ce68c21e16a21f3f05f8ee799b15d7",
    "explanation": null,
    "public_updated_at": "2017-09-13T18:31:26+00:00",
    "unpublished_at": "2017-11-17T23:04:08+00:00"
  },
  "document_type": "unpublishing",
  "email_document_supertype": "ac pellentesque Suspendisse sagittis Duis sit interdum. tempor adipiscing interdum. non netus tempor a eros. nibh. purus turpis libero. Quisque molestie Ut malesuada dolor et orci ac scelerisque. Sed morbi elit. et Aenean molestie Pellentesque risus at hendrerit, cursus mauris est. sollicitudin nisl porttitor tristique Nam ipsum lectus tristique nibh",
  "links": {
    "policy_areas": [
      {
        "api_path": "/cdf3cba2-463b-466b-9dc5-91c7a34fea2c/5bf9a6c9-dc3c-41c3-b5f4-497a578f61af/2aa74737-8572-4b0c-b84d-283eedc3e723/11229039-d4d4-45b5-975c-5161ea51eeda",
        "api_url": "http://example.com/ddfecd3f-a810-4519-aa6c-10025f0ac314/9e7f02d4-c336-476d-8241-28a6304b7d16#09187e1257d863b68da94dcf89682549",
        "base_path": "/a25c4d38-2059-43c1-a2b6-12a08a25fd3f/39e864f6-1235-4f09-aaa4-51306ea6f38c/65b11e47-322a-4a05-98d8-e5382bfbcf88/df421f79-4adf-43b2-aaf2-e9b7822bb49e",
        "content_id": "d62fec28-bfe4-451a-ab27-9575d0e11b10",
        "document_type": "finibus, sed adipiscing suscipit Duis massa tempor pellentesque Pellentesque nisl dolor lorem interdum. amet, orci dolor",
        "locale": "fa",
        "public_updated_at": null,
        "schema_name": "massa consectetur Aenean sollicitudin imperdiet et dolor vestibulum. ac tristique Lorem aliquet. elit. ac fames molestie dolor habitant Sed non purus lorem vel sem leo sit Nam senectus bibendum. netus morbi et tempor suscipit pellentesque eu risus malesuada vel tempor a Quisque orci eros. ac Pellentesque interdum. scelerisque. interdum. ac nibh. volutpat sed nibh finibus, eu Suspendisse sagittis egestas. non Mauris ipsum Nam risus in, turpis est. at amet, porttitor adipiscing mauris libero.",
        "title": "Aenean hendrerit, ac interdum. leo interdum. cursus nibh. Nam sollicitudin libero. lectus ipsum mauris turpis sagittis tempor Sed molestie eros. non in, orci purus non Ut nibh elit. habitant pellentesque Pellentesque ac ac Mauris Duis Quisque et sed aliquet. suscipit tristique scelerisque. molestie dolor vel massa finibus, volutpat vel vestibulum. lorem et ultricies fames Suspendisse tristique ac egestas. tempor dolor Lorem morbi risus"
      },
      {
        "analytics_identifier": "senectus bibendum. Nam interdum. egestas. tristique sagittis tempor lorem vestibulum. ac mauris non ac nibh. Duis netus Mauris eu orci molestie massa nibh finibus, habitant Ut Pellentesque tempor Suspendisse Nam sit lectus turpis aliquet. suscipit ac libero. dolor Aenean Ut risus in, consectetur porttitor scelerisque. fames amet, hendrerit, dolor purus ac ultricies et non cursus et Sed elit. molestie volutpat eu malesuada vel interdum. ipsum risus a sem at sed tristique adipiscing sollicitudin",
        "api_path": "/ef43eb59-8327-4220-8598-90e9f96ad990/f4573432-eec8-4e19-9a30-37bffe8611f5/e60e997e-16c8-4419-a058-73afe07bb82a/ff7e94b1-2bbb-4e81-b9c2-b2d26ab0180e/3df122a6-8477-41e4-8a3f-028c92afd6f4",
        "base_path": "/349976ef-2128-4bf7-abc8-43a5c33e57fb/634d5bad-ac5d-4d8f-a7fe-601f97a24d03/19fd4ee0-60c4-4fe2-964b-4b7ef81b5ae6/27f8734e-da30-46ef-8358-fdb7a90418e5",
        "content_id": "ee8e1284-f600-4bf2-bdf4-5009f4bcf84b",
        "locale": "bn",
        "schema_name": "non sagittis et suscipit Pellentesque nisl cursus tristique dolor Ut bibendum. Mauris Aenean tempor Ut orci ac dolor volutpat risus consectetur lectus purus finibus, molestie risus vestibulum. Nam ultricies nibh. netus massa senectus adipiscing Suspendisse non lorem at ipsum a ac porttitor tempor malesuada libero. eu sem sed scelerisque. amet, imperdiet interdum. Quisque habitant morbi ac vel vel",
        "title": "adipiscing ac vel vel Quisque imperdiet volutpat risus ultricies Lorem",
        "web_url": "http://example.com/9d6c496a-74c4-4ba2-b44d-a67e1ebca987#26b88fb9213948ecb0745f4953f02884"
      },
      {
        "analytics_identifier": "at orci a Ut interdum. nisl tempor fames hendrerit, purus dolor porttitor et leo est. dolor Quisque",
        "api_url": "http://example.com/9afbd920-7338-4194-86fa-86f0f11df157/6402887e-cc04-4489-98e3-02be7bd82121/f60ffa8e-26c7-42af-94b3-fc118b57bda1#c9f8ec195785d4a8124cb89a29aa79d9",
        "base_path": "/7112e85d-23eb-4d86-9f37-9b673b5b34e7/a79d2dde-fcec-4e44-9c43-776f9f5b03a1/b5efef63-d6e6-45ab-a7c6-9d23d4558be4",
        "content_id": "f503081d-9024-45f5-9126-d7e6c689e1ba",
        "locale": "lt",
        "public_updated_at": "2017-09-23T08:33:49+00:00",
        "schema_name": "amet, tempor cursus porttitor molestie interdum. interdum. lorem habitant sollicitudin ac bibendum. Lorem vestibulum. volutpat Quisque ac ac leo aliquet. purus Nam orci Suspendisse in, nibh. dolor dolor nisl libero. a",
        "title": "suscipit non Pellentesque ultricies Nam interdum. ac egestas. Sed in, eu Lorem tempor et libero. vel est. Aenean elit. molestie vel hendrerit, sed et turpis a ac ac bibendum. sem at tristique lorem adipiscing Duis Mauris Nam Ut"
      },
      {
        "base_path": "/6c83af7c-d8fe-4aba-a4d3-099fba7cd096/bd10377e-2a20-4b6e-b13f-fb0d3cd88aad/5e68cc00-388f-40bd-943c-84e5c2a4afd3/6c8ab9ba-5fa0-4d3f-b23a-bc7ae3efa515/9045e7ec-6313-4230-9ccb-b90c050965d3",
        "content_id": "3bd1aa27-aeca-440a-af44-9322e2e7e658",
        "document_type": "netus est. Suspendisse nibh nibh. tristique ac sed Lorem Aenean cursus et vel Mauris tristique senectus vel interdum. Pellentesque morbi sit tempor massa Quisque at scelerisque. dolor risus Ut sollicitudin amet, finibus, purus ipsum et imperdiet bibendum. Ut libero. vestibulum. habitant nisl elit. sagittis molestie aliquet. eu Nam fames eu in, leo turpis interdum. egestas. Nam suscipit ac dolor non Sed non consectetur malesuada mauris molestie lorem ultricies ac pellentesque risus Duis porttitor tempor adipiscing lectus orci volutpat ac eros. hendrerit, sem a",
        "links": {
        },
        "locale": "bg",
        "public_updated_at": null,
        "schema_name": "turpis Pellentesque ac Quisque ac a Mauris orci sem nisl at amet, Suspendisse eros. tempor bibendum. senectus sed ac eu purus nibh. fames nibh ipsum aliquet. elit. pellentesque et ultricies imperdiet non molestie vel dolor hendrerit, Duis vel sit et cursus tempor lectus libero. finibus, massa molestie non volutpat lorem in, malesuada Nam Nam egestas. habitant consectetur dolor Ut eu adipiscing morbi interdum. est. Aenean scelerisque. tristique leo mauris porttitor Sed risus sagittis vestibulum. netus ac Lorem suscipit risus Ut sollicitudin interdum.",
        "title": "mauris Lorem sollicitudin finibus, aliquet. porttitor ipsum consectetur est. Quisque tempor Nam elit. risus morbi"
      },
      {
        "analytics_identifier": null,
        "api_path": "/3ef247c2-dd19-41c3-b3c7-7cdd22d0014d/1320a6fc-ac30-40c5-a7c0-1be3c7bc5a90/c7b2a6e1-5f65-42c9-b27e-ef5f146ae9ec",
        "base_path": "/fff339ef-5859-425c-9e42-db7716c033e1/6a327658-3338-49a6-908e-6bb02d24b356/8c3854c5-080f-45e2-8dc3-016882bf6030",
        "content_id": "3537fd80-99c9-4845-813f-5a380fb7ee3f",
        "document_type": "elit. suscipit eros. orci ultricies risus Suspendisse Mauris Nam fames est. adipiscing interdum. vel nisl cursus Quisque turpis et Ut hendrerit, tempor nibh interdum. sagittis non imperdiet at non senectus Nam eu vestibulum. dolor tristique leo in, purus risus sed finibus, egestas. consectetur Sed morbi Ut bibendum. a tempor netus molestie massa libero. Aenean Duis ac tristique vel sollicitudin dolor ipsum ac eu habitant pellentesque malesuada ac lorem sem amet, mauris nibh. molestie ac Pellentesque scelerisque.",
        "locale": "en",
        "schema_name": "",
        "title": "dolor interdum. suscipit aliquet. malesuada sed ac dolor Sed at pellentesque nisl lectus habitant eros. tempor interdum. Pellentesque purus et imperdiet",
        "web_url": "http://example.com/4ea81a1f-6ff8-49dd-89bd-5afbd5741d81/d02a845b-9f91-46c3-984c-7dad7b716388/3eb3181f-d0c8-4c05-bb06-1b2be628a870/4fd36fc6-0cfb-44e0-b703-4902afbd5a65#9dc402296c580a3bd2e393e6d53cf7ef"
      },
      {
        "analytics_identifier": null,
        "api_path": "/02181a0d-5306-4235-9d08-4a3f20b8533c/8b7b4096-2cfb-4778-bdb5-7a9f81bd46fd/20a83940-2647-4b8e-ad66-83b3834ce2a6",
        "api_url": "http://example.com/86f9e4f5-590b-4f47-8f14-202671d0da56/d76ab967-617f-4138-97f1-d50d2aa19d5f/3d14ad8a-86ee-48a3-969e-77b0768a3d79/1e91a653-380a-4b78-a0da-a7acf3dfac80/46214383-1b3c-4134-80d4-507da3d789a1#4b28a8ac38ae0c082ab3cdddb74a3168",
        "base_path": "/788e0e1c-2e5e-4e73-b343-75c70c19d4d3/a3c34790-1f58-4a38-b795-2f3b25899f91/68290965-009d-4a86-bebf-8bada2ab5766",
        "content_id": "face84c5-a4df-4769-ac0d-b2c80cc20cf2",
        "document_type": "vel tristique risus ac suscipit sem libero. in, scelerisque. ac ac finibus, ultricies pellentesque est. amet, Sed nibh. lorem aliquet. Ut nibh mauris interdum. dolor bibendum. tristique et sit netus hendrerit, sagittis tempor morbi Pellentesque leo lectus elit. ac cursus Nam molestie et vel volutpat at molestie nisl ipsum Suspendisse a eu vestibulum. adipiscing Duis eu interdum. Nam senectus egestas. purus sed Mauris eros. Quisque turpis malesuada Ut fames porttitor consectetur massa imperdiet non non Lorem dolor habitant Aenean tempor sollicitudin risus orci",
        "links": {
        },
        "locale": "es",
        "schema_name": "bibendum. Nam molestie ac eros. est. nisl vel lorem interdum. tristique purus tempor elit. leo tristique sed imperdiet ac ac egestas. risus Sed dolor porttitor ultricies volutpat sollicitudin lectus habitant Suspendisse suscipit non sem eu Quisque orci at Lorem Ut risus molestie pellentesque Pellentesque Nam Ut turpis ipsum massa mauris adipiscing fames consectetur vestibulum. libero. a senectus finibus, scelerisque. vel sit in, malesuada et Aenean ac",
        "title": "vestibulum. molestie tristique sollicitudin sed et vel sagittis egestas. Nam ac Sed ac Lorem imperdiet consectetur volutpat morbi habitant netus orci sem risus non interdum. sit dolor ac fames Ut nisl pellentesque malesuada Ut"
      },
      {
        "analytics_identifier": "purus ipsum massa ac Suspendisse Aenean risus eu et Sed Lorem Ut non sit nisl vestibulum. adipiscing hendrerit, porttitor dolor at est. suscipit molestie bibendum. sed Ut tristique mauris volutpat consectetur imperdiet Duis tristique lorem netus interdum. egestas. pellentesque cursus scelerisque. ac eros. ac Nam morbi tempor ultricies et leo elit. ac dolor",
        "base_path": "/e223036c-ca80-4d03-90e4-ae327f2ded87/67876c8d-88ce-4a1d-81c1-2d5bd434966b/0ef60432-c48f-4ef7-bb60-466348c8e53d/cccaedc0-3167-4b42-8ef9-f9567688e725/b49394e3-bb0f-4d42-a555-2f4f2ebdbbd0",
        "content_id": "fdfc52e6-4a3d-44d1-bf12-7066d4960c70",
        "document_type": "nibh volutpat sagittis vel tristique dolor molestie pellentesque senectus Nam suscipit amet, est. ac Ut elit. dolor tempor tempor tristique sed lorem egestas. adipiscing nibh. Lorem eu eros. leo nisl hendrerit, interdum. Sed at a ipsum porttitor turpis Ut finibus, Aenean interdum. ultricies ac risus Pellentesque et vel sollicitudin Nam fames libero. Mauris mauris sem morbi imperdiet scelerisque. et ac non malesuada Duis lectus risus eu molestie habitant ac Suspendisse in, massa non netus vestibulum. consectetur orci purus bibendum. Quisque cursus aliquet. sit",
        "links": {
        },
        "locale": "zh",
        "schema_name": "ac a ipsum libero. morbi hendrerit, nisl malesuada porttitor purus Nam aliquet. et Nam molestie ac eu Aenean tempor Ut est. eu tristique Ut tempor non nibh molestie volutpat interdum. sit at imperdiet non elit. vel lectus vestibulum. massa tristique sed consectetur bibendum. adipiscing habitant ac ac lorem orci risus scelerisque. Suspendisse interdum. amet, ultricies Mauris mauris pellentesque in, Quisque fames vel Duis egestas. Lorem leo finibus, netus cursus sollicitudin nibh. dolor dolor Pellentesque Sed risus suscipit sagittis eros. turpis sem senectus et",
        "title": "habitant vestibulum. eros. risus egestas. scelerisque. imperdiet lorem interdum. aliquet. purus malesuada volutpat Ut ac non nisl",
        "web_url": "http://example.com/111bb5cf-a901-43ad-8063-ca2198be740b#5864b1a4857c44702832a02001b9da0e"
      }
    ],
    "primary_publishing_organisation": [
      {
        "api_path": "/b4f5dc13-ab02-4f83-8849-ed0d98d45add/585177c2-b3e8-4973-95c8-daf2834ff687/43bf9c1d-c099-4cd0-b898-7bdda17361d8/20213368-da5b-4c97-af38-5c946973b371/12bf0f89-6e42-4827-8254-788bc9e20a73",
        "base_path": "/668dd46c-8e55-4ffa-b66e-ed03be54c101/64495f58-98fc-423b-ba3e-0c3f6b059a8b/f7cd5bf5-99a5-41c7-ab87-ff362419c096/3d0b3cad-f509-4e9b-a375-41a61b8cd002",
        "content_id": "bf111261-f1f7-471b-820b-a7467e8fb1f4",
        "document_type": "in, eu orci Sed Pellentesque eu non tempor est. vel porttitor Ut consectetur molestie ipsum vestibulum. sollicitudin ac risus risus tempor sem amet, imperdiet habitant at leo malesuada sagittis molestie sit ac vel turpis libero. dolor Aenean purus",
        "locale": "th",
        "public_updated_at": "2017-11-09T23:44:06+00:00",
        "title": "leo ac vel interdum. nibh. Ut malesuada tristique libero. eu adipiscing vel egestas. interdum. Pellentesque risus"
      }
    ],
    "topics": [
      {
        "analytics_identifier": null,
        "api_path": "/9863c31b-6cb9-495e-b174-836078ba2435/5460ac13-1219-41ab-870c-c56b1d6bee32/b5c4d3c4-f759-442a-ab14-318a65e7cbfa/3c0542a5-ebad-4754-b24d-2456c7f2dd4f",
        "api_url": "http://example.com/aafe8e73-df83-4f7b-9d08-b172ed43b266/fd546c10-2ecd-4af1-a55f-6062c07a742e/1211d88e-0603-4bcb-abb5-e056a98e1ce6#d898e8fbea004031c1f5c5976e03737c",
        "base_path": "/1e52adfb-59c6-42e0-baeb-3b9543e9af46",
        "content_id": "e41e4971-0ead-464b-a641-88ade7bee10c",
        "document_type": "nisl leo dolor in, pellentesque hendrerit, tempor scelerisque.",
        "links": {
        },
        "locale": "uk",
        "title": "ac nibh. ac Nam amet, vel at consectetur hendrerit, purus dolor bibendum. lectus Sed imperdiet eu interdum. est. Mauris lorem suscipit netus cursus Pellentesque ipsum volutpat nisl sit molestie interdum. tristique habitant non orci turpis elit. morbi tempor libero. massa ac dolor adipiscing tempor senectus vestibulum. vel finibus, Ut aliquet. malesuada eros. in, nibh mauris ac sem porttitor Duis a ultricies egestas. leo sed non Nam Ut tristique sollicitudin et fames Quisque molestie sagittis pellentesque eu Suspendisse et risus scelerisque. Lorem risus Aenean",
        "web_url": "http://example.com/0dbc6750-768a-4f6d-9c2a-228e83dda4bf/41b5da39-8ae6-4f36-8229-7308380a9b4b#99065c3b255150b3d599a1c91ca16513"
      },
      {
        "api_path": "/047df7c6-e6b0-4918-9c61-2f9199783a01/bdfc47dc-d49c-42b9-a786-14267bb0ba3e",
        "api_url": "http://example.com/7a456695-ada0-48dc-ac80-39f8445a1e15/341f37f1-d3f8-477b-9cd9-489a97ef13df/0258814e-a160-46d8-8196-4120474c0e45#e921bfa81e3e05dba1b8355f6f1d8cde",
        "base_path": "/00978cb7-1533-4f8e-be5c-9dbd701ea8e5/ca8844a1-d1c8-41eb-b4f0-9b320d9751fa/3416b097-7d90-4e2f-abe1-7f020ab327fb/9db81c17-9db5-45c5-87db-22a8bcb5a13f",
        "content_id": "72f6e997-38a7-4647-b9b8-182a7613da72",
        "locale": "be",
        "schema_name": "eu sem sollicitudin mauris vel interdum. interdum. tempor hendrerit, massa est. tristique Sed eu libero. finibus, Duis turpis risus vestibulum. purus sit imperdiet et egestas. molestie Nam non at cursus bibendum. elit. Ut tristique eros. senectus nisl ultricies non in,",
        "title": "senectus finibus, hendrerit, turpis bibendum. tempor mauris ac Quisque risus ac Mauris ipsum non interdum. purus tempor ultricies suscipit dolor in, netus massa risus vel aliquet. malesuada Aenean fames"
      },
      {
        "api_path": "/da110f81-6186-4e2e-9f9e-fc8bdcbfc73d/1b78c207-e174-46e8-a280-c444e439d51d/0fe50b29-24c7-4007-a0bb-feeadadc0e94/7c829134-9b87-4f13-b500-19d0c1ca2550/857c65ac-a418-4119-afdb-093eb3ea0a7a",
        "base_path": "/b8aab0d5-bffd-4369-8394-f1291ccf96bf/464e210c-6d12-48c9-ad35-9e25c4e1d3e6/0c13127e-148e-4ddb-8db4-f7ef3fd8a00f",
        "content_id": "1df9135b-d392-4586-b4ef-a8cac6821705",
        "document_type": "sollicitudin risus adipiscing amet,",
        "links": {
        },
        "locale": "th",
        "title": "tempor tristique ac ac sem porttitor vel ultricies Nam pellentesque egestas. nisl lorem orci ipsum molestie cursus Nam finibus, sed hendrerit, malesuada nibh interdum. elit. non eros. vel amet, scelerisque. adipiscing Pellentesque Lorem libero. sit sollicitudin molestie tristique risus Aenean dolor in, sagittis turpis vestibulum. purus dolor Ut lectus aliquet. Suspendisse Ut massa risus morbi netus ac est. non et Quisque suscipit imperdiet eu nibh. et tempor a senectus Mauris bibendum. leo mauris volutpat Duis",
        "web_url": "http://example.com/4f2d0647-cc47-4f6c-8dd8-64ef544614f9/35d2c584-fe25-4e2f-90fe-99c37a08b53c/85fb2aba-3467-4118-89c0-a3457d625de8/fc03b66a-f7d0-481f-aaac-2d37fbf8e9dd#609d74c7da6a23bf45f8faaff7431ac3"
      },
      {
        "base_path": "/04f64bcc-8432-4355-b131-d90fc4d9c3f0/6065bb5e-967d-4c89-ba11-bb1a6b662f28/d395e256-a98a-45c6-8a80-51def72c7e2f",
        "content_id": "4cdddc54-ec65-4ebd-ad13-c2b969205353",
        "document_type": "volutpat ac tristique non sagittis amet, a Nam finibus, porttitor tristique molestie elit. eros. eu Ut ipsum hendrerit, adipiscing tempor risus pellentesque morbi ac non malesuada Mauris Quisque aliquet. bibendum. at massa eu orci Suspendisse fames et ultricies vestibulum. libero. senectus Ut consectetur molestie et nibh. vel sit dolor lorem netus Lorem sed cursus interdum. Duis risus vel interdum. in, egestas. scelerisque. nisl Nam dolor nibh habitant est. sem Pellentesque turpis mauris sollicitudin Sed ac lectus Aenean tempor suscipit ac leo",
        "links": {
        },
        "locale": "pl",
        "public_updated_at": "2017-10-22T19:05:56+00:00",
        "title": "interdum. leo tempor tristique hendrerit, molestie massa ac sit purus elit. ultricies molestie Quisque netus Ut sagittis habitant nisl consectetur eu sem et vestibulum. adipiscing ac scelerisque. amet, Lorem Aenean orci turpis cursus Nam finibus, vel in, pellentesque Duis interdum. at Sed imperdiet ac tempor eros. non tristique lorem sollicitudin libero. sed Nam suscipit bibendum. dolor dolor",
        "web_url": "http://example.com/8f368c3c-8934-450f-a697-a5af277d329f/9210d79f-0e92-4c72-b1ba-5f5e3bbb1275/74f82739-cb84-4e15-b630-358e024846e4/4a038b40-1acd-44bc-8a20-4d98f2dd2610/1338345c-a6da-4502-ab00-816a514124bc#f12f6f08063b18f58b13e464cf63afa7"
      },
      {
        "analytics_identifier": "sit nisl Quisque pellentesque eu finibus, nibh. Lorem leo et aliquet.",
        "api_path": "/7a13cb73-e6db-4655-a532-015408b521d1",
        "api_url": "http://example.com/958ad097-72c9-4dfa-bb40-b38baa379385/939d0a98-75c9-44aa-8464-42335b52b843#c2a29a05dabf068e0129d0626eb28364",
        "base_path": "/3d67dec8-92ca-4c09-8c05-a196a2d5ecef/6e09744a-78cb-41cc-ae04-8ca8a0773857/eef51ffe-a754-4fa7-a12c-b5efa543be5e/eda2c6fc-ac53-41a4-8d3b-c6a304b61f64/fbaa3629-dab6-4426-8875-b36c87eec3f0",
        "content_id": "a09af9a3-6202-47dd-b381-14019b40cfab",
        "locale": "he",
        "title": "ac vel lectus orci Mauris ac nisl vel pellentesque molestie volutpat leo tempor ultricies risus cursus scelerisque. ac a finibus, Pellentesque",
        "web_url": "http://example.com/33f532de-aa50-49b8-8711-3bcfa5f4665f/e0afea9b-667c-46d0-b629-cba010b488e3/72bd9724-b0cd-47c1-a3b4-a541394a8ebc#4e04b639f299f1d4f8271fed10834912"
      },
      {
        "api_url": "http://example.com/4ae855d5-1b1a-45bf-a689-c6f907bce0b0#f843196e0ccdee288dffea2b8531fb6b",
        "base_path": "/30ffb442-12ee-44c0-9099-3744652501e1/0f91d7a4-b45e-4ba7-a994-4a3011caad4a",
        "content_id": "a9efeed4-f11c-4636-8620-5eb9ea25ca67",
        "links": {
        },
        "locale": "zh-tw",
        "public_updated_at": null,
        "schema_name": "bibendum. Ut turpis Lorem ac molestie hendrerit, malesuada Quisque egestas. dolor non orci sollicitudin tempor purus at tristique eu sem Aenean nibh. aliquet. sagittis tristique Sed vel adipiscing est. scelerisque. Suspendisse et molestie interdum. Nam et lectus ac Nam Duis nisl cursus massa libero. Mauris interdum. ipsum non",
        "title": "nibh. libero. eu at cursus tristique massa ac scelerisque. in, lorem malesuada Lorem aliquet. Duis sagittis turpis est. dolor adipiscing Nam senectus imperdiet risus bibendum. fames leo Pellentesque"
      },
      {
        "base_path": "/8bf946c1-1232-41fb-ab99-da56e91fb085/06df803f-2fb9-4cd8-a623-f2c82530d78d",
        "content_id": "ca3b5e28-d52d-4cab-9e81-3ecd57f8c402",
        "links": {
        },
        "locale": "az",
        "schema_name": "pellentesque habitant dolor tempor sed Duis interdum. hendrerit, scelerisque. lectus tempor amet, Nam",
        "title": "ipsum Mauris adipiscing et in, hendrerit, eu bibendum. Aenean Lorem vel sollicitudin leo"
      }
    ]
  },
  "locale": "fa",
  "navigation_document_supertype": "eu nibh senectus hendrerit, in, sollicitudin Ut interdum. malesuada turpis eu dolor Nam sed et fames pellentesque Duis tempor habitant lorem tristique non a mauris",
  "phase": "alpha",
  "public_updated_at": null,
  "publishing_request_id": null,
  "rendering_app": "whitehall-frontend",
  "schema_name": "unpublishing",
  "title": "sed est. Nam eu imperdiet fames tempor leo vel ac Lorem Pellentesque pellentesque a non elit. Nam nibh. bibendum. Aenean vel Mauris vestibulum. ac Ut",
  "updated_at": "2017-10-30T14:49:22+00:00",
  "user_journey_document_supertype": "turpis nibh. eu est. ac lectus porttitor non Nam sed consectetur sollicitudin et purus risus Suspendisse dolor ac ultricies tristique amet, vel eros. Nam Aenean tempor suscipit hendrerit, netus nisl pellentesque adipiscing ipsum Sed leo at sagittis Mauris malesuada libero. massa vestibulum. lorem imperdiet molestie a interdum. non ac sem volutpat fames senectus habitant molestie Ut morbi Lorem tristique Quisque orci mauris dolor vel eu nibh ac elit. sit bibendum. Ut tempor in, risus et finibus, aliquet. Pellentesque scelerisque. interdum. egestas. Duis cursus",
  "withdrawn_notice": {
    "explanation": "bibendum. netus massa nibh egestas. lectus ac suscipit sit"
  }
}

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
alternative_url
["string", "null"]

explanation
["string", "null"]

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.
unpublished_at
string

document_type
string

Allowed values: unpublishing
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, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, designprinciples, 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: unpublishing
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
  },
  "analytics_identifier": "nibh. lorem finibus, fames pellentesque habitant elit. in, molestie sed morbi Quisque senectus sollicitudin purus massa tristique suscipit nisl eu netus bibendum. tempor ac non Ut dolor mauris",
  "base_path": "/27feb8e5-e0ae-4c16-a2a2-f5ca3758c316/b73a72ce-28ae-4cd1-bf6b-7bb2c0999cd9",
  "change_note": "eu nibh finibus, lorem Ut Duis Suspendisse interdum. dolor amet, sed sit morbi eros. leo consectetur netus a risus ac libero. habitant mauris senectus at Aenean nibh. malesuada massa et sem non Nam imperdiet Quisque Lorem sagittis Ut tempor ultricies cursus purus scelerisque. hendrerit, aliquet. non egestas. molestie Nam porttitor adipiscing et",
  "details": {
    "alternative_url": "http://example.com/97b63ea6-4bdb-4393-8904-47e418d56e69/05909365-70c5-46da-91b4-b5a8fd9874fd/91a5ee77-3875-4a4f-9fb3-a4344d4f30f4/81259d4e-9790-4286-82d9-cb99cec90819/4f881ded-ab70-4faf-8371-1b355b01ec55#54c0a7565d4389fa82fec5bd622a4e14",
    "explanation": "interdum. consectetur sagittis",
    "public_updated_at": "2017-11-30T18:39:24+00:00",
    "unpublished_at": "2017-11-30T17:03:25+00:00"
  },
  "document_type": "unpublishing",
  "first_published_at": "2017-08-26T16:41:50+00:00",
  "locale": "be",
  "need_ids": [
    "tristique a Duis est. dolor lorem in, scelerisque. turpis tempor habitant purus finibus, hendrerit, amet, ac bibendum. ac pellentesque Quisque vel orci netus Pellentesque aliquet. leo ultricies non nibh. et imperdiet Ut sit egestas. cursus at Aenean risus libero. elit. Nam Lorem senectus mauris consectetur tristique fames Nam malesuada molestie ac",
    "orci adipiscing ultricies",
    "vestibulum. habitant at cursus Aenean Suspendisse Nam ac Lorem Mauris netus scelerisque. risus dolor Sed ipsum dolor finibus, ac sem est. adipiscing in, ultricies volutpat ac risus interdum. tristique morbi Ut eu ac aliquet. Ut tristique egestas. libero. imperdiet amet, turpis sit non nisl sagittis lorem senectus fames lectus Nam sollicitudin Pellentesque consectetur Duis nibh bibendum. malesuada Quisque elit. massa sed mauris et a porttitor interdum. vel purus et pellentesque eu non nibh. tempor molestie molestie eros. leo orci tempor",
    "suscipit scelerisque. dolor molestie sit sollicitudin nibh. lectus risus imperdiet vel Ut sem lorem volutpat Lorem in, ac hendrerit, morbi sed Sed malesuada Mauris ipsum et pellentesque Duis ac massa amet, ac ultricies Nam eros. Pellentesque netus mauris Nam nibh est.",
    "molestie vel orci malesuada interdum. Lorem Nam tristique vestibulum. interdum. nisl est. Suspendisse morbi ac Pellentesque risus tempor netus sit risus aliquet. tristique elit. ac finibus, scelerisque. habitant sed et consectetur ipsum a ac at sagittis non Ut imperdiet lorem",
    "pellentesque lectus leo sed scelerisque. porttitor interdum. fames vestibulum. nibh Sed suscipit dolor tempor Suspendisse libero. molestie purus vel aliquet. et lorem Quisque adipiscing tempor egestas. sem senectus hendrerit, eu non sit orci eros. ac molestie Nam sagittis netus turpis eu tristique Nam vel non Ut",
    "adipiscing risus cursus orci bibendum. sit Ut Lorem morbi pellentesque non nisl et tristique est. Aenean eros. habitant dolor aliquet. Nam Quisque egestas. netus sagittis a purus imperdiet scelerisque. eu vel lectus in, interdum. ac libero. mauris et Nam Mauris fames massa ac elit. tempor non ultricies ipsum sem ac Pellentesque suscipit molestie tempor consectetur leo lorem senectus molestie eu Sed vel interdum. ac risus sollicitudin Suspendisse nibh. hendrerit, finibus, porttitor Ut vestibulum. amet, malesuada at Duis",
    "finibus, purus aliquet. risus consectetur scelerisque. Ut Pellentesque Aenean eros. tempor Lorem vel morbi tempor vel bibendum. egestas. Sed est. lorem Nam suscipit volutpat sit et eu mauris nibh. ac Duis Nam Suspendisse ac eu porttitor amet, tristique sed adipiscing imperdiet molestie vestibulum. ultricies sagittis senectus Quisque massa"
  ],
  "public_updated_at": "2017-09-24T05:11:48+00:00",
  "publishing_app": "maslow",
  "rendering_app": "email-campaign-frontend",
  "routes": [
    {
      "path": "morbi tempor egestas. habitant Quisque dolor cursus Duis Nam imperdiet Mauris orci non Lorem",
      "type": "prefix"
    },
    {
      "path": "ac Mauris mauris sed dolor adipiscing nisl Lorem massa interdum. tempor a et sit fames senectus hendrerit, ultricies habitant Nam non volutpat Ut libero. elit. malesuada ac porttitor at purus finibus, Ut leo vel non Aenean tristique bibendum. netus pellentesque eros. amet, sollicitudin cursus sagittis et consectetur molestie morbi suscipit tempor Suspendisse interdum. scelerisque. nibh nibh. sem est. lorem in, ac risus molestie Nam eu egestas. aliquet. Sed risus orci turpis ipsum imperdiet tristique lectus vestibulum. eu Duis dolor vel Quisque Pellentesque ac",
      "type": "exact"
    },
    {
      "path": "Lorem molestie molestie eu aliquet. netus eros. Pellentesque Quisque est. vestibulum. imperdiet ipsum eu consectetur turpis habitant in, lorem bibendum. dolor tempor sit malesuada cursus Nam leo orci purus tristique Aenean non sem sollicitudin volutpat massa pellentesque porttitor hendrerit, risus Duis mauris interdum. suscipit sagittis tristique interdum. morbi ac Ut et Mauris Ut libero. tempor at a risus ac ultricies ac ac nisl scelerisque. adipiscing fames et vel egestas. vel amet, finibus, Sed sed dolor lectus nibh Nam senectus Suspendisse nibh.",
      "type": "prefix"
    },
    {
      "path": "sed molestie ac orci risus molestie lectus porttitor scelerisque. Mauris Sed elit. finibus, dolor vel sagittis turpis sit nisl Ut habitant Nam volutpat cursus risus Pellentesque Aenean Suspendisse Lorem at vestibulum. tristique sollicitudin leo eros. egestas. interdum. est. nibh tempor mauris purus ipsum et in, tempor non Nam libero. et ac imperdiet interdum. suscipit lorem vel senectus hendrerit, malesuada aliquet. consectetur ac ac pellentesque amet, non eu",
      "type": "prefix"
    }
  ],
  "schema_name": "unpublishing",
  "title": "sit eu purus senectus Suspendisse sed ultricies ac risus sem eros. hendrerit, ipsum bibendum. Duis morbi vel vestibulum. malesuada Sed suscipit Pellentesque fames in, nibh Nam interdum. dolor Quisque Nam et finibus, dolor nibh. lorem",
  "update_type": "republish"
}

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

Attributes

links
object
mainstream_browse_pages
Powers the /browse section of the site. These are known as sections in some legacy apps.
meets_user_needs
The user needs this piece of content meets.
ordered_related_items
Related items, can be any page on GOV.UK. Mostly used for mainstream content to power the sidebar. Ordering of the links is determined by the editor in Content Tagger.
ordered_related_items_overrides
Related items, can be any page on GOV.UK. Overrides 'more like this’ automatically generated links in the beta navigation.
organisations
All organisations linked to this content item. This should include lead organisations.
parent
The parent content item.
policy_areas
A largely deprecated tag currently only used to power email alerts.
primary_publishing_organisation
The organisation that published the page. Corresponds to the first of the 'Lead organisations’ in Whitehall, and is empty for all other publishing applications.
taxons
Prototype-stage taxonomy label for this content item
topics
Powers the /topic section of the site. These are known as specialist sectors in some legacy apps.
previous_version
string

View this schema on GitHub

Random example

{
  "links": {
    "meets_user_needs": [
      "fa8ad40a-74fa-4bf8-81fc-af950d14761b",
      "6824932d-66e7-46a9-b66c-42481528f5d6",
      "98f18d1c-4700-4064-8871-dd6936179ff8",
      "0e39bd2b-354d-4d8a-a333-809be5bff2d4",
      "2bf32149-8789-4472-953a-f5aaf40a269a",
      "fdaaad2d-9d33-4cf4-9fbb-360b1c86c263",
      "8e42a8b2-a906-41eb-81a8-a75afcb90fea",
      "57786a84-c2de-425a-93bd-f7db57884c4e",
      "fa7fb4a6-0363-4c74-a214-52c406cdf206",
      "f7719456-9688-459d-92bc-4b8f927d39bb"
    ],
    "ordered_related_items_overrides": [
      "9930b0b1-efcc-4ddf-a904-d28b02d9e061"
    ],
    "organisations": [
      "08a75d53-8460-47ba-8e99-4fd9f00f97ea",
      "410d81c7-64de-4f72-b291-ac0b8b88427d",
      "b48ec26a-d192-4643-8b03-752638fc21c2",
      "568f5be8-191e-4ed8-9c32-050677999c07",
      "5d1a2f72-4697-4896-ae04-e05a92a26a7a",
      "279f3d2c-21a8-42a8-8451-a08375049326",
      "182cc0a2-dbd0-4c37-b898-c2a4fedab660"
    ],
    "policy_areas": [
      "1fae9ce9-fbe2-4623-a32c-38859d5deed1",
      "07a5c0a7-0a10-472c-ab09-983cc8a88579",
      "dfc21ed6-3213-4b34-8aed-b8bc4e90d3ed"
    ],
    "primary_publishing_organisation": [
      "bff1334f-6338-4efb-acf1-27a11ee5b5a8"
    ],
    "taxons": [
      "dbd46e80-c4d7-4ec1-9796-8f94bfa1c479",
      "18d94d12-740b-4863-8ff1-67af15cc90f8",
      "6fc7d8f8-a839-4c4c-9bc3-19bea3a2cf38",
      "db381a7b-aa00-4b94-a039-5c47deb65fe2",
      "f338cdb2-6f59-4a70-b119-407f5b2a0272",
      "bdd6a19d-3d2c-44d2-a4dc-3b1447cb9b63",
      "d7c914dc-2612-4239-ac5d-d5609b89e217",
      "cd0fc4f6-b422-4937-b8f6-9af822e6a683",
      "029c5412-9973-428d-8112-a1721ffa81c1"
    ]
  },
  "previous_version": "ac interdum. sem hendrerit, lorem porttitor suscipit nibh est. eu molestie orci Duis a ac imperdiet ultricies nibh. molestie Ut senectus tempor Sed in, pellentesque nisl Nam eros. habitant et Quisque massa dolor non bibendum. adipiscing ac egestas. morbi dolor non mauris Lorem consectetur lectus sagittis fames amet, risus libero. netus Nam aliquet."
}