Table of contents

Schema: take_part

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
Document supertype grouping documents by purpose
description
or null

details
object
body
string
The main content provided as HTML rendered from govspeak
change_history
array

image
object
alt_text
string

caption
string or null

url
string

document_type
string

Allowed values: take_part
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
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, 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
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
schema_name
string

Allowed values: take_part
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": "/92f3ab88-9085-489e-bda6-159eac80b50c",
  "content_id": "5d88a9a2-c07d-4562-9d42-a4ac2d71a0da",
  "description": null,
  "details": {
    "body": "turpis",
    "change_history": [
      {
        "note": "a netus sed interdum. Lorem libero. scelerisque. morbi finibus, et fames dolor pellentesque aliquet. risus ac amet, vel porttitor sagittis Ut ac ac non molestie Pellentesque interdum. Sed tempor tristique dolor tempor ultricies sollicitudin elit. nisl Quisque volutpat non Suspendisse mauris sem hendrerit, bibendum. imperdiet massa in, Aenean turpis leo lectus adipiscing purus lorem Mauris orci eros. Nam et ipsum malesuada habitant ac vel senectus consectetur eu risus egestas. vestibulum.",
        "public_timestamp": "2018-02-14T00:44:28+00:00"
      }
    ],
    "image": {
      "url": "http://example.com/5c92831d-62d5-4432-9f1b-d8a178127db1/122ea231-b874-46a0-b8ba-a0112477c03f#540200d3a43c0157f8353e13a9f3b6ef"
    }
  },
  "document_type": "take_part",
  "first_published_at": null,
  "government_document_supertype": "sit Nam morbi vestibulum. Ut pellentesque massa dolor ac suscipit sed tristique non Duis malesuada Nam eu eu mauris bibendum. ac tempor cursus",
  "links": {
    "level_one_taxons": [
      {
        "analytics_identifier": null,
        "base_path": "/b81c3bd8-7a3d-4333-a405-3bfddb600a32/ad340ec5-13ff-41a0-9477-665ee9c5aac4/a68e8a84-1682-4fb0-b607-2bcd5e4b7c1c/ef4827b5-be3d-4102-a681-1e5563ccf48f/e906dc00-9cac-4c9a-ace9-bb6295b5dfbc",
        "content_id": "0bca0f8c-8fe2-46c3-bbff-fcb3f254d574",
        "locale": "vi",
        "public_updated_at": "2018-01-21T15:23:54+00:00",
        "title": "sit sollicitudin Duis tristique non nibh. suscipit turpis vel hendrerit, purus dolor est. vestibulum. sem Aenean ultricies at molestie eros. Sed scelerisque. nisl Ut elit. massa habitant Nam ac interdum. morbi ac fames Mauris egestas. Quisque sed ipsum lorem Ut netus amet, molestie et risus aliquet. tristique et mauris"
      },
      {
        "base_path": "/20853caf-f086-41f9-b2b5-35fe840c7490/92dd29b0-6a22-4888-a425-e5aac7da8591/668b1f0a-01bb-4859-a92f-a437458c976e/1be396d3-2172-4ba9-a1d1-7237bef8b497",
        "content_id": "63f91445-cc96-46d9-9de9-11d5ec841776",
        "locale": "uz",
        "public_updated_at": null,
        "schema_name": "interdum. morbi Pellentesque nibh. Sed consectetur in, Lorem lorem aliquet. Nam tempor ac Quisque finibus, senectus sem Ut scelerisque. mauris leo vestibulum. porttitor nibh sed purus dolor Nam ultricies non eros. risus netus libero. massa Ut et imperdiet nisl et vel sollicitudin eu Mauris at eu a Duis egestas. sagittis turpis molestie ipsum pellentesque est. Suspendisse amet, tempor ac vel volutpat bibendum. hendrerit, adipiscing elit. orci ac dolor malesuada non lectus molestie ac risus sit cursus habitant tristique fames interdum. tristique",
        "title": "molestie ultricies finibus, elit. Mauris nibh. egestas. malesuada hendrerit, porttitor lorem risus non vestibulum. tempor Suspendisse interdum.",
        "web_url": "http://example.com/7923daae-2d8a-48c5-a4fc-8d4b4c4d3722/dd0af55e-3031-4e82-87bd-d2be57a10d41/6d222fbd-03c9-4c37-a86b-26ce222825f4/fff9507a-322b-41b8-9a67-a869ae130d7a#dbb8358f448f177429ed9e3f6338d0a6"
      },
      {
        "api_url": "http://example.com/f3d89805-3b07-4239-825b-ef9c3a83b721/21db30db-5538-43c5-aee2-92e59bfddfdd/4634cf5d-91af-436a-98e7-9bfebd2d7773#1238ba813bb78d7ec0e70431fb1ff7b5",
        "base_path": "/37674d68-8103-4b74-beab-d6f1f08fdac2/80badc99-2cf2-4da9-b4ff-23eb1e4f4e43/8390b370-d42d-427d-a115-7aaa04cf184a",
        "content_id": "f06926a9-aa76-494a-a603-6d12213c6a4d",
        "document_type": "senectus tempor Lorem vel et finibus, volutpat Nam tristique risus sollicitudin nibh tempor Duis imperdiet elit. consectetur at hendrerit, ac leo non porttitor Ut lorem malesuada eu ac Nam Ut suscipit",
        "links": {
        },
        "locale": "so",
        "schema_name": "Aenean molestie orci Suspendisse sit ac massa ultricies Mauris vel netus lectus dolor Ut eu nisl dolor ac et turpis Quisque sagittis porttitor finibus, fames a consectetur volutpat Ut morbi nibh. in, libero. tempor Nam habitant vestibulum. Pellentesque egestas. interdum. aliquet. hendrerit, ac suscipit ipsum eros. bibendum. Duis scelerisque. at nibh interdum. senectus tempor tristique malesuada leo eu risus cursus sem mauris sed vel Lorem amet, tristique sollicitudin ac purus",
        "title": "tempor sollicitudin sit elit. Pellentesque nisl hendrerit, Nam consectetur et ac Quisque massa tempor Ut mauris amet, risus cursus egestas. volutpat fames interdum. turpis Aenean vel at",
        "web_url": "http://example.com/741c8aca-22bc-4e64-a16c-9ea849138817#9b11f64031bce7c7f1e19d27cc3a5418"
      },
      {
        "api_url": "http://example.com/4779ecd9-b1f5-40c1-9af0-9fadc2fce8dc/8d59303a-def2-4043-abf0-5770bdfa6395/a4122dc2-53d1-45d2-a59a-26af2dd01498/c4f9f053-100c-4960-8fbb-bfd565f2cb65/f5cc4abf-2db1-4cde-a2bf-3cf2251aa544#406f0b3facc1c0f86514cd5f0c20f4aa",
        "base_path": "/de829411-9424-48b8-a375-4334215632bd/fd25c129-eed7-43f9-936c-e736c59b6fe4/9e767cee-f850-46a7-b603-d8bdefd226c5/1e4b8ece-3622-4bb5-9de6-946b14cf5197",
        "content_id": "7c89f2a3-eb2c-47de-9197-c4454768e446",
        "document_type": "lectus molestie leo Ut dolor purus imperdiet hendrerit, a aliquet. eu ac at nibh nisl sem pellentesque malesuada sed et Nam adipiscing Pellentesque Quisque bibendum. orci ipsum morbi massa risus fames consectetur ac tempor vel scelerisque. Lorem Suspendisse interdum. elit. est. Duis finibus, turpis eros.",
        "locale": "uk",
        "public_updated_at": null,
        "title": "Suspendisse suscipit interdum. Ut ac dolor sagittis est. bibendum. Ut habitant ac eu tristique Pellentesque Aenean interdum. egestas. risus tristique a volutpat at Mauris pellentesque porttitor morbi cursus tempor Nam sollicitudin molestie Duis ac vestibulum. Quisque Sed amet, nisl tempor et finibus, et mauris lorem ac eros. lectus netus consectetur sed eu molestie massa aliquet. nibh. turpis sit vel in, ipsum ultricies senectus fames sem adipiscing Lorem libero. malesuada dolor leo nibh vel orci elit. risus hendrerit, non imperdiet Nam purus scelerisque. non"
      },
      {
        "api_path": "/cdcd7fe3-9ad7-4c88-9fee-2d1e82a50d6a",
        "base_path": "/aa1aa906-9c1e-43bf-9f54-f389fec4542f/c21c14ab-9cf6-462f-a504-d33e61f17a01/00be07ab-0815-46bd-b52d-d03b90a178ae/f335b5fc-1e4e-466a-b6f8-c242ff6548b1",
        "content_id": "655c3824-7c52-46cc-8a26-2bb8e51795e6",
        "document_type": "nibh a Quisque suscipit molestie bibendum. et dolor finibus, tristique purus sed consectetur ac vel Duis fames ac nibh. vel eu pellentesque cursus lorem Ut est. imperdiet Suspendisse netus ipsum massa libero. tristique porttitor eros. et at tempor ultricies malesuada sit Sed sollicitudin mauris Aenean risus ac elit. adipiscing non dolor interdum. volutpat lectus hendrerit, in, aliquet. Lorem Nam amet, orci risus egestas. turpis vestibulum. eu leo senectus Mauris habitant Nam sem ac interdum. sagittis Pellentesque nisl molestie tempor Ut non scelerisque. morbi",
        "links": {
        },
        "locale": "et",
        "title": "Nam"
      },
      {
        "analytics_identifier": "sagittis sed et risus purus molestie volutpat at vel risus finibus, orci eu amet, Duis netus mauris ultricies tristique tristique tempor sem ipsum imperdiet consectetur Nam tempor cursus eros. Quisque dolor elit. libero. Ut nibh. ac molestie turpis a hendrerit, non ac dolor Suspendisse suscipit lorem lectus est. nisl Ut bibendum. Nam Pellentesque eu interdum. non leo massa scelerisque. vel malesuada habitant Sed Mauris porttitor et senectus morbi interdum. sollicitudin in, fames sit egestas. Lorem nibh Aenean ac adipiscing ac aliquet. pellentesque vestibulum.",
        "base_path": "/d80e118d-dac2-4cd3-b310-c580a33d807c/ed39cb71-a2ad-476f-b16d-7918549b4df8/cfb08bf0-a4d1-457f-b0c3-68ab6cc12f45",
        "content_id": "221fef30-26be-43bb-ae8c-de6e1d834f77",
        "locale": "so",
        "public_updated_at": null,
        "title": "a ac purus lorem Quisque risus cursus Duis sem Pellentesque netus",
        "web_url": "http://example.com/1688a8b1-c088-4cf3-a552-c9cc98bb0449/128f4096-d583-4a91-beec-ab0fe128c8eb#819d23a18467ddfff58db8c7d1c10dd4"
      },
      {
        "api_url": "http://example.com/b2411dcb-64c0-4845-aa62-520a26671719/0b4d8fa3-8bcf-4ec3-b2e4-bde535578236/3b9f2c3e-ea85-44e3-a089-affb3658bb9f#7f36ad6f0dc49af523975c569daedb2b",
        "base_path": "/07df55c1-bda0-4892-a9c4-aaae4ca69aee/b5637fd6-cd50-438a-9036-2d95bd53e782/d1e23a98-4430-4a24-b1ec-5faf0fa22efe",
        "content_id": "21a884d5-6fc9-44a9-8954-53ead07824a4",
        "locale": "sq",
        "title": "tristique et imperdiet eu suscipit adipiscing tempor leo sem consectetur orci interdum. ac",
        "web_url": "http://example.com/95162143-244c-48a0-b22c-8ba6d0d3b830#fd5c558fd37673b4d3237483fe22eac6"
      }
    ],
    "ordered_related_items_overrides": [
      {
        "api_path": "/37827347-8d94-430a-9c10-335b4b1c0177/c9926950-f068-484d-befe-1036b49719f9/b602f458-f263-4ee3-99b1-28b4a3c0c45c/4378006c-ce40-44da-8ef1-9e7a7c87fc9a",
        "api_url": "http://example.com/28e8a8bb-6233-4715-91e9-51d477502f2c/8327671b-186b-433f-ba7a-aaeb553f17f0/11774566-6c99-49fc-8d64-5b709dff58d4#bd07ca7cdd28951f3835064b1aa1bceb",
        "base_path": "/5cb95b66-bde6-4cc2-aa52-0e198c61fb51/64465f0b-b178-4f40-b544-f126f68ec257/197c626c-2054-491d-8257-273e37f5ec0c/6036f68d-ad96-4d81-bcf5-7dd542cc2bda/28a5cd12-1443-4241-b126-9ef0c44f6d34",
        "content_id": "f6a79f03-8db9-4dfa-9132-a5417d04e2d8",
        "document_type": "ac fames aliquet. sem eu",
        "links": {
        },
        "locale": "fr",
        "title": "ac et nibh finibus, ipsum consectetur Ut libero. non amet, risus massa dolor orci imperdiet a lorem eu tempor Nam tempor Duis sagittis Aenean aliquet. est. porttitor dolor suscipit bibendum. netus Pellentesque Mauris adipiscing interdum. ac molestie ultricies mauris",
        "web_url": "http://example.com/f92920d5-14fb-4609-8180-6c796257ab59/d520cd01-5a08-4169-8e21-1d358e947620#d394b96c2f72cff458b07522b4991fcb"
      }
    ],
    "primary_publishing_organisation": [

    ],
    "topics": [
      {
        "base_path": "/f2a21870-3ffb-4d06-8397-0cca5d210c3e/31bc0ef3-df7a-4f3d-a4ea-3b098b4a5230/31f178f1-3d0a-4a4d-b154-045002191904/4470409c-9144-4cef-af6f-d8cb4033bfea",
        "content_id": "f53c45ae-01b0-41c3-86bb-a295b32ca503",
        "locale": "ur",
        "title": "suscipit et sollicitudin vel cursus nisl bibendum. tristique Quisque Nam mauris lectus sem libero. risus imperdiet risus molestie morbi vel non est. pellentesque et Mauris scelerisque. interdum. eu eu ac hendrerit, ipsum sagittis tempor purus Suspendisse at orci Duis fames sed interdum. sit volutpat senectus dolor Nam consectetur malesuada ac finibus, dolor amet, in, Ut eros.",
        "web_url": "http://example.com/708779d8-33f8-433d-b193-48420c2bab2b#050b5376974d5774ff09db389e013f9d"
      },
      {
        "analytics_identifier": "vel lectus suscipit ac elit. eu pellentesque orci Mauris imperdiet adipiscing lorem molestie ac in, nibh volutpat Sed senectus aliquet. fames interdum. at Nam risus est. egestas. Ut eros.",
        "api_url": "http://example.com/c1e0c2b4-4b19-4cc1-8519-93553b0a169a/22571920-f0b5-4acd-a3fe-59a8a24f0eb5/124a55eb-2000-4740-9ed3-825b43596406#753fb7ce830e817a7fdcef511cb338ec",
        "base_path": "/d1da6763-48a3-4e6e-a952-f1b9ea48edf2/d52a5f27-311b-4eca-a293-94e8e723bba3",
        "content_id": "c278fa6a-9dcf-43e1-b61d-1a0aebd08865",
        "document_type": "nisl ultricies volutpat non dolor netus habitant senectus sed Ut tempor sem Mauris malesuada vel sollicitudin interdum. risus scelerisque. sit cursus a Duis finibus, non vel sagittis vestibulum. lectus suscipit nibh imperdiet adipiscing tristique leo orci et Nam egestas. tristique Sed molestie risus bibendum. turpis ipsum ac libero. eu Lorem et Suspendisse ac est. ac porttitor fames molestie Nam mauris dolor morbi in, elit. hendrerit, massa tempor eros. Quisque consectetur lorem Pellentesque pellentesque eu purus nibh. ac aliquet. at interdum. Ut amet, Aenean",
        "links": {
        },
        "locale": "el",
        "title": "ac tempor lectus molestie ac et elit. malesuada purus sed suscipit egestas. ac nisl Sed interdum. Quisque in, molestie ac interdum. netus dolor eros. hendrerit, non est. nibh nibh. fames volutpat amet, bibendum. scelerisque. lorem Lorem sit a mauris ipsum non senectus et sagittis Suspendisse risus porttitor Nam massa habitant consectetur Aenean leo vestibulum. vel orci finibus, tempor Nam Mauris at aliquet. cursus Ut Duis pellentesque Pellentesque tristique dolor sollicitudin sem libero. adipiscing",
        "web_url": "http://example.com/d3ae6781-b8a7-46b9-a415-c46060ddd8aa/d98d6b1e-255a-4bd7-b8e3-81cbbe6cb8be/a007264c-523d-4def-b94c-8d09c34b3a3e/085c3abc-379f-4311-b9dd-a616aded05ea/97636cd6-8a39-41a3-9476-a7d6804f8946#5f0b20380f7e530dfa69504faa0d9a6c"
      },
      {
        "analytics_identifier": "ac molestie dolor vestibulum. orci finibus, massa tempor senectus egestas. nibh nisl Ut dolor at Sed interdum. Mauris fames sed lorem Quisque suscipit tristique amet, ac eu non consectetur",
        "api_path": "/821c252a-5a20-4921-8430-9dcf4b26dd60",
        "base_path": "/d3c79145-d10d-450e-a6b5-2a9ce91b9723/9cc741b8-45b1-44b0-9411-f79ba03163c8",
        "content_id": "cd0f7b9e-50b4-4595-987c-dbfb0ee1db92",
        "links": {
        },
        "locale": "uk",
        "schema_name": "in, orci consectetur Nam nibh. purus molestie ac mauris Mauris vel amet, egestas. eros. suscipit pellentesque tempor hendrerit, adipiscing Nam volutpat libero. eu malesuada sem massa Ut risus vestibulum. aliquet. senectus bibendum. eu non tristique risus netus scelerisque. sit turpis Sed ac Lorem imperdiet non interdum. cursus Ut sed dolor interdum.",
        "title": "risus ipsum volutpat risus Duis ac sem cursus nibh. egestas. elit. malesuada ac netus vel Suspendisse eros. senectus et eu non Aenean nibh molestie purus in, amet, porttitor Ut tempor scelerisque. vestibulum. morbi Nam sollicitudin lectus Pellentesque libero."
      }
    ]
  },
  "locale": "es-419",
  "navigation_document_supertype": "et eu sagittis sed eu Aenean nibh ac vel ipsum orci",
  "phase": "beta",
  "public_updated_at": "2018-01-17T23:16:12+00:00",
  "publishing_app": "publisher",
  "rendering_app": "whitehall-admin",
  "schema_name": "take_part",
  "search_user_need_document_supertype": "nisl Lorem malesuada vestibulum. sagittis mauris tempor eros. senectus eu risus Suspendisse Nam elit. Mauris molestie scelerisque. Ut lectus nibh aliquet. Ut Quisque netus at consectetur sem a habitant vel sollicitudin amet, est. porttitor turpis imperdiet et non hendrerit, finibus, ultricies",
  "title": "vel netus molestie non malesuada ac mauris porttitor tristique Pellentesque ac imperdiet purus interdum. Aenean massa orci risus in, volutpat risus sit eu tristique et leo et morbi Sed non tempor eu nisl ac Nam ultricies eros. fames cursus finibus, Duis nibh. interdum. Mauris sem pellentesque consectetur adipiscing at molestie lectus turpis a Ut aliquet. ac sollicitudin lorem libero. dolor scelerisque. vel vestibulum. sed amet, senectus suscipit elit. tempor egestas. Quisque ipsum bibendum. Ut habitant hendrerit, est. Nam Lorem nibh dolor Suspendisse sagittis",
  "updated_at": "2017-12-29T17:21:00+00:00",
  "user_need_document_supertype": "Pellentesque Ut Sed hendrerit, non tristique cursus sollicitudin lorem purus Suspendisse et nibh eu eu sagittis leo molestie senectus Quisque molestie sit morbi Mauris vel interdum. consectetur et ipsum ac imperdiet orci vel"
}

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
body
string
The main content provided as HTML rendered from govspeak
image
object
alt_text
string

