Table of contents

Schema: redirect

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
or null

content_purpose_document_supertype
string
DEPRECATED. Use `content_purpose_subgroup`.
content_purpose_subgroup
string
Document subgroup grouping documents by purpose. Narrows down the purpose defined in content_purpose_supergroup.
content_purpose_supergroup
string
Document supergroup grouping documents by a purpose
description
null

details
object
document_type
string

Allowed values: redirect
email_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
first_published_at
or null

government_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
links
object
available_translations
Link type automatically added by Publishing API
child_taxons
Link type automatically added by Publishing API
children
Link type automatically added by Publishing API
document_collections
Link type automatically added by Publishing API
level_one_taxons
Link type automatically added by Publishing API
part_of_step_navs
Link type automatically added by Publishing API
policies
Link type automatically added by Publishing API
related_to_step_navs
Link type automatically added by Publishing API
topic_taxonomy_taxons
Link type automatically added by Publishing API
locale
string

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

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

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, search-admin, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
publishing_scheduled_at
or null

redirects
array

rendering_app
null

scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: redirect
search_user_need_document_supertype
string
Document supertype grouping core and government documents
title
null

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

{
  "analytics_identifier": null,
  "base_path": "/46ca2a48-7749-46e1-88e0-fb8f38f8eb2a/aea5d737-a2b7-41dc-9ae7-1adfe3c11ca3/1bb93224-abe9-4ba4-9619-5f1f540352d3/dd8b1338-d918-4055-b267-f4a0c4a5dea1",
  "content_id": "d7938d1c-7128-4f54-ac42-fbfe6ce39335",
  "content_purpose_document_supertype": "sed risus libero. leo netus porttitor malesuada in, est. a bibendum. ac aliquet. amet, lectus hendrerit, orci scelerisque. ac Pellentesque Suspendisse vel Sed cursus eu massa nibh non Quisque et risus adipiscing suscipit tempor Duis lorem at Mauris sem",
  "content_purpose_subgroup": "at Lorem ipsum porttitor scelerisque. sollicitudin non turpis in, sit a malesuada eu Quisque vel Duis et volutpat ac tristique orci tempor tempor Sed massa Nam nibh est. Pellentesque libero. bibendum. Nam",
  "content_purpose_supergroup": "et est. risus senectus Quisque ipsum purus eu massa imperdiet mauris Nam dolor molestie Pellentesque amet, scelerisque. vestibulum.",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "email_document_supertype": "in, dolor ultricies bibendum. malesuada suscipit lectus libero. turpis sagittis morbi imperdiet ac Ut eu finibus, at vestibulum. Lorem adipiscing a lorem non est.",
  "first_published_at": null,
  "links": {
    "child_taxons": [
      {
        "analytics_identifier": "Aenean risus tristique nisl sem ipsum in, interdum. eu vel elit. ac imperdiet Mauris malesuada est. Ut sagittis et risus dolor cursus massa Ut tempor vestibulum. Suspendisse libero. fames finibus, ac vel netus consectetur ac tempor lectus eu amet, Duis volutpat a hendrerit, turpis Lorem Quisque non morbi non Pellentesque nibh. purus scelerisque. suscipit Nam molestie Sed tristique nibh",
        "api_path": "/24eb97ca-012a-4ac4-b62f-463d4a9ac783/36a039e6-c616-4c82-ac83-17966b31d559/5623ea58-8140-4760-9c6a-91dfef77e632/755bf608-61de-4ffc-954e-8abc17780e0b/dbbdf1a0-4d13-4dc0-b86b-9ecd799a765e",
        "base_path": "/0e91f329-2107-416b-b082-4efbc04c897a/e7b66bd7-aba1-41df-9b69-2175758064c5/8aa2a43d-5a51-40ab-bdd5-c7ee82cb1dde/b2c1efd1-509d-4b35-81d2-0f3050a57c51",
        "content_id": "30697937-6c5e-4df9-bd27-d70633165725",
        "document_type": "volutpat turpis adipiscing sollicitudin nibh sed Suspendisse vestibulum. libero. elit. pellentesque bibendum. Pellentesque aliquet. consectetur porttitor cursus in, at Sed a molestie non nibh. ac molestie Quisque egestas. finibus, netus purus suscipit Lorem eros. Mauris lectus morbi eu nisl ac interdum. scelerisque. massa vel",
        "locale": "es-419",
        "public_updated_at": null,
        "schema_name": "risus eu molestie pellentesque Quisque at tristique non molestie Nam tristique Mauris Pellentesque fames nibh. orci adipiscing nibh Ut porttitor est. netus senectus sed risus libero. sollicitudin Aenean ac ac ultricies morbi vel et Lorem lorem ac et bibendum. suscipit dolor Suspendisse tempor aliquet. massa Duis interdum. eros. ac imperdiet in, eu hendrerit, lectus vestibulum. consectetur turpis volutpat dolor non amet, mauris egestas. vel leo scelerisque. purus cursus tempor sagittis habitant interdum.",
        "title": "dolor fames sit Lorem malesuada et aliquet. eu egestas. sem molestie orci lorem lectus ac interdum. tempor pellentesque nibh. dolor consectetur volutpat ac Ut mauris imperdiet nisl purus suscipit cursus ipsum leo est. habitant Mauris hendrerit, sagittis molestie et libero. ac finibus, bibendum. Nam Aenean scelerisque. Sed tempor non turpis risus in, elit. at morbi senectus Duis eu Pellentesque vestibulum. massa amet, porttitor vel non vel ac a tristique eros. Quisque interdum. tristique netus sollicitudin sed Suspendisse risus adipiscing Ut ultricies"
      },
      {
        "api_url": "http://example.com/6344e742-697a-421d-a6ac-fe0411ce5b8d/02b4eeeb-41ac-40fa-beea-e9c24fee588f#7df76dc104f4aa1270ad4fbf3ff94455",
        "base_path": "/249d1ca6-70cc-49f3-a694-a42c51bbc498/e84691a9-0c71-4449-8919-b9ae66e0cf09",
        "content_id": "372d3ab2-bf50-4417-91a7-2a93cb7ee694",
        "document_type": "Ut amet, risus lectus finibus, orci non a tristique ac aliquet. Mauris dolor et eros. sed eu libero. ac nibh interdum. molestie ac morbi consectetur netus hendrerit, elit. porttitor interdum. eu nisl suscipit ultricies non sit Nam ac sem ipsum dolor senectus tristique",
        "locale": "ar",
        "title": "tempor finibus, Quisque Aenean sagittis ac lectus dolor suscipit cursus vel Ut consectetur nisl est. hendrerit, volutpat Mauris habitant vel ac egestas. imperdiet ipsum Lorem",
        "web_url": "http://example.com/426a663a-89dd-4bcb-8d4c-cf2d47f3c8fb#d0a2edba91efe82e2f93ef06a56c72a9"
      }
    ],
    "children": [

    ],
    "part_of_step_navs": [
      {
        "base_path": "/7066e069-0c54-41b7-a51a-08701e8636da/a032b2b4-c182-40c2-a7ea-be294e8aaeb9/9ed46a5f-d5bf-4f0b-90cc-e453619d2e84/7f3b7b5d-cdeb-4307-802d-c8fbe365afd7/a5902c2e-05b4-43fc-acc3-4a40dc130e12",
        "content_id": "c42c73e1-2e42-419b-8bfa-1c320fd7dd44",
        "links": {
        },
        "locale": "zh-tw",
        "public_updated_at": null,
        "title": "molestie Aenean ac vel sollicitudin imperdiet orci fames mauris tristique et Ut ipsum et in, a nibh. ac dolor vestibulum. Ut Suspendisse sagittis interdum. interdum. hendrerit, dolor sem massa finibus, volutpat elit. scelerisque. ac risus"
      }
    ],
    "related_to_step_navs": [
      {
        "analytics_identifier": null,
        "api_path": "/a071a7c4-360d-4c79-a03c-81db56da5df5/4fc711d3-137a-43f0-a6d1-b7abfab4c3e9/07961b69-22af-4381-a766-87de38f3346d",
        "base_path": "/a23561ea-b549-4d17-b5fa-7bc6d9379dcd/df9efce5-f45a-4774-a807-206bed0b6218",
        "content_id": "d1fdf10f-1c80-453a-89b6-6f07413654ef",
        "locale": "ar",
        "schema_name": "imperdiet volutpat egestas. turpis sit hendrerit, consectetur nibh. non fames tempor pellentesque sem",
        "title": "imperdiet vestibulum. nisl tempor ipsum senectus turpis molestie purus molestie et ac hendrerit, cursus Duis Mauris eu a elit. risus vel morbi Suspendisse ac vel at libero. leo bibendum. orci sit ac volutpat fames dolor Lorem habitant nibh sagittis eros. massa interdum. Pellentesque netus tempor amet, ultricies Sed consectetur"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/c883eeb5-e1cd-48ff-91bb-f9f6c3f8e568#5d13ec63bcdbecf2284ab56245247410",
        "base_path": "/d3f77cd8-5b21-4fef-a8e6-1d8f87842595/783b7e1c-eb37-4fec-acc6-0b5f74744ceb/de2534de-81cf-4041-b1e0-a27cc3d22c0c/2e651841-0e89-4610-a323-0a6cecf90fc8/1d26e90e-da16-4749-819c-5c37bdbbe897",
        "content_id": "98c67e43-8b36-455f-9e75-8a346e1a3235",
        "document_type": "adipiscing interdum. at malesuada dolor nibh. eu libero. Quisque Nam et et tempor sagittis vel cursus eu scelerisque. sollicitudin sem elit. molestie hendrerit, netus non est. massa vestibulum. habitant mauris consectetur eros. ac Ut Pellentesque molestie turpis lorem Sed morbi bibendum. volutpat nibh aliquet. in, Suspendisse lectus tristique ipsum senectus amet, ac risus Aenean",
        "links": {
        },
        "locale": "ru",
        "public_updated_at": "2018-09-15T05:43:16+00:00",
        "title": "eros.",
        "web_url": "http://example.com/709f4265-a660-4c0a-82b0-4f2dbbf8d809/edbd1c19-f7b3-4bb7-bad3-8ef671c92959/c7e9f148-d4ae-4ee4-82a0-60db79da15d8/1582d016-e275-4829-9c6a-f8b276832657#0bbf78fbf373ef8b2dd62bf2069a54c0"
      },
      {
        "analytics_identifier": "interdum. mauris amet, lectus cursus sollicitudin netus at Duis Quisque sem Ut et eu molestie ultricies dolor et finibus, senectus libero. eros. a risus interdum. bibendum. Mauris adipiscing molestie aliquet. tristique scelerisque. egestas. turpis Nam non ac nisl in, sed sagittis Sed suscipit volutpat vel Suspendisse tempor vel ac ac eu massa fames orci Nam non hendrerit, sit risus vestibulum. ac nibh. Ut elit. lorem est. leo dolor purus Lorem Aenean nibh imperdiet consectetur malesuada habitant ipsum tempor pellentesque porttitor Pellentesque tristique morbi",
        "api_url": "http://example.com/737ca61c-1d19-4ca3-a694-62a06391c545/d24d33dd-ca13-4bb5-b61c-de6ace6bfd9e/066200c1-e4f4-4241-9454-fbef25b1a88a/46906491-a799-4617-9c06-98e2fa1c2a10/4e15f159-3a4b-4f0a-811d-d948b5374210#ee682aa59b5b692c7d80ad8f2ba7f150",
        "base_path": "/59bcfc32-004a-4074-b8d7-2586c7cd1799/080df8d2-ae16-4863-9d7f-24ce98b6f35b",
        "content_id": "56d32935-3e2c-4e31-9597-1dff1e43124f",
        "links": {
        },
        "locale": "uz",
        "public_updated_at": "2018-09-07T21:54:35+00:00",
        "schema_name": "molestie et tempor fames sem Mauris senectus amet, imperdiet massa ac risus tristique consectetur vestibulum. elit. purus ac dolor cursus finibus, Sed Aenean dolor est. sit Nam vel netus bibendum. habitant pellentesque in, vel sed scelerisque. et nisl lorem turpis non eu risus sollicitudin nibh. Duis Nam aliquet. porttitor orci a Lorem adipiscing at eu volutpat Ut hendrerit, egestas. eros. Ut",
        "title": "adipiscing Pellentesque massa interdum. vestibulum. Aenean finibus, bibendum. vel suscipit Lorem eu risus porttitor sit et"
      },
      {
        "analytics_identifier": "ac consectetur lectus interdum. ipsum Lorem et bibendum. Nam elit. amet, in, est. orci non eu tempor pellentesque dolor",
        "api_path": "/eabca71d-8e3f-4144-9987-58ee8ce05730/803385b4-7838-4819-9aa7-9f181aff7395",
        "base_path": "/6f69854e-20e3-4b9e-8d6f-080297e0c9df",
        "content_id": "2aadb97b-dbc4-4170-a3fb-81dc400e9bea",
        "links": {
        },
        "locale": "so",
        "schema_name": "Quisque tempor at interdum. dolor sem elit. turpis vel ac vel ultricies netus lectus eu molestie tempor ac consectetur sed senectus adipiscing ipsum risus aliquet. bibendum. malesuada leo finibus, risus Duis ac eu lorem libero. sagittis imperdiet egestas. nibh massa a non non sit interdum. Nam volutpat molestie est. suscipit Pellentesque orci in, Lorem pellentesque sollicitudin ac eros. morbi et fames amet, tristique porttitor purus dolor habitant vestibulum. Nam nibh. Ut Aenean scelerisque. et cursus nisl hendrerit, mauris Ut Suspendisse Sed Mauris tristique",
        "title": "purus Ut dolor mauris sollicitudin Nam ultricies massa vel Suspendisse adipiscing Quisque eu netus habitant nibh. molestie aliquet. tempor sed ac Nam interdum. nibh interdum. dolor volutpat non cursus libero. suscipit et ac ac est. a leo eros. tempor et Lorem tristique hendrerit, amet, consectetur vel risus senectus bibendum. porttitor egestas. tristique sit Mauris Aenean imperdiet in, sem scelerisque. ac morbi Duis Pellentesque molestie lectus vestibulum. nisl fames non ipsum pellentesque orci Ut at eu",
        "web_url": "http://example.com/ff6a90cb-bbb0-4c49-8195-4567678992df/c1c1c8c1-2be2-4e68-8e47-b37d19e97f56#9652b7ed9066417e1e0b063aacc045d5"
      },
      {
        "analytics_identifier": "hendrerit, eros. risus leo lorem netus eu mauris orci ac egestas. vel libero. senectus ac Aenean ipsum massa interdum. vestibulum. dolor morbi bibendum. porttitor tristique a aliquet. cursus et dolor volutpat risus in, Nam fames nibh. elit. nibh tristique adipiscing ac habitant finibus, sem purus molestie turpis sit est. Suspendisse suscipit imperdiet Sed malesuada Pellentesque Mauris sagittis sollicitudin Ut non tempor interdum. ultricies Nam tempor scelerisque. amet, nisl Lorem vel Ut pellentesque consectetur molestie eu non ac et sed lectus at Quisque Duis",
        "api_url": "http://example.com/ebacdb6f-a7be-4431-bae3-98df71ade43d/733464f2-b8eb-4714-9c88-9cb72c52bc86/10dfd533-a06e-48c4-98b6-cdab0f84b484#52dabeb27ecc9cb81b3c4a7c26a7f968",
        "base_path": "/2c9a8a2b-4950-4df5-bed0-86e5cee28bc6/f1daca3c-7f7b-47b1-9331-d29977b75247/19ded1e8-5f37-46e3-9c72-b48332d61562/2e999fa2-d009-49d9-9c59-bb427e70f05c/635f9edb-c6ee-4318-bb2f-834c18e1499e",
        "content_id": "9850e639-5155-4778-8e12-c1615aeae957",
        "document_type": "non molestie in, vel nisl dolor orci malesuada mauris leo ac scelerisque. Quisque tristique nibh. netus et est. Suspendisse eu hendrerit, lectus sollicitudin morbi massa Ut non consectetur tristique vel Ut sem egestas. habitant risus suscipit imperdiet elit. eros. Lorem Pellentesque bibendum. sagittis vestibulum. Mauris tempor turpis Nam Duis lorem fames porttitor eu Nam at sed Aenean Sed volutpat amet, ipsum dolor risus aliquet. a finibus, adipiscing interdum. libero. nibh ultricies ac ac et tempor molestie cursus senectus pellentesque interdum. ac purus",
        "locale": "zh-tw",
        "public_updated_at": null,
        "title": "Nam dolor suscipit ac a lectus molestie risus sagittis cursus non risus dolor nisl ac tempor Nam et Duis fames Lorem Quisque sit Suspendisse sed scelerisque. at ultricies porttitor amet, bibendum. est. nibh massa Sed Ut molestie volutpat finibus, libero. senectus hendrerit, ac malesuada Aenean Pellentesque et nibh. vel purus ac non interdum. Ut ipsum netus lorem turpis aliquet. morbi orci habitant eros."
      },
      {
        "analytics_identifier": "fames ultricies elit. et Pellentesque adipiscing purus at sem hendrerit, Nam Aenean non est. eros. Ut suscipit senectus risus ac Sed non et interdum. nibh. sagittis molestie Lorem tristique pellentesque Quisque tempor amet, Ut vel dolor bibendum.",
        "api_path": "/53f6ca70-1afe-459c-9b42-31ed9e031a7e/eea10c3a-3331-436f-8d8f-7060ca8cfbbd/2e20a12f-6450-4918-b421-43df6e72877c/3d5e0101-f768-4bea-a6a0-a44fc5419801/35b5f7fd-e92b-4417-aa57-5c9e25d82a42",
        "api_url": "http://example.com/55e1defe-9459-4ca0-b37d-67cb4981d45f/419182c4-d99c-4f61-ab01-09ab4c4f1db5#5a5659ddd253af4da649a1c07b4605e3",
        "base_path": "/dfa22384-e85c-44e8-85ae-a34efc8d1a78/f86d142c-f0e2-48d1-854c-af77535e15dc/f73911fd-5392-4a92-8888-b833b1ea51c6/2128cb46-66e5-466d-bc0e-f898742d9661/18f89916-76b8-4483-b61f-6408ba311bdf",
        "content_id": "c78340df-da34-4063-9f11-d2c8b0dfa2dd",
        "locale": "ka",
        "public_updated_at": "2018-07-06T10:26:54+00:00",
        "title": "ac senectus ac Ut tristique et nisl nibh Mauris cursus interdum. a Aenean et aliquet. elit. risus ac",
        "web_url": "http://example.com/2a29e0ef-63e8-4861-b693-fdceb63a93ae/984c3833-2c85-4299-b3df-2216d42386a2/d6dbefb7-99a4-49e4-a3b5-783504f9f99f#e2f7a5ef59debfe91c39abfade5fd7d5"
      },
      {
        "base_path": "/16303537-90ed-4ba6-9e08-861f05f3aff2/3806ab1c-12b8-440d-b23c-bc53c7cace30",
        "content_id": "0f657106-d4ff-412e-962a-0d64820a034b",
        "document_type": "volutpat et elit. Mauris Sed Lorem ac in, risus tempor scelerisque. et at Nam Ut dolor sed aliquet. eu purus Quisque sollicitudin Nam hendrerit, eros. non mauris turpis egestas. leo sagittis bibendum. porttitor molestie amet, sem lectus interdum. suscipit nisl vestibulum. netus tempor Aenean est. ultricies libero. consectetur morbi Suspendisse malesuada pellentesque interdum. eu fames tristique senectus a vel ac tristique",
        "locale": "ro",
        "public_updated_at": "2018-09-14T17:24:52+00:00",
        "schema_name": "habitant adipiscing sit interdum. cursus ultricies non Pellentesque porttitor molestie egestas. tempor bibendum. netus tempor ac risus vel ac tristique lorem in, nibh. hendrerit, tristique Nam Aenean orci Lorem sem Ut interdum. malesuada Sed ac Quisque eu turpis risus sed finibus, suscipit ipsum mauris fames sagittis purus lectus non Mauris aliquet. scelerisque. nisl senectus morbi vel Ut dolor ac",
        "title": "pellentesque est. finibus, et aliquet. tempor ipsum risus et nibh. ac Nam mauris senectus sed molestie Nam morbi cursus lorem Mauris dolor ac fames Sed tristique",
        "web_url": "http://example.com/a70a2c37-2162-4048-b142-8d88b9aa9d3e/69e1e936-902a-449a-8778-1c60a1f767bc/4cf4d1d7-5f6e-4927-8507-d6f42ffe4e36/3c2f4487-2864-4b1f-a4fb-5495f076bd57#2025c9772c2217f34f31ff979cd1f7e3"
      },
      {
        "analytics_identifier": null,
        "api_path": "/4b01c2ff-a600-47bd-a7aa-23bf2ee56074/13857613-1804-4916-9f90-0d3504ea2290/10e9b976-9758-4850-a9fe-f639943177db/64eb8f12-dec0-4731-bb01-93301d2dec94/011c9ef8-b2d2-42a6-9e3d-fdc16dd2cedb",
        "api_url": "http://example.com/9f011a67-161f-4631-816e-ee91c878abec/f49b29d2-6f95-4fb7-bc54-fb0954fb9d77/c7f49766-95be-4c6b-8f1f-7e72f56a2782/4baaca6a-802f-4945-b43a-62eab813beab#8066b1d12b132318cc79c2668ea376f9",
        "base_path": "/2daf5c34-ba00-42a7-9524-dc96092b92cc/21df1691-84c6-4f7f-9f9d-e782f41260b0",
        "content_id": "014f7d82-38e6-4d67-8a68-7ddf53f765ed",
        "links": {
        },
        "locale": "zh-tw",
        "public_updated_at": null,
        "title": "Mauris malesuada volutpat risus in, amet, sem vel ac finibus, sit lectus morbi orci scelerisque. turpis sagittis tempor Nam et aliquet. cursus molestie risus lorem tempor interdum. interdum. egestas. Lorem Quisque vel eu Aenean nisl pellentesque adipiscing at leo nibh. suscipit molestie est. fames non massa dolor ac bibendum. sed habitant et mauris netus imperdiet ultricies ipsum Duis consectetur ac a nibh purus dolor tristique libero.",
        "web_url": "http://example.com/012ef44b-c45e-447a-a1cf-edb3e3203288/4188cfdc-c488-4e3e-993f-ff89d85e3acb/1bdbf196-4a83-4457-8694-ac4895050f03/ff741638-11f5-40b0-aa0c-db31ec754cf9#a0ba69859b4a216a5cde9c81e04f6849"
      },
      {
        "api_path": "/27b651aa-ec46-4ea5-bea9-c92da68cec89/b6cffcc3-83bb-49da-a52e-879583f0ec04/0067011b-4031-421d-8095-581208de7510/48ffd194-f262-4a3d-b83c-a6aa20e89dd5/2a6a4ad3-0a06-4371-816e-7887b78a2755",
        "base_path": "/b9fd46e8-90fc-4f81-a24a-bfae449a9ee7",
        "content_id": "3d6e878d-fc0f-4bb7-a322-3d59d2d13d96",
        "document_type": "turpis Ut vel ac Lorem fames sollicitudin nibh. et adipiscing amet, bibendum. pellentesque Pellentesque morbi et massa",
        "locale": "tk",
        "public_updated_at": "2018-08-24T13:47:07+00:00",
        "title": "amet, ac tempor lorem tristique eros. risus Sed Nam Lorem ipsum sollicitudin in, lectus Mauris et tempor turpis non finibus, aliquet. at sem Duis bibendum. vestibulum. cursus volutpat pellentesque habitant sit risus et eu egestas. suscipit interdum. est."
      }
    ]
  },
  "locale": "ur",
  "navigation_document_supertype": "habitant Ut tempor Aenean Duis et ultricies nibh. interdum. eros. tempor vel tristique volutpat sollicitudin Lorem dolor mauris adipiscing lectus molestie nisl fames orci massa sed amet, ac Nam cursus egestas. at elit. suscipit Suspendisse sem et porttitor leo risus Quisque nibh senectus consectetur vel tristique bibendum. morbi netus lorem finibus, molestie imperdiet malesuada ac Ut ipsum libero. Nam pellentesque eu interdum. Sed ac hendrerit, in, non non dolor eu ac sit scelerisque. purus risus a sagittis vestibulum. turpis aliquet. Mauris Pellentesque est.",
  "phase": "live",
  "public_updated_at": null,
  "publishing_request_id": null,
  "publishing_scheduled_at": "2018-06-11T13:56:10+00:00",
  "rendering_app": null,
  "schema_name": "redirect",
  "search_user_need_document_supertype": "morbi amet, Sed interdum. tempor molestie Aenean",
  "title": null,
  "updated_at": "2018-09-17T02:27:13+00:00",
  "user_need_document_supertype": "libero. suscipit in, sollicitudin vel orci tempor Nam massa morbi Ut sed elit. turpis risus molestie at ac egestas. Pellentesque Sed nisl Suspendisse bibendum. et dolor sit ultricies mauris hendrerit, Lorem fames tristique nibh. netus Mauris porttitor lorem ipsum eros. nibh amet, interdum. vestibulum. Ut non senectus a adipiscing lectus cursus Duis ac scelerisque. et pellentesque malesuada consectetur leo tristique sem est. finibus, risus purus Nam aliquet. imperdiet volutpat non sagittis ac habitant molestie Aenean dolor tempor eu Quisque interdum. vel ac eu"
}

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
null

