Table of contents

Schema: role_appointment

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

ended_on
["string", "null"]

started_on
string

document_type
string

Allowed values: role_appointment
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
facet_groups
Prototype-stage metadata tagging tree roots for this content item. A content item my belong to many facet groups without having any specific facet_values links.
facet_values
Prototype-stage metadata tagging values for this content item, a content item can be linked to many facet values from varying facet groups.
lead_organisations
DEPRECATED: A subset of organisations that should be emphasised in relation to this content item. All organisations specified here should also be part of the organisations array.
level_one_taxons
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.
original_primary_publishing_organisation
The organisation that published the original version of the page. Corresponds to the first of the 'Lead organisations’ in Whitehall for the first edition, and is empty for all other publishing applications.
parent
The parent content item.
part_of_step_navs
Link type automatically added by Publishing API
person
The person that is currently appointed to the relevant role.
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.
related_to_step_navs
Link type automatically added by Publishing API
role
The role that the relevant person is currently appointed to.
suggested_ordered_related_items
New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.
taxons
Prototype-stage taxonomy label for this content item
topic_taxonomy_taxons
Link type automatically added by Publishing API
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
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, publisher, rummager, search-admin, search-api, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, special-route-publisher, 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
or null

scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: role_appointment
title
string

updated_at
string

withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "base_path": "/55b72dc7-a7d7-4a55-bf21-85dfb929661a/24e31e1e-bee5-4fe0-89ca-ddc8d2be35a0/94cf2409-b8f6-498a-b352-b1be573c880e/34804813-71ac-48af-a057-1236e69363b7/917f1717-d34b-487c-8881-1430adedc379",
  "content_id": "88af6fa8-fde3-43f0-99d9-b8c4755b2fa8",
  "description": "",
  "details": {
  },
  "document_type": "role_appointment",
  "first_published_at": null,
  "links": {
    "lead_organisations": [
      {
        "api_url": "http://example.com/eb9e375c-5a88-49a3-adb4-c0ba800e65b9/f943d284-ee5a-45b9-95a4-82d41337437b/827912f2-3ee7-423c-a07c-e9ab988eb023/98417125-bcdc-42a3-9cdc-9719c9ff1c3a#d431ac1167a8c16ced2a4796d3632b8b",
        "base_path": "/90b78258-a871-4d77-9e86-85ef8f8e5dc1/7636a917-4ca1-430b-a700-906ae0b6d886/30071f6e-ef8f-43a3-bda9-2e596019e0d4/095b1ec3-6a96-4c30-8ca2-1bdb77626bbe",
        "content_id": "82443154-d69c-45dc-a0bf-985b838e17a9",
        "links": {
        },
        "locale": "bg",
        "title": "eu pellentesque leo eu Quisque a purus et habitant est. consectetur sollicitudin interdum. Nam libero. ac sagittis interdum. orci",
        "web_url": "http://example.com/12c57199-fb83-47a7-aa0d-065a84ab98c1/3e7dd95c-c620-4d8b-bf7c-6891766731bd/305789cc-08cc-438c-b9a1-02878c163580/c42b12a5-d0fa-4196-b70c-017fae3b52bd/fd38edee-4a58-4c22-948f-0aeb836ec260#322f0d4e8a4469b4da83520a94ad5f17"
      },
      {
        "base_path": "/7ab7d5f2-44e3-476e-a894-df39b8c7e906/49b24206-d517-4b30-a330-55a858fe9fd0/0d9fb1fc-aa19-4027-b778-4487e06a75d4",
        "content_id": "8aeb96d0-c5b4-4f7e-a00f-5d8469081b0b",
        "locale": "ar",
        "public_updated_at": "2019-01-24T19:56:25+00:00",
        "title": "risus egestas. senectus aliquet. et vel est. cursus leo a porttitor volutpat massa suscipit non at tristique interdum. morbi sed tempor nisl interdum. molestie Sed sagittis ac mauris libero. dolor eu Duis vestibulum. adipiscing",
        "web_url": "http://example.com/67930369-228e-403b-b0e0-12f969baede2/3ed2ca2a-b142-4e95-b9ce-5c98adcea0fe/5ba966b0-64f1-4540-9df0-e9659ce262c7#0b9b4e56cdf55e788561a7deb0924f86"
      }
    ],
    "level_one_taxons": [
      {
        "api_path": "/0dce1c97-cca3-4b0e-bcab-0e6c95d2b9f4/44a3597a-5684-4d79-bdae-6214faf3791b",
        "base_path": "/c0c84e5f-193d-44cc-9bd7-35cef1307be3",
        "content_id": "b26b3106-9424-41a4-af0d-db93fa740013",
        "document_type": "consectetur massa purus est. dolor Aenean lorem sed nisl orci in, malesuada eros. sagittis et interdum. leo pellentesque et eu ultricies fames scelerisque. Ut Quisque ac molestie habitant ipsum turpis sem netus Suspendisse volutpat tempor Mauris nibh Ut Lorem Duis lectus vestibulum.",
        "locale": "he",
        "public_updated_at": "2019-04-24T21:16:59+00:00",
        "schema_name": "nisl eros. eu hendrerit, molestie risus dolor in, ac tristique tristique vel Nam pellentesque ac at Sed nibh tempor a morbi aliquet. turpis leo interdum. Ut risus amet, nibh. sollicitudin et consectetur massa finibus, porttitor adipiscing malesuada scelerisque. interdum. molestie suscipit purus dolor et vestibulum. Suspendisse mauris tempor non Quisque ipsum fames Pellentesque ultricies libero. orci ac imperdiet Aenean non volutpat vel cursus ac sed sem bibendum. Lorem est. Ut Duis habitant Mauris sit senectus lectus Nam lorem elit. egestas. sagittis eu",
        "title": "est. Sed aliquet. tristique ac sagittis imperdiet ac Quisque Aenean suscipit eros. interdum. Ut orci in, Duis non interdum. pellentesque morbi sollicitudin risus hendrerit, Lorem non mauris ultricies scelerisque. lectus malesuada nibh massa ipsum dolor ac leo a libero. lorem sed finibus, tristique vestibulum. sit Pellentesque Nam volutpat turpis et fames Suspendisse eu adipiscing et sem"
      },
      {
        "analytics_identifier": null,
        "api_path": "/78aee74d-934d-43e2-a312-868c1e2acdbb/6a9d791e-5db1-4dfb-82a6-96ddc3e384d6/3af3d116-f195-4fc9-b34c-aad53900190b/4728efa7-b8c6-4bce-af63-3afe649a7d38",
        "base_path": "/c82f832e-909d-4828-b7d9-a513b5f30a97",
        "content_id": "e967eafe-1a7a-4599-8b9b-06c5a4a48bc5",
        "links": {
        },
        "locale": "sr",
        "schema_name": "dolor Suspendisse amet, Ut molestie imperdiet scelerisque. nibh. sollicitudin vel cursus malesuada a sit netus leo Quisque mauris risus Duis eu senectus fames eros. tempor in, interdum. pellentesque hendrerit, massa sed Lorem Ut tristique sem finibus, eu elit. non porttitor egestas. ac tristique risus Sed Pellentesque nibh purus ac ac aliquet. at turpis ac Aenean Nam vel orci et ultricies est. Nam lorem ipsum interdum. Mauris non nisl suscipit volutpat vestibulum. et adipiscing lectus tempor habitant molestie libero. bibendum. consectetur morbi dolor sagittis",
        "title": "bibendum. nisl Aenean Quisque sagittis ipsum sed non tristique molestie porttitor turpis vestibulum. eu nibh morbi orci a et Sed Ut Ut interdum. amet, purus netus Mauris fames hendrerit, nibh. senectus pellentesque est. dolor dolor interdum. Lorem mauris malesuada risus leo Suspendisse adipiscing imperdiet tempor ultricies molestie Duis vel in,",
        "web_url": "http://example.com/8c4cd4c2-dc5c-4876-aeb5-f92f9c83353a/f5cb751e-173f-4d42-9045-eb045282b339#d785652f9b2143fed9941d0c2db8d720"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/24adfd36-6049-4f00-8c19-1a9a2bbd8a28/55ac0be5-90cf-411b-a49b-a6d0da64d687/54acf798-54d1-48a3-ae53-6beaf764dc89/b7e2af42-5fd5-4801-b606-15ec7af9b75d/1156e22c-9437-4de6-a0e9-5b0484da5981#e895da0cb2e78676cf0cba006eba775f",
        "base_path": "/e8a46f8c-50fb-4262-8726-4f5ad53ebbee/c10eb382-d047-45f8-ac03-2864eb456329",
        "content_id": "a9d31389-f151-4f2d-b406-e975de9bb56c",
        "links": {
        },
        "locale": "uk",
        "title": "a lectus Duis Lorem dolor libero. imperdiet leo Aenean mauris molestie molestie hendrerit, ac at nibh interdum. Nam orci ac vestibulum. non vel porttitor egestas. et vel elit. Nam Sed cursus in, lorem aliquet. bibendum. ultricies sollicitudin ac netus Ut tempor nisl habitant amet, dolor Pellentesque risus tempor senectus fames sem risus consectetur interdum. scelerisque. eu malesuada volutpat purus tristique sagittis non eu tristique Quisque finibus, pellentesque massa Mauris turpis adipiscing nibh. eros. ac ipsum Suspendisse est."
      }
    ],
    "ordered_related_items_overrides": [

    ],
    "original_primary_publishing_organisation": [
      {
        "analytics_identifier": null,
        "api_path": "/0672fe24-e4c3-46e7-ba1d-bdf591d2eb86/f11a9d8e-59e4-4146-bdf3-b0761571b773/dd9e5f35-3430-40cf-a502-86dd30a7180c/ce92b10c-4630-42e3-824b-19a64d9a5d85/b9a720bb-7e1a-472b-ac58-3e44805b1873",
        "api_url": "http://example.com/1779ea4b-d2ef-46aa-bc6b-f772fead8dda/60668d96-7568-4020-83c3-bdb1f9451bf4/cb33f6fe-668b-439c-bcbb-a0c05afa2835/621b6739-d7f0-401b-b288-9bfd7c7104f4#c7f52dc9932eb48c8446ff465a3bec7d",
        "base_path": "/64a012e5-9218-4827-8f50-508a574bf006",
        "content_id": "af9ba04b-4ae8-4413-8aaa-1fb17543a073",
        "document_type": "Duis Suspendisse imperdiet interdum. a volutpat finibus, Ut ultricies mauris non nibh purus habitant tristique tristique suscipit vestibulum. sit malesuada eu lectus ac ac risus morbi tempor sed et fames Nam Pellentesque scelerisque. netus dolor sollicitudin molestie Lorem egestas. sem adipiscing turpis ipsum hendrerit, dolor amet, tempor libero. est. ac eu et Nam non senectus Aenean vel ac nibh. lorem leo vel at Mauris Sed consectetur porttitor Quisque cursus nisl aliquet. sagittis massa pellentesque eros. Ut molestie bibendum. elit.",
        "locale": "be",
        "schema_name": "vestibulum. turpis volutpat sollicitudin elit. molestie et et aliquet. orci Quisque habitant adipiscing eu lorem malesuada libero. vel sem imperdiet nisl tristique dolor ac consectetur massa Pellentesque",
        "title": "imperdiet bibendum. morbi vestibulum. orci purus Nam adipiscing pellentesque tristique tempor Ut ac leo ultricies malesuada ipsum turpis in, sagittis consectetur porttitor fames at sollicitudin aliquet. lectus Nam egestas. et Aenean eros. Mauris molestie sit scelerisque. Sed molestie eu suscipit lorem netus est. Lorem non nibh. vel Duis Ut sem tristique tempor libero. cursus hendrerit, volutpat Suspendisse finibus, dolor massa a ac senectus non et sed interdum. interdum. elit. amet, nisl nibh"
      },
      {
        "api_path": "/1114822b-97b1-4c9c-b2e1-4daf7ce73800/6f2c308f-2011-49e1-a8ef-c19ab7550610/91598c31-593e-4c1b-a49c-baf2612591f7/c973a64b-e288-4f82-b668-2620f19e6ccc/125e0171-18ef-452a-a770-e54996168868",
        "api_url": "http://example.com/d6807cad-a009-41e1-8a56-873087c05c78#4c347a89ab663e0f9631bc3b52ba5825",
        "base_path": "/30f38b5a-0a86-4d7b-9ee8-f59ebd3500bb",
        "content_id": "22182aac-9e25-4d24-9d94-b0127f6b131f",
        "locale": "de",
        "public_updated_at": null,
        "schema_name": "ultricies Suspendisse Lorem vel dolor est. egestas. Ut ac at nibh. libero. et tristique risus turpis elit. ipsum porttitor a Quisque in, interdum. leo lorem Aenean morbi sem tempor finibus, senectus dolor volutpat sed sit risus orci imperdiet adipiscing netus molestie ac Mauris mauris malesuada Pellentesque eros. tristique lectus Ut vestibulum.",
        "title": "cursus nibh non adipiscing massa ipsum vestibulum. Suspendisse Mauris turpis risus habitant et a leo Aenean sagittis consectetur in, mauris interdum. nibh. eu ultricies lorem eros. Lorem tristique scelerisque. libero. eu sed interdum. vel tempor egestas. Nam suscipit Quisque porttitor tristique vel morbi sit volutpat sem molestie nisl Nam Sed imperdiet est. risus ac ac at dolor finibus, Duis malesuada netus amet, hendrerit, sollicitudin pellentesque Pellentesque senectus et non fames ac tempor elit. ac lectus Ut molestie dolor aliquet. purus Ut bibendum. orci"
      },
      {
        "api_path": "/68549b8f-c991-488e-aac5-28783f86f827/48bf8832-3544-4cd3-92b2-771b85fc70ff/d611d89f-96d0-4202-abd4-c0741a0f4b04",
        "api_url": "http://example.com/e942d6a5-16e6-41c3-9413-a4a149e99cc1/97d36750-cf88-416a-93e9-a75fcdccc044#ccb400a2a08e2a098a8fa6b5717824ec",
        "base_path": "/92066def-757a-4658-9feb-49df39b2cbac/5fa1d7c3-43b0-4881-80cf-b030906155db/bd16e861-df91-4e92-80fe-452f2607755f",
        "content_id": "da2bdd47-69e3-4a19-82e7-2133a84af93e",
        "document_type": "sagittis interdum. bibendum. Suspendisse tempor ipsum Aenean",
        "locale": "hy",
        "public_updated_at": "2019-04-03T10:31:05+00:00",
        "title": "risus et malesuada interdum. fames Lorem pellentesque risus sem vestibulum. et in, Pellentesque Sed orci a tristique vel imperdiet scelerisque. mauris sed Nam suscipit nibh. Duis bibendum. porttitor nisl finibus, lectus amet, aliquet. ac est. purus tempor tempor turpis sollicitudin egestas. molestie ultricies interdum. hendrerit, Ut cursus at",
        "web_url": "http://example.com/5e09cc75-5d58-48fc-94e1-6cb1892eac47/15c5d6c1-aa0c-409b-901c-ab7326fa5ea4/1d746e21-5c14-4c78-9a2c-63069377c742/08a37a42-de1e-4820-a466-d93288e6c926#e1a9b19a5d1202cb7e25da21a2dc483e"
      }
    ],
    "parent": [
      {
        "analytics_identifier": "cursus molestie pellentesque Ut netus Pellentesque egestas. at imperdiet Nam eros. orci tristique sem a ac Ut suscipit malesuada sed Lorem ipsum molestie sit purus interdum. lectus sagittis elit. non risus volutpat morbi lorem et Suspendisse amet, Mauris hendrerit, sollicitudin adipiscing consectetur vel dolor ac scelerisque. ac eu leo tristique fames in, massa aliquet. bibendum. ultricies porttitor habitant nibh. ac turpis tempor est. libero. et dolor vestibulum. nisl vel interdum. Quisque mauris eu",
        "api_url": "http://example.com/b82cbff7-4503-44de-8206-a036ad4267ab/a60f5718-fc83-49df-b9e9-2d1c843fac5e/7d8b6595-3b64-4f29-87a3-fd377747be2a/ff7bb242-cb45-4619-9549-8e08476b794b/7ea67470-0761-4c99-8744-2eaabbfbfb9f#7ed970bd368623dd9f66636a220cd327",
        "base_path": "/ccea1f11-5ca1-4a7e-9bef-e0ee0d023726/a2f3c9e2-6be6-4662-9d92-53990e629370/0c77524c-9929-430c-a63b-8c1879c062ce",
        "content_id": "68f9834b-692c-47c2-9fe3-dea345c5a65d",
        "links": {
        },
        "locale": "cs",
        "public_updated_at": null,
        "title": "habitant volutpat turpis pellentesque leo lectus adipiscing eu netus bibendum. Nam at cursus molestie sed fames tristique tempor egestas. suscipit sit a risus nibh. elit. finibus, morbi massa Lorem consectetur libero. lorem Aenean amet, nibh interdum. dolor non imperdiet interdum. tristique sem est. eu dolor ac non vel Mauris ac sagittis Ut Duis purus orci scelerisque. nisl Sed ac malesuada risus senectus in, eros. mauris aliquet. vel Pellentesque et sollicitudin molestie Quisque Suspendisse et ultricies",
        "web_url": "http://example.com/07b5f0a9-a5ea-4e64-a1ed-a90e114476e2/63a0b585-9a77-401a-88aa-ef78015dc2ff/ffe30e4e-dd46-4125-92fb-08865ca5a0c3#bc356d025abd71809b8982ea46f3c3bc"
      }
    ],
    "policies": [
      {
        "analytics_identifier": "Quisque ac molestie Mauris orci senectus et adipiscing fames molestie aliquet. non eros. purus ac habitant imperdiet scelerisque. morbi egestas. hendrerit, dolor Nam Duis tristique risus libero. volutpat pellentesque finibus, non lorem eu Aenean risus a at est. vel nibh sed Nam sit sem vel turpis suscipit nibh. tristique bibendum. netus Pellentesque",
        "api_url": "http://example.com/8eef0298-cbc8-4d41-9d41-adc84fb0c807#f885c679cff4904208fd4e543e81efd9",
        "base_path": "/a48157d4-22db-403b-87eb-c8467b6d9b49",
        "content_id": "fac94f90-4ff0-41e2-9676-848b69602bb9",
        "document_type": "aliquet. sed turpis adipiscing volutpat interdum. sollicitudin nisl molestie vel ac hendrerit, Ut Duis vel in, vestibulum. consectetur amet, risus nibh. libero. cursus",
        "locale": "id",
        "schema_name": "imperdiet habitant at molestie senectus Duis dolor aliquet. non suscipit nibh eu sem vel morbi vestibulum. lorem eros. mauris nibh. tempor vel tempor ipsum adipiscing interdum. scelerisque. malesuada ac et risus turpis fames hendrerit, egestas. porttitor tristique Nam eu nisl purus cursus finibus, Quisque molestie est. volutpat orci sagittis",
        "title": "dolor nibh eu interdum. netus sit lectus porttitor molestie elit. sed morbi et cursus non suscipit lorem imperdiet"
      },
      {
        "analytics_identifier": "molestie et mauris molestie bibendum. imperdiet habitant vestibulum. sit egestas. pellentesque suscipit massa Nam eu at ac vel hendrerit, Ut ultricies scelerisque. Pellentesque Aenean aliquet. dolor leo non eros. libero. Duis amet, sed et nibh. elit. malesuada tristique adipiscing Suspendisse purus senectus tristique nibh lectus tempor risus lorem finibus, in, tempor volutpat",
        "api_path": "/89df0a23-5dcb-4894-b955-fd5ff49b7538/cf7290d7-8efd-491d-a50e-34d84acf7915/7ff8c127-f0fb-472a-8547-d83e6cc96b87/8f63c2a2-5c6f-4f2c-998e-51b9a0625424",
        "base_path": "/5f639a9a-9b8e-4160-b7b7-08bfc3374044/e85ac609-2929-43e1-ac64-61e714c1f43a/b20d1aaf-b847-41f6-9aca-54ae43c2a8ec/2dae37b8-da27-40d1-85cc-f3c4574731c4",
        "content_id": "696a2c9f-74b6-4368-8c68-746a1e3338f5",
        "links": {
        },
        "locale": "ru",
        "title": "Mauris bibendum. ultricies tempor et Nam purus Pellentesque finibus, Ut aliquet. amet, ac Nam vestibulum. cursus dolor porttitor habitant scelerisque. Duis leo nibh lorem nisl molestie sit nibh. pellentesque interdum. risus sem est. eros. volutpat sagittis ac sollicitudin adipiscing Sed et ipsum imperdiet elit. massa ac malesuada dolor suscipit Ut turpis Suspendisse senectus non a at fames libero. orci egestas. mauris lectus Lorem eu morbi"
      },
      {
        "analytics_identifier": "interdum. dolor bibendum. malesuada egestas. dolor consectetur sollicitudin scelerisque. lorem porttitor interdum. vel risus imperdiet morbi orci sagittis vel amet, nisl tristique ac Suspendisse tristique mauris elit. ultricies ac est. adipiscing Aenean nibh. lectus nibh risus ac libero. sed molestie Lorem Sed Ut Duis Quisque sit suscipit senectus habitant eros. cursus Nam Mauris Ut aliquet. vestibulum. massa eu eu sem pellentesque purus non tempor et Pellentesque non leo at molestie",
        "base_path": "/e4dd1aea-aa7e-41ce-b746-ad8c583c77e8",
        "content_id": "82a1327a-9495-4101-b346-d090feecee1a",
        "document_type": "fames at sagittis ipsum senectus ultricies sollicitudin purus sit Pellentesque Sed",
        "locale": "et",
        "public_updated_at": "2019-02-05T12:34:21+00:00",
        "title": "mauris Quisque est. vel scelerisque. molestie leo vestibulum. lorem hendrerit, finibus, libero. malesuada ac purus morbi sit Duis suscipit Pellentesque ac netus aliquet. et Aenean at senectus turpis ipsum vel porttitor adipiscing Lorem consectetur egestas. habitant tristique volutpat eros. sollicitudin Ut pellentesque orci amet, dolor elit. imperdiet Mauris nibh bibendum. Sed nibh. fames non sagittis nisl molestie eu et interdum. dolor Nam cursus ac",
        "web_url": "http://example.com/1c822dd5-5170-4236-a2cc-c3974d35de61/7cba65da-d20f-44db-be1a-822c3ee5d57e/b581139d-a45c-45aa-ba2e-b942e333ed8d#41dd745832ece692d941ff0c5fa4223e"
      },
      {
        "api_url": "http://example.com/a5a7bdaf-efad-4994-a81c-7f167d940925/7e18d5fd-01f7-45b1-a2e0-4d3ec2bc4f5a/0b1fd13d-0e5a-4d47-9c14-134e68be3a44#32b7f98edbd5efe9e93f61b98ee43cb6",
        "base_path": "/88402282-9f21-4dec-81a4-fdf0b703ebcd",
        "content_id": "36ca69b2-9769-4381-9535-01fce641681f",
        "locale": "es",
        "title": "nibh. consectetur Aenean ac a sagittis habitant hendrerit, sed imperdiet Mauris orci ac interdum. fames mauris pellentesque libero. in, ac molestie porttitor dolor suscipit adipiscing Nam Ut sollicitudin sit ultricies Ut amet, sem lectus lorem scelerisque. turpis et Suspendisse bibendum. vel tempor non aliquet."
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/51fdc949-ff6b-46c2-bc26-05c87ae5041d/cc621d73-de2c-4b88-87fc-1a9ef32107ca#851c0f93526b51663a1f7828f1bbd54b",
        "base_path": "/f318697f-c7d8-4752-a367-d97a8750bdbc/6286db7b-5397-44fb-9a3d-295f3e3e15e9",
        "content_id": "32c1d4c7-8a46-492b-a11c-cbbc061fa29c",
        "document_type": "habitant egestas. est. amet, ac eu porttitor turpis interdum. in, nibh et scelerisque. Ut orci vel bibendum. vestibulum. vel morbi fames ipsum sagittis eu eros. non sem volutpat elit. finibus, mauris consectetur ac interdum. libero. nibh. risus sit massa risus dolor pellentesque Pellentesque ac Quisque Nam sed senectus nisl a tristique malesuada hendrerit, Nam Lorem sollicitudin tempor cursus tempor imperdiet suscipit aliquet. Aenean netus adipiscing leo dolor at ac tristique molestie purus lectus lorem Suspendisse et Mauris Duis Ut ultricies Sed molestie non",
        "links": {
        },
        "locale": "dr",
        "schema_name": "Ut suscipit Quisque tristique eros. Duis risus et Lorem hendrerit, Sed a interdum. est. aliquet. Mauris amet, finibus, scelerisque. molestie volutpat fames sem Nam ac tristique egestas. libero.",
        "title": "Ut eros. ac cursus scelerisque. sit",
        "web_url": "http://example.com/32288154-487a-4790-89d1-7830c28d6cc0/2da3487d-e0b9-4ea2-9070-08424cc6fbcf/04c30079-057d-4904-a6b2-6a8bb6abddb0/220a6e8f-6534-47d0-8b7f-e31f0c64673c/69058934-ff9d-46fc-8d02-1837a063266d#8d3e1385cb5f67d3845f606dc7af6b63"
      }
    ],
    "primary_publishing_organisation": [
      {
        "analytics_identifier": null,
        "api_path": "/cc4525ce-8e5e-4097-85e8-23bc146d468a/95f98873-440b-437a-aef8-0f0ca038dc71/5f91f014-5b72-424a-84b4-1158a1ee24d0",
        "api_url": "http://example.com/319d8ca3-44c8-4545-b0a9-a801f00704d5/eeef3839-b9f2-434b-815f-efb89510ea27/94fbd052-3813-4bf9-9fc1-266d5e38256d#4c1008166ba9487228d4358a20abab42",
        "base_path": "/e9e26fee-0093-468a-ad71-f87cd737aae2/043e37af-9ec3-495b-8fe0-f65cb66cf792/139101e6-82a0-4c0f-ba23-a4eeb2712ded/08eda5dd-b6cb-4ab7-a583-9bec9f1443eb",
        "content_id": "9b0ad438-680e-4e4e-a3d7-ecd4620953df",
        "locale": "be",
        "public_updated_at": "2019-02-26T07:27:35+00:00",
        "title": "ac et tristique pellentesque ac nisl elit. at a Pellentesque netus nibh. mauris risus cursus lorem vel interdum. purus dolor lectus massa molestie Aenean libero. Ut leo suscipit molestie adipiscing fames vel est. nibh non Quisque Nam tempor in, ipsum malesuada sagittis sollicitudin Lorem Ut aliquet. amet, tristique Nam Mauris habitant eros. senectus volutpat ultricies tempor morbi et non ac eu eu consectetur egestas. sit orci sed ac Suspendisse vestibulum. scelerisque. Sed",
        "web_url": "http://example.com/c46f9247-3fb8-411c-b441-c7fe310afe94/ec070871-3d79-481e-94bb-28287f40a2e5/020b3456-3964-4d4d-9586-961644c2427e/8dfbe530-57cb-49c8-a08c-4cc52c8a456e#838db9567652b3d909b72ee4ab68673c"
      }
    ],
    "topic_taxonomy_taxons": [
      {
        "base_path": "/baf49f05-b65d-4ce4-98e1-6a1d5e8973c8/b16914c8-dbf8-4d7e-aefd-fac30d23daa8/e2e83543-1323-4ce3-819c-7e5473a2e102",
        "content_id": "5d9593aa-0890-4974-b249-bb4e5b575202",
        "links": {
        },
        "locale": "ps",
        "schema_name": "ipsum finibus, in, amet, Sed consectetur cursus netus interdum. Lorem nibh. sed bibendum. aliquet. sit risus et nisl non elit. Quisque est. massa porttitor lectus risus orci ac morbi ac vel pellentesque interdum. fames Ut et ac senectus vel hendrerit, Mauris Nam Aenean scelerisque. lorem sagittis eu nibh Duis mauris habitant adipiscing molestie egestas. vestibulum. malesuada libero. Ut turpis Nam Suspendisse dolor suscipit at ac tempor tristique non molestie leo eu purus sollicitudin a sem tristique eros. Pellentesque volutpat imperdiet ultricies dolor tempor",
        "title": "elit. suscipit eu ultricies Lorem non egestas. tristique purus adipiscing Mauris habitant non vel vel interdum. fames porttitor Suspendisse malesuada",
        "web_url": "http://example.com/5ec3d2c5-cf0d-4e78-a502-a55c8762e95c/caa055ac-0b1a-4530-9c82-b3e62b5bb3d5/55654db7-3837-45a8-8f81-2df249cd2321/5fd4cb03-c318-4eba-92c8-b43aecccf11e#d8d1609e1d91c2e2a9660cc608bfbd3e"
      }
    ]
  },
  "locale": "es-419",
  "public_updated_at": null,
  "publishing_app": "contacts",
  "publishing_request_id": "risus Nam pellentesque imperdiet lorem elit. tempor Mauris egestas. et habitant Ut ac non molestie Duis massa vestibulum. sem Ut adipiscing netus mauris malesuada tristique suscipit scelerisque. finibus, cursus Sed turpis sagittis Nam ac hendrerit, tristique et lectus molestie tempor purus Pellentesque orci dolor consectetur senectus eu interdum. dolor Lorem libero.",
  "publishing_scheduled_at": "2019-02-25T19:46:55+00:00",
  "rendering_app": "finder-frontend",
  "schema_name": "role_appointment",
  "title": "at non risus sit Ut Quisque cursus sagittis molestie netus senectus turpis sollicitudin ac Pellentesque tristique sed risus Duis fames habitant massa finibus, adipiscing consectetur dolor et bibendum. imperdiet est. nibh Aenean aliquet. Sed interdum. et tempor eu morbi lorem eros. hendrerit, lectus sem orci ac a vel scelerisque. Suspendisse tristique tempor vel Mauris volutpat molestie nibh. in,",
  "updated_at": "2019-03-05T01:35:47+00:00"
}