caption
string or null

url
string

document_type
string

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

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

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

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

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

schema_name
string

Allowed values: take_part
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "73b09b28-d0b4-46f1-b7e6-1e4b7548d8bc",
      "cda5d6d3-3c7b-4435-b947-dba9ab77fff6"
    ]
  },
  "analytics_identifier": "ipsum porttitor hendrerit, Nam volutpat amet, Nam suscipit Aenean interdum. eros. Suspendisse ac risus habitant et non at cursus non vestibulum. dolor in, tempor Ut aliquet. libero. senectus malesuada eu imperdiet ac nibh. vel Pellentesque lorem consectetur Sed interdum. ac Lorem leo finibus, nisl scelerisque. tristique a Mauris Duis",
  "base_path": "/5f502e60-cbd8-41be-893f-5fa501f1fd09/ef6108c3-036d-46fa-9f8b-6c3b0e98b4ea/15dd13ba-c83a-493f-a8df-c3f54d3f408f/b5b26a7b-6181-46ce-b70e-88af08353df3",
  "change_note": null,
  "description": null,
  "details": {
    "body": "ac molestie finibus, nibh netus sed hendrerit, molestie interdum. vel Suspendisse dolor ipsum vel sollicitudin cursus egestas. fames Lorem sit ac nibh. Ut habitant massa volutpat Quisque mauris eu sem amet, est. Pellentesque sagittis adipiscing in, tristique tempor non orci nisl scelerisque. et consectetur libero. porttitor tristique ac tempor Nam non risus dolor turpis bibendum. Ut Nam lectus suscipit a senectus pellentesque Mauris et ac elit. purus risus morbi leo ultricies Aenean Duis aliquet.",
    "image": {
      "alt_text": "Lorem Nam morbi consectetur ac massa imperdiet est. nibh Nam in, Sed aliquet. sit ultricies mauris bibendum. vel senectus orci porttitor et ipsum eu elit. et ac risus at Ut dolor turpis Pellentesque netus non fames vestibulum. habitant tristique non purus lorem nisl adipiscing finibus, sem molestie Aenean leo libero. volutpat amet, Suspendisse tempor tempor molestie suscipit lectus eros. Quisque ac malesuada vel",
      "caption": null,
      "url": "http://example.com/1beafb26-3518-4244-9bc1-24e71053394c/d3c72d35-ab62-4938-a44c-855b9b38961b/eae6f2f4-e19f-4f58-a20c-64c34c82ebb3#d20bab03273ddaae993dd484adc13792"
    }
  },
  "document_type": "take_part",
  "locale": "vi",
  "need_ids": [
    "vel vestibulum. sollicitudin lectus mauris ac Pellentesque fames risus aliquet. hendrerit, egestas. libero. finibus, porttitor at netus senectus imperdiet Aenean a orci ac Ut non nisl amet, scelerisque. pellentesque eu habitant tempor sagittis adipiscing Ut purus morbi et in, ultricies",
    "Ut Aenean eros. scelerisque. finibus, Duis fames libero. tempor molestie amet, at mauris sollicitudin orci Lorem risus Suspendisse nibh dolor ipsum massa aliquet. sit eu vel ac interdum. Quisque interdum. nisl egestas. leo ac ac suscipit lectus nibh. purus dolor vel consectetur adipiscing eu tempor tristique netus Sed pellentesque senectus imperdiet sed Nam turpis hendrerit, sem non et molestie sagittis Nam cursus vestibulum. malesuada elit. lorem risus ultricies Ut bibendum. Mauris non morbi a ac est. in, Pellentesque porttitor tristique habitant et volutpat"
  ],
  "phase": "beta",
  "previous_version": "Mauris a volutpat consectetur ac tristique non adipiscing netus tempor et fames sed scelerisque. porttitor vel malesuada vel ultricies purus sem finibus, morbi orci Sed Duis nisl eu massa molestie suscipit elit. risus Aenean tempor molestie dolor sit vestibulum. lectus Nam leo in, ac Ut nibh. ac risus Nam est. interdum. Ut turpis interdum. aliquet. mauris",
  "public_updated_at": "2018-03-23T21:48:11+00:00",
  "publishing_app": "email-alert-frontend",
  "redirects": [
    "molestie Aenean sagittis imperdiet ac nibh Quisque orci senectus Nam malesuada est. at et vestibulum. eros. aliquet. Lorem Duis Ut volutpat risus",
    "sagittis morbi nisl massa vestibulum. Aenean molestie ultricies Sed nibh. elit. tristique in, eu dolor molestie turpis ac pellentesque eros.",
    "non purus tristique Lorem sed non et Aenean interdum. volutpat elit. risus ac bibendum. Pellentesque libero. molestie tempor eu in, orci a eros. vestibulum. imperdiet porttitor Nam vel ac leo Ut netus sem Mauris dolor senectus est. lectus ac consectetur Suspendisse ultricies ac ipsum sagittis Quisque et at fames nibh malesuada eu turpis interdum. cursus Duis mauris pellentesque suscipit risus dolor Sed hendrerit, lorem tempor tristique nibh. Ut massa sollicitudin finibus, egestas. molestie vel morbi habitant adipiscing Nam scelerisque. sit nisl aliquet.",
    "eros. volutpat adipiscing"
  ],
  "rendering_app": "whitehall-frontend",
  "routes": [
    {
      "path": "et cursus ac orci Sed mauris a Ut bibendum. suscipit dolor nisl nibh hendrerit, lorem Duis elit. sollicitudin sit porttitor senectus sagittis non Pellentesque egestas. morbi Ut pellentesque imperdiet Quisque consectetur est. tristique Suspendisse tristique turpis vel molestie amet, scelerisque. ac eros. malesuada eu purus fames adipiscing tempor Nam netus nibh. sed massa leo ac eu vestibulum. vel Nam et",
      "type": "prefix"
    },
    {
      "path": "orci a at molestie amet, imperdiet purus sed netus sollicitudin Mauris mauris tristique tempor cursus risus vel malesuada interdum. ac molestie et fames pellentesque scelerisque. ultricies Suspendisse aliquet. sagittis turpis et vel nibh. lectus hendrerit, eu suscipit Pellentesque ipsum dolor nisl ac tempor porttitor egestas. elit. vestibulum. volutpat Duis Ut",
      "type": "prefix"
    },
    {
      "path": "lectus Ut Lorem risus bibendum. vel molestie egestas. in, Suspendisse ac Duis Sed Pellentesque Mauris nibh adipiscing interdum. sem leo non at fames dolor netus libero. nisl finibus, malesuada suscipit tempor vestibulum. eu non tristique purus volutpat pellentesque a habitant scelerisque. eu Nam sagittis mauris senectus tempor ipsum vel molestie et ac cursus Quisque ac sed hendrerit, orci eros. est. ultricies lorem imperdiet dolor elit. ac morbi sollicitudin interdum. et tristique consectetur massa Aenean turpis risus Ut",
      "type": "prefix"
    },
    {
      "path": "et interdum. Mauris",
      "type": "prefix"
    },
    {
      "path": "tristique leo hendrerit, ultricies egestas. est. molestie bibendum. pellentesque lorem sem ac scelerisque. sagittis Ut netus eu finibus, sed purus ac nisl suscipit morbi molestie et mauris vel dolor malesuada elit. Quisque habitant dolor cursus",
      "type": "exact"
    },
    {
      "path": "et Duis dolor sed est. tristique sit non ipsum Quisque tristique lorem volutpat porttitor adipiscing cursus finibus, nisl molestie lectus libero. massa Nam elit. senectus Pellentesque nibh morbi at Sed sem ultricies egestas. eu Ut eu vestibulum.",
      "type": "exact"
    },
    {
      "path": "habitant tristique non tempor in, amet, pellentesque massa finibus, lorem bibendum. egestas. molestie mauris vel vestibulum. eu hendrerit, porttitor turpis Nam sem et scelerisque. Duis risus ac Ut",
      "type": "exact"
    },
    {
      "path": "lectus eu nibh orci et purus elit. eros. bibendum. dolor libero. tristique Mauris ac Suspendisse Nam tristique Sed risus non Ut suscipit interdum. turpis egestas. sed sollicitudin mauris fames dolor vestibulum. scelerisque. Ut cursus sagittis tempor eu imperdiet ultricies amet, Nam sem porttitor vel Lorem pellentesque ac habitant Quisque nibh. consectetur tempor risus Aenean morbi ipsum vel non malesuada finibus, molestie massa lorem interdum. est. volutpat nisl leo molestie Duis a ac adipiscing Pellentesque senectus hendrerit, sit ac aliquet. netus at in, et",
      "type": "exact"
    },
    {
      "path": "interdum. senectus scelerisque. fames ac adipiscing netus Ut cursus suscipit at amet, dolor Nam mauris sed vel imperdiet consectetur tempor morbi egestas. hendrerit, ac et sit nibh. Ut sollicitudin nibh eu Lorem pellentesque malesuada in, Pellentesque aliquet. Aenean interdum. lorem eros. nisl turpis molestie finibus, Suspendisse",
      "type": "exact"
    }
  ],
  "schema_name": "take_part",
  "title": "at in, bibendum. fames Aenean vel eros. eu Quisque tristique habitant pellentesque suscipit tristique purus nisl ac dolor amet, Pellentesque scelerisque. non vestibulum. molestie imperdiet finibus, et risus Ut Nam ac a nibh tempor nibh. porttitor adipiscing Suspendisse consectetur Mauris lorem turpis",
  "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

{
  "previous_version": "hendrerit, non Nam consectetur dolor lectus suscipit netus tempor vestibulum. tristique Quisque ac elit. amet, Ut orci malesuada massa est. molestie finibus, vel nibh eros. tempor molestie aliquet. bibendum. ultricies sed Nam sem turpis in, lorem a mauris purus eu risus et ac morbi scelerisque. Sed Suspendisse porttitor at habitant vel libero. Ut ac Lorem ipsum risus interdum. non leo et imperdiet sollicitudin Pellentesque eu tristique nisl pellentesque sit"
}