details
object
document_type
string

Allowed values: redirect
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
locale
string

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

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

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

rendering_app
null

routes
array

schema_name
string

Allowed values: redirect
title
null

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "analytics_identifier": "Quisque tempor ipsum turpis vestibulum. suscipit sed vel libero. ultricies ac in, imperdiet non mauris molestie nibh ac sit non Nam morbi leo purus tempor lorem elit. volutpat consectetur adipiscing dolor Suspendisse lectus Ut netus sollicitudin Mauris Pellentesque malesuada vel cursus Nam eu bibendum. ac a Ut Aenean orci dolor tristique nisl eros. risus Sed sem massa nibh. interdum. aliquet. ac finibus, senectus porttitor habitant Duis at et scelerisque. Lorem risus amet, sagittis eu et est.",
  "base_path": "/750b5281-f770-4639-b16b-a7c95db187af/91bb44c8-e614-4218-a447-ac2f4a79cc49/60ae6edf-1747-4f3c-9aa3-8b7c95d6386c/72f19277-f48d-40cd-86b4-14c8d62e9a93/8c17fd31-44be-4954-b10d-bf2f90f3bb4d",
  "document_type": "redirect",
  "first_published_at": "2018-07-06T09:52:34+00:00",
  "last_edited_at": "2018-09-05T22:00:42+00:00",
  "phase": "beta",
  "previous_version": "at Nam nisl tempor Aenean suscipit massa tristique leo finibus, lectus Sed ultricies porttitor eu sollicitudin consectetur scelerisque. bibendum. hendrerit, tristique et ac amet, nibh ac interdum. et turpis volutpat Lorem elit. orci mauris molestie habitant risus malesuada vestibulum. Mauris dolor vel aliquet. egestas. in, cursus adipiscing ac Quisque",
  "publishing_app": "whitehall",
  "redirects": [
    {
      "destination": "/18fd85be-4643-4c84-935d-b60ded7e9d93/707e6b2e-d310-4025-96e5-943dd4411b5b",
      "path": "/19bdea5c-1b4a-4294-9f8b-e28aa48f815a/50c95acc-7ba3-48fd-9195-c9e7d2c31406/e9b4e3c6-fbb5-4b68-92ef-539695585d19/10e3bc55-f96e-4ef3-9139-3fd924c44488/e6b7bc6e-e459-4c57-ba5e-dc2358d3f485",
      "segments_mode": "preserve",
      "type": "exact"
    },
    {
      "destination": "/88bac134-f0f8-42b2-bdd4-31098ef94688/fb14acc2-d3ce-4ad6-b998-d1d30fa58ce9/f2e0e79f-6039-4f2c-9f34-95cc32b7e121/5be519f6-0cf4-4378-a1a1-22551d099355/0152ac13-580a-41bd-a254-5c7357c43d76",
      "path": "/e2d8babb-76e1-402e-bb2f-e565e94301e2",
      "segments_mode": "preserve",
      "type": "prefix"
    },
    {
      "destination": "/1c9ea72e-46c4-4667-b46a-dfa5c1f99b80/fbe2e995-6441-401e-86c0-1789cbb89886/4bd982e7-22a7-44fe-aba3-e5f5d8d2efad",
      "path": "/9ad46b2a-025f-4743-85bf-3045d67c621f",
      "segments_mode": "preserve",
      "type": "exact"
    },
    {
      "destination": "/eebb8f83-505d-403b-ac08-10060c1ed9ff/b618b43d-6c18-45d5-8e45-1836b0b4fe88/7af576e0-db26-4d1d-b586-633b4467045c",
      "path": "/a2cf6a8f-6ee7-4797-8611-f16f7d05a34b",
      "segments_mode": "ignore",
      "type": "exact"
    },
    {
      "destination": "https://kmgcyhr.rliqjx.kgij.nsuhvg.gov.uk/1183beb4-92ce-473b-9ef4-2755d96785e1",
      "path": "/f650ced7-6b80-4641-a27c-2e271ba12115/b05f123f-71cf-4db8-87fc-f0f9a8fec719/2e559836-1d61-4a28-9c90-99267e2871d6/d5ee870c-68ce-4ba3-a196-f5fc272841fa/f2602531-7252-43f2-aa6b-0eb11535bb89",
      "segments_mode": "preserve",
      "type": "exact"
    }
  ],
  "rendering_app": null,
  "routes": [
    "pellentesque vel non consectetur Lorem dolor dolor eros. molestie imperdiet nibh. sollicitudin Nam elit. risus et ultricies tempor Ut Sed Suspendisse turpis lectus eu vel Mauris porttitor sagittis",
    "dolor non Pellentesque tristique tempor",
    "interdum. fames sed lectus ipsum a in, ac suscipit tempor eu non risus Nam Aenean libero. imperdiet Mauris tempor tristique est. Suspendisse Quisque risus dolor et massa consectetur pellentesque eros. at amet, non finibus, nibh. mauris Duis sem elit. bibendum. molestie scelerisque. adipiscing morbi ac nisl sagittis volutpat lorem vel sit molestie sollicitudin aliquet. ultricies nibh Sed tristique Nam Pellentesque eu purus cursus vestibulum. senectus et vel dolor Ut Ut malesuada ac egestas. hendrerit, ac orci interdum. porttitor turpis netus leo habitant Lorem"
  ],
  "schema_name": "redirect",
  "update_type": "minor"
}

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

Attributes

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "links": {
  }
}