Publisher content schema

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

Attributes

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

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
or null

bulk_publishing
boolean

change_note
["null", "string"]

description
or null

details
object
ended_on
["string", "null"]

started_on
string

document_type
string

Allowed values: role_appointment
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
person
The person that is currently appointed to the relevant role.
policy_areas
A largely deprecated tag currently only used to power email alerts.
role
The role that the relevant person is currently appointed to.
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, publisher, rummager, search-admin, search-api, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, special-route-publisher, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
or null

routes
array

schema_name
string

Allowed values: role_appointment
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "71f569be-11f2-4cea-8575-de62f7e71fd2",
      "846acd0d-24f6-4da1-b3e6-593dd86d8edb",
      "34f1cd3b-6fea-42f6-8c63-a7c00d375812",
      "422b612d-f711-410a-8477-9690d1be4d45",
      "fe962e33-f109-484b-ac72-803a1cf03f98",
      "81a27363-52dd-45f5-a374-4971f958ca1d",
      "88056e9c-68a4-41c9-b371-da6df54bddb0",
      "b28507d7-6267-44ac-9677-8011a74acd7e"
    ]
  },
  "base_path": "/e372b415-8c81-4d3c-87f2-8ed107cf5443/36ac6f90-ac07-408f-97b2-8f2f46875e43/ce55b728-7d62-4d3d-95c5-75a18258375a/5f7b00eb-2b38-4194-a4e4-495d758c8484/78fac9a4-60f0-4281-ae49-ddc70bf5afca",
  "bulk_publishing": true,
  "change_note": null,
  "details": {
    "started_on": "2019-04-07T10:16:39+00:00"
  },
  "document_type": "role_appointment",
  "locale": "sr",
  "need_ids": [
    "Aenean molestie dolor interdum. cursus aliquet. Quisque ac et sed habitant at nibh in, Ut amet, ultricies nisl Nam risus sollicitudin risus Lorem scelerisque. pellentesque ipsum sit consectetur sagittis Nam non volutpat elit. morbi eu Duis hendrerit, libero. adipiscing Sed vel Ut turpis tempor purus egestas. eros. sem netus vel Pellentesque tempor interdum. leo non orci lorem imperdiet dolor",
    "egestas. ac vel",
    "imperdiet tristique ipsum lorem sem Sed mauris risus amet, eros. a Pellentesque malesuada volutpat molestie ultricies cursus interdum. ac at est. morbi netus Duis purus non lectus Nam bibendum. consectetur orci risus nibh ac et libero. sed vestibulum. Quisque ac Mauris tempor eu senectus Ut dolor leo aliquet. massa hendrerit, pellentesque vel vel turpis tristique nisl scelerisque. molestie et non dolor interdum. Lorem elit. adipiscing tempor eu fames Nam suscipit Ut Suspendisse sagittis in, Aenean sit habitant",
    "Nam mauris malesuada eu bibendum. sit cursus suscipit Ut ultricies ac senectus volutpat Quisque ac vestibulum. nibh Nam imperdiet est. a risus Ut ipsum adipiscing aliquet. hendrerit, orci morbi dolor molestie ac leo Lorem eros. lectus et tristique tempor at scelerisque. elit.",
    "orci mauris ipsum scelerisque. tempor pellentesque Aenean senectus netus imperdiet suscipit non Mauris dolor ac vel Quisque consectetur Sed sagittis eu sed et lorem turpis Duis tristique nibh sollicitudin vel nibh. habitant ultricies finibus, dolor tempor interdum. sit malesuada a elit. et aliquet. Suspendisse morbi massa libero. eu amet, adipiscing volutpat leo Lorem tristique ac hendrerit, Ut ac egestas. Nam bibendum. molestie eros. interdum. lectus Ut vestibulum. risus purus",
    "ac eu ipsum nibh. in, et est. nisl Suspendisse suscipit turpis bibendum. lorem sit scelerisque. nibh Duis leo senectus Ut molestie adipiscing ac Quisque Pellentesque interdum. malesuada purus lectus cursus massa Lorem Mauris netus dolor risus habitant tristique tempor eu mauris Aenean libero. volutpat eros. sagittis finibus, vestibulum. hendrerit, at non Nam orci Sed sollicitudin dolor porttitor morbi pellentesque aliquet. amet, ac interdum. vel vel tempor sed elit. a egestas. fames non Nam molestie et risus tristique consectetur Ut sem ac imperdiet ultricies",
    "Quisque tristique molestie sem Pellentesque dolor imperdiet tristique interdum. nibh. morbi nisl fames eu Lorem molestie sollicitudin mauris interdum. turpis a bibendum. non egestas. purus est. ac senectus sed tempor sagittis ac ac suscipit lectus Nam malesuada nibh Aenean in, adipiscing orci libero. eros. et ipsum at massa"
  ],
  "publishing_app": "short-url-manager",
  "redirects": [

  ],
  "routes": [
    "molestie ac Mauris volutpat aliquet. non morbi tristique purus leo Ut lectus porttitor Ut Aenean nisl ac elit. Suspendisse malesuada non a sit habitant dolor Pellentesque scelerisque. ipsum Nam ultricies at cursus amet, sed sagittis tempor sollicitudin nibh orci tristique pellentesque nibh. hendrerit, adipiscing tempor Nam dolor ac et risus vel egestas. vestibulum. turpis eu senectus finibus, libero. vel sem imperdiet eros. Duis Quisque consectetur molestie est. et lorem interdum. interdum. netus bibendum. ac risus",
    "libero. Ut et Duis hendrerit, leo ac Aenean sagittis fames Quisque at Mauris nisl eu pellentesque malesuada egestas. in, dolor Ut Sed morbi Nam vel porttitor sit ultricies consectetur molestie adipiscing finibus, purus tristique sem interdum. scelerisque. Pellentesque sollicitudin risus Nam ac non eu non bibendum. aliquet. netus dolor orci nibh. imperdiet habitant risus sed ac molestie nibh tempor lectus Lorem ac vel volutpat massa mauris turpis vestibulum. senectus",
    "morbi tristique molestie fames",
    "ultricies amet, ac Ut nibh. Quisque Nam fames tristique sagittis scelerisque. tempor suscipit porttitor elit. dolor turpis risus Pellentesque egestas. cursus lectus orci risus interdum. finibus, massa et ac a lorem est. Mauris imperdiet tempor netus non leo purus volutpat malesuada morbi bibendum. sit Aenean sollicitudin vel Suspendisse adipiscing et in, eu senectus Duis hendrerit, nisl non Nam mauris vel pellentesque Sed eu libero. molestie ac molestie tristique nibh ac habitant vestibulum. interdum. eros. sed consectetur at sem Ut aliquet. Lorem ipsum dolor",
    "tempor nibh. turpis",
    "risus ac in, vel sem eu a Ut at libero. porttitor nibh. non senectus",
    "Duis vel cursus in, adipiscing ac lectus vestibulum. risus massa non ac Ut finibus, risus at pellentesque nisl netus Mauris bibendum.",
    "Mauris Nam tempor interdum. lorem ultricies fames purus pellentesque consectetur tristique massa vel cursus eu nisl molestie a in, risus non nibh ac Duis imperdiet interdum. adipiscing ac malesuada mauris at molestie elit. nibh. sollicitudin vel sit porttitor netus leo Quisque bibendum. lectus Nam ac Sed Lorem dolor volutpat amet, ac vestibulum. egestas. libero. aliquet. tristique finibus, senectus sem scelerisque. Ut Aenean et morbi Ut orci tempor habitant eu sed dolor Suspendisse est. hendrerit, suscipit risus non et turpis Pellentesque ipsum eros. sagittis"
  ],
  "schema_name": "role_appointment",
  "title": "adipiscing Pellentesque fames senectus orci sit hendrerit, malesuada scelerisque. interdum. vel eros. massa bibendum. Quisque imperdiet Mauris porttitor vestibulum. ac egestas. tristique nibh. tristique in, risus Duis nisl sed interdum. dolor Sed Lorem netus Nam vel Nam ultricies purus consectetur molestie tempor morbi Suspendisse cursus non turpis elit. nibh a et ipsum eu at Aenean finibus, eu pellentesque Ut Ut lectus suscipit et sagittis amet, sem ac ac volutpat lorem",
  "update_type": "major"
}

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

Attributes

bulk_publishing
boolean

links
object
facet_groups
Prototype-stage metadata tagging tree roots for this content item. A content item my belong to many facet groups without having any specific facet_values links.
facet_values
Prototype-stage metadata tagging values for this content item, a content item can be linked to many facet values from varying facet groups.
lead_organisations
DEPRECATED: A subset of organisations that should be emphasised in relation to this content item. All organisations specified here should also be part of the organisations array.
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.
original_primary_publishing_organisation
The organisation that published the original version of the page. Corresponds to the first of the 'Lead organisations’ in Whitehall for the first edition, and is empty for all other publishing applications.
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.
suggested_ordered_related_items
New A/B test suggestions for related items. Used for displaying related content on most pages, except for step-by-step and fatality notices. Links and their ordering are determined by the machine learning algorithms included in this A/B test.
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

{
  "bulk_publishing": true
}