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": "/7a4007f4-48d0-46cb-9214-127a3021ef58",
  "content_id": null,
  "content_purpose_subgroup": "lectus non Nam risus ultricies Ut Suspendisse consectetur turpis ac nibh. Aenean elit. mauris libero. at vel molestie ac malesuada interdum. amet, vestibulum. porttitor ipsum a finibus, Quisque tempor pellentesque Sed Ut aliquet. egestas. sollicitudin sagittis senectus sed Nam in, tristique dolor Mauris eu nisl scelerisque. hendrerit, nibh bibendum. molestie leo risus Pellentesque massa sit lorem suscipit tempor sem et ac Lorem purus eros. ac non Duis habitant interdum. et eu adipiscing vel tristique imperdiet netus volutpat cursus",
  "content_purpose_supergroup": "ac egestas. Quisque orci volutpat ac eros. sed suscipit eu a risus senectus adipiscing sit tristique elit. finibus, dolor mauris Nam malesuada tristique eu habitant turpis scelerisque. leo interdum. hendrerit, non Mauris lorem bibendum. et sem ultricies sagittis netus nisl et risus morbi at cursus dolor amet, tempor purus Aenean Lorem imperdiet nibh ac",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "links": {
    "available_translations": [
      {
        "analytics_identifier": null,
        "api_path": "/eb7c5253-3d34-46e9-a867-72c4ef29551a/fda9872d-878d-4477-9297-1adeaa6a395b/e6efc96c-c751-4f88-9c6c-1594c67364fd/ccb60e6e-37d9-454b-af59-5e60eba24329",
        "base_path": "/597e6ecc-753c-4fb2-810d-5722b58df636/6f983fdd-4cb8-4d6f-8572-ffaabab9bd67/07535aa7-3189-4f14-b25c-34c4ee394ed3/fad8bc97-591b-49e2-8cb8-7e75d93d1d97/55b19087-c471-43af-adf5-e89ab01711cf",
        "content_id": "c864a933-868f-40af-b0b7-202276dd492b",
        "document_type": "imperdiet tristique Pellentesque libero. lectus sagittis Quisque molestie bibendum. sed egestas. elit. morbi pellentesque",
        "locale": "uk",
        "schema_name": "vel egestas. sagittis malesuada tempor tristique ac risus sed lorem ac et Ut porttitor risus netus ac et Nam volutpat ultricies dolor eu Quisque nisl adipiscing finibus, consectetur tempor amet, hendrerit, sem scelerisque. in, Lorem est. fames elit. leo vestibulum. Suspendisse molestie ipsum eu interdum. purus vel Nam nibh suscipit Mauris pellentesque interdum. morbi sollicitudin cursus molestie nibh. aliquet. massa senectus Aenean Sed orci non sit imperdiet at a turpis eros. bibendum. Ut Duis lectus libero. dolor tristique Pellentesque habitant mauris non ac",
        "title": "dolor molestie eu in, volutpat sagittis Ut amet, molestie Aenean Mauris suscipit Nam non et morbi tempor vel malesuada eros. ac mauris turpis sit nibh. Sed ac hendrerit, finibus, consectetur tristique sem ac orci sed risus est. porttitor Pellentesque lectus habitant Quisque et ipsum dolor Lorem imperdiet sollicitudin aliquet. nisl elit. non netus senectus lorem interdum. vestibulum. cursus tempor tristique eu a libero. purus ac at Suspendisse leo bibendum. nibh massa pellentesque",
        "web_url": "http://example.com/3f6dfc5d-f7dc-4ee6-b400-a09a21e80933/d02657b1-626d-45ec-b29e-2d7d0d1d0847#dc08635d14738e7480633a52fcc90712"
      },
      {
        "analytics_identifier": null,
        "api_path": "/bbe49fe7-ebcc-41c3-9f27-d3430596c63c/3f833f7a-76e7-4a75-b47a-5235a9609d4e/66c95ddc-a582-49f5-83b2-4995602a39e7/4910876c-cd96-4eb3-9082-e7ccbed04fe9/63cab440-e38d-4130-a19f-897012b9344a",
        "base_path": "/d70145a9-8c22-402c-a053-ed9ecd592e16/fc589cbc-7c8a-4b78-8934-efbea52409b7/1ce4b807-54c8-49c5-a52c-d1b71b4a4e8f",
        "content_id": "3415443a-0190-41cc-a397-701c41a849e5",
        "locale": "zh-hk",
        "public_updated_at": null,
        "schema_name": "morbi dolor elit. ac nibh. amet, vestibulum. ultricies eu sagittis vel molestie porttitor sem Aenean non molestie tempor purus risus aliquet. mauris Quisque Pellentesque pellentesque interdum. ac imperdiet scelerisque. Mauris senectus tristique est. interdum. finibus, tristique dolor eu consectetur malesuada lorem massa suscipit orci sed Ut at tempor leo cursus bibendum. ac turpis eros. sit Nam nibh et sollicitudin risus libero. non netus lectus Nam Suspendisse nisl Sed adipiscing fames habitant ipsum egestas. Ut et a in, Lorem volutpat hendrerit, ac vel Duis",
        "title": "imperdiet habitant"
      },
      {
        "api_url": "http://example.com/f6c98fde-6e57-4a1b-bf66-e3d3169fef5e/2fb7f6c1-f8c9-4be2-a6b6-4567df5cbc75/047157b6-24b4-43d9-a427-64ff937a1cb3/43047daa-18fd-4dc0-8d43-3adb48bf359e/5212af4f-0522-442b-9fb0-8316e6ff4f5e#5ccb2bd8c4ad717ea24e2e06985e1e76",
        "base_path": "/42edc4f8-1ae3-4bce-aa64-ca2c77da67fd/c987a70f-2ae5-4798-ab8b-af184eb8b4a0/d8fcee98-e589-44d6-9f19-19ddf93c4ec2",
        "content_id": "2b1b68f4-fbbe-4389-906b-b6aaf6f36b8f",
        "document_type": "Quisque non sit amet, risus Sed Aenean egestas. turpis est. dolor Nam Ut nibh Ut dolor ac ipsum Suspendisse scelerisque. ac tristique consectetur tristique elit. Mauris massa leo sed Lorem hendrerit, ac Nam vel sem fames nibh. ultricies Pellentesque in, et orci malesuada aliquet. purus eu Duis senectus nisl bibendum. at eros. tempor pellentesque eu molestie netus vestibulum. et volutpat lectus finibus, imperdiet porttitor molestie interdum. habitant non interdum. ac cursus tempor sollicitudin vel morbi a sagittis suscipit risus libero. adipiscing mauris lorem",
        "links": {
        },
        "locale": "ka",
        "public_updated_at": "2018-08-14T04:05:21+00:00",
        "title": "finibus, et risus libero. est. bibendum. molestie lorem orci a non purus amet, molestie fames pellentesque sit porttitor risus ultricies Ut interdum. interdum. consectetur nibh. ac leo sem vestibulum. Nam et ac at netus nisl volutpat massa Sed",
        "web_url": "http://example.com/86446f22-8b0d-4a5b-a3c5-fd1ed84cb6d1/775acf91-b69e-4956-bd9c-2893edcc4511/819f5528-f359-4c5b-8ed4-f6ad12303ca1/c6092f40-f0f7-47ad-a421-a1da5a8e2cc4#98c34e2d12e14a6f4336892ee2e17cd7"
      },
      {
        "analytics_identifier": null,
        "base_path": "/2966ad16-45cf-4b65-a95d-ba8cec1523f0",
        "content_id": "fe55d609-d9b8-45dd-949d-5d0f14132893",
        "locale": "cy",
        "public_updated_at": null,
        "title": "aliquet. lectus Nam bibendum. purus ultricies ac porttitor risus hendrerit, orci Nam dolor netus morbi fames Pellentesque ac massa est. et dolor Lorem tempor Duis turpis tempor egestas. tristique vel et finibus, interdum. a volutpat nisl leo Mauris ipsum non elit. pellentesque adipiscing malesuada Ut non interdum. vel sollicitudin vestibulum. molestie nibh. in, ac sagittis habitant eros. consectetur senectus sem imperdiet Suspendisse scelerisque. Ut suscipit sed Aenean tristique risus libero. Sed mauris nibh eu molestie lorem Quisque cursus amet, at ac sit eu",
        "web_url": "http://example.com/66e9bb96-6013-41d9-8f7a-282e1290fb65#55f3b06fe0849e3786224641113b9e77"
      },
      {
        "api_url": "http://example.com/92f00317-3046-42c6-a170-a0e3c315587d/6e26e7f3-1034-4a22-a04c-7049e71d2f13/3010dfb3-e408-4833-ad5d-83232452b757/04a54ce2-0cfb-4e63-a201-964d0bf8fe15/e996adb9-b7bc-4920-b31d-15bc43736fe0#94aa8084c67cf3ca178d0c570aecb489",
        "base_path": "/9f05f4c9-14f4-42df-b3e1-3109b60e34af",
        "content_id": "702d0c3d-f6bb-4972-a0a6-908d8859754f",
        "document_type": "pellentesque senectus eros. tempor orci morbi at egestas. bibendum. vel nibh. ac imperdiet in, Mauris Aenean amet, dolor netus tristique nisl Sed sem sit non ac Lorem nibh et Quisque Pellentesque vestibulum. ultricies a mauris ac molestie habitant malesuada et tristique interdum. non libero. consectetur sagittis ipsum leo porttitor risus Duis Nam Nam Ut turpis tempor purus massa volutpat Suspendisse lorem suscipit interdum. aliquet. finibus, eu risus ac lectus est. vel",
        "locale": "tr",
        "public_updated_at": "2018-08-10T05:30:20+00:00",
        "schema_name": "egestas. sollicitudin turpis finibus, Quisque libero. adipiscing Suspendisse ac in, non eros. habitant Pellentesque Nam nibh. fames lorem et volutpat risus suscipit tempor eu Aenean amet, ultricies non Sed imperdiet ipsum porttitor Ut lectus scelerisque. massa elit. leo nibh Nam mauris bibendum. Ut hendrerit, sem pellentesque dolor est. sed tristique eu ac tempor molestie risus aliquet. interdum. tristique at ac dolor morbi a nisl sit vel Mauris interdum.",
        "title": "fames nibh. eu tristique orci scelerisque. est. bibendum. Nam tempor nisl Nam Pellentesque interdum. suscipit Lorem massa libero. lorem sagittis sit tristique a vestibulum. dolor et Quisque adipiscing dolor netus volutpat sollicitudin imperdiet et Ut mauris lectus molestie consectetur porttitor amet, at pellentesque morbi risus Mauris sed ultricies Aenean Sed eros. malesuada nibh interdum. risus leo ac cursus aliquet. in, ipsum egestas. turpis Ut purus elit. finibus, sem vel Duis ac hendrerit, vel eu habitant senectus molestie tempor ac non ac Suspendisse non"
      }
    ],
    "child_taxons": [
      {
        "api_path": "/5a9fce0a-c4b2-4c2e-8e9c-56da3d4faa7e/b9dfa6a4-6c68-4b01-a9b3-b15d24f90e6d/e93f6f51-e4c0-4ddf-b2f1-422b7af9e529",
        "api_url": "http://example.com/fa3d98be-f5b8-4270-a4f1-9f9cbe38569d#0ac0bf892caedf627fe2509fcc6fb862",
        "base_path": "/fa1e4807-a66b-4f9a-bc56-8c57fbe0280d/bf2f3147-f83a-4871-8861-216e1b1d9a95/2c09eff6-1c31-44cc-b930-178430b755fb/beeee685-858e-4f91-969c-69d7b556c4a8/5eae5398-4f83-4afd-9711-721462ea2e56",
        "content_id": "900f1439-b480-4575-b1d6-151e42177793",
        "document_type": "Nam est. ac purus in, nisl ac Lorem et risus Pellentesque at dolor fames molestie Sed molestie aliquet. massa lectus finibus, morbi Quisque ipsum Nam eu et libero.",
        "locale": "he",
        "public_updated_at": "2018-08-13T11:59:06+00:00",
        "title": "nibh. sed ac nibh aliquet. finibus, in, imperdiet habitant vel eu tristique Duis interdum. Pellentesque Mauris dolor bibendum. tristique Nam massa suscipit senectus scelerisque. amet, molestie lorem at ac malesuada vestibulum. Ut Ut a netus mauris morbi leo ultricies eros. consectetur orci adipiscing Lorem tempor Sed hendrerit, vel porttitor Suspendisse non elit. risus lectus risus Nam cursus ac et non eu sollicitudin dolor pellentesque est. Aenean et nisl ipsum"
      },
      {
        "analytics_identifier": "orci cursus sit turpis ac nisl dolor Ut pellentesque porttitor Quisque et imperdiet libero. Pellentesque eu vel malesuada Mauris Nam non Sed bibendum. sed ac molestie vel morbi Lorem hendrerit, interdum. est. tempor eu lorem habitant et finibus, ipsum suscipit Ut Aenean fames netus lectus ultricies eros. purus sem elit. tristique amet, risus interdum. scelerisque. consectetur adipiscing volutpat massa nibh. a non tristique dolor ac egestas. nibh ac senectus leo Nam molestie tempor sagittis mauris at Duis sollicitudin Suspendisse risus in, aliquet. vestibulum.",
        "base_path": "/1aab431b-eace-448c-8f80-083235c269e8/c3ec903d-d559-4951-a0a0-ab3bd90151b0/596db405-7ba9-4d05-8c41-e3ba01955c0a/334de388-7f14-47a2-aca5-8e3f410fe727",
        "content_id": "d342bb43-04e0-4cf3-8159-0dbda768bbcb",
        "document_type": "ac aliquet. massa interdum. eu malesuada eu Pellentesque suscipit mauris sit Sed finibus, leo Nam egestas. risus ac risus ac pellentesque sed fames nibh ipsum tempor et lectus morbi habitant nisl imperdiet ultricies Aenean at Nam tristique turpis elit. cursus Ut vel senectus et non bibendum. eros. in, vestibulum. a vel est. purus dolor tempor adipiscing dolor molestie Quisque sagittis",
        "links": {
        },
        "locale": "es-419",
        "public_updated_at": null,
        "title": "at molestie",
        "web_url": "http://example.com/165f8d4a-be05-48d1-96b0-909a9428baf2#9cfd87a4b79162ba6c015d44876184b7"
      },
      {
        "base_path": "/5bea202d-fb2e-495f-a980-fb2a70477a7c/f71db22f-38f5-4887-a0af-8b8f553d06a9/9057951d-01cb-4093-9487-afc80a0f1118/5bf8d831-79ba-4355-9dfb-04f33633b331",
        "content_id": "2741a3cb-8bb5-46c0-bef0-3eb2a6b65fd2",
        "document_type": "et vel Nam Ut Duis ultricies non leo cursus fames nibh ipsum amet, a et senectus tempor Pellentesque purus libero. Nam bibendum. eros. scelerisque. Sed turpis massa lorem mauris habitant est. nibh. sed vestibulum. lectus interdum. finibus, at sagittis elit. sollicitudin tristique",
        "links": {
        },
        "locale": "hu",
        "public_updated_at": null,
        "title": "Quisque habitant ultricies scelerisque. cursus non Nam senectus malesuada purus mauris interdum. Ut Pellentesque nibh. egestas. finibus, sed sollicitudin sem risus massa in, molestie nisl dolor Lorem at aliquet. a imperdiet volutpat Suspendisse et ac consectetur est. lorem vel vestibulum. libero. netus et elit. pellentesque Ut Duis ac vel dolor Sed interdum. tristique leo Aenean sagittis Nam non bibendum. morbi hendrerit, eros. ipsum"
      },
      {
        "api_path": "/f69114b7-1a1a-4f5e-8bd8-5cddf893b90e",
        "base_path": "/776f6cda-44b5-4cea-95b3-c8bd6ec98d3f/398fbc53-ae1d-49d9-a306-fe5f491b3bdb/3ea993ee-4a79-4683-8313-f463f28f1ca2/20dabd12-b248-46a4-950a-5d717140c091",
        "content_id": "3022dd23-6543-42ec-a1f9-e046a11ddc1a",
        "links": {
        },
        "locale": "sr",
        "public_updated_at": null,
        "schema_name": "et cursus mauris consectetur molestie vel risus Ut elit. egestas. eu sed a malesuada Quisque ac ac est. Suspendisse lorem purus in, non Nam at Duis interdum. sollicitudin senectus eu massa libero. leo Lorem orci fames risus sagittis lectus porttitor adipiscing hendrerit, tempor amet, interdum. molestie Aenean netus eros. dolor nibh ultricies finibus, Sed non bibendum. ac Mauris sit vestibulum. morbi aliquet. volutpat ac tristique dolor turpis ipsum pellentesque sem suscipit nibh. habitant nisl imperdiet tempor vel Ut Pellentesque tristique Nam scelerisque.",
        "title": "Ut purus netus Duis sit tristique consectetur ipsum aliquet. fames molestie in, morbi massa orci vestibulum. interdum. Aenean non bibendum. Pellentesque Ut libero. est. sagittis Suspendisse a Sed eros. molestie adipiscing porttitor pellentesque at nibh et dolor suscipit cursus mauris tempor sollicitudin volutpat Nam ac finibus, imperdiet amet, hendrerit, lectus Lorem et tempor vel ultricies tristique nisl leo dolor ac senectus lorem eu egestas. sem sed risus Quisque scelerisque. nibh. Mauris Nam elit. non ac eu habitant malesuada risus vel interdum. ac turpis"
      },
      {
        "api_url": "http://example.com/3a0a24b6-384c-4d39-a2c2-aeedbadbbbab/cf9776bc-c0b8-4cff-9012-7557dfd48031/31223ebd-189e-4cfd-9d5e-35ab56095a5c/8ddbc8ae-6ee2-4f5f-a176-bd38f735fcbf/6e2c0c2c-748a-43d1-8e3d-6e5da755cbc3#c2eee28ea595f7c763c223223b26df2d",
        "base_path": "/9d38375a-df74-4c6e-8a3f-a46e03652464",
        "content_id": "89666419-379c-4bfc-9b57-073de1faba00",
        "document_type": "consectetur elit. non vel hendrerit, molestie nisl libero. senectus a massa eros. ipsum Aenean et fames sed interdum. tempor sollicitudin sit Lorem nibh netus risus tristique tristique cursus finibus, Quisque dolor in, Nam nibh. aliquet. ac ac volutpat tempor suscipit morbi molestie dolor vel scelerisque. Nam lorem sem pellentesque purus orci risus turpis malesuada Mauris adipiscing est. non bibendum. amet, Suspendisse ultricies imperdiet egestas. eu eu Ut Duis lectus ac ac Ut habitant leo sagittis et vestibulum. Sed mauris Pellentesque porttitor interdum. at",
        "links": {
        },
        "locale": "cy",
        "public_updated_at": null,
        "title": "finibus, vel lorem et volutpat amet, malesuada tempor eu sit mauris tristique molestie Quisque vel eros. Nam senectus"
      }
    ],
    "children": [
      {
        "base_path": "/d51fd10c-c284-4a8c-b3ed-f0df76640bde",
        "content_id": "bb350eb3-55e0-4595-b3fb-5e730dd55e98",
        "locale": "th",
        "public_updated_at": "2018-09-30T19:16:13+00:00",
        "schema_name": "Quisque nisl et adipiscing molestie Lorem Mauris Nam tristique nibh. at interdum. sagittis est. malesuada porttitor hendrerit, netus purus dolor morbi libero. mauris ac turpis eu Pellentesque vel habitant ipsum tempor Sed risus aliquet. lectus finibus, imperdiet tristique Aenean amet, sed nibh non egestas. dolor vel leo molestie tempor volutpat eu ac ac consectetur et Duis interdum. scelerisque. eros. elit. ultricies orci a in, cursus non ac massa Ut Ut sem senectus Suspendisse lorem",
        "title": "vestibulum. mauris Duis tristique et vel morbi est. porttitor risus finibus, purus ac suscipit risus imperdiet dolor ultricies non scelerisque. bibendum. orci hendrerit, tempor fames pellentesque dolor molestie adipiscing ipsum",
        "web_url": "http://example.com/ded1f55e-d748-4d9b-931d-555482dfafff/6162eec5-d55b-4570-97d2-b2ccf3b0bd0f/aa69dee7-c97e-4daf-b8f1-00e40e0cdb20/2523bbce-c7e4-4a86-9bd9-9f0cdceb07bf#f7faa793893ecbcb8aa6bf02160cbd0d"
      },
      {
        "api_url": "http://example.com/8b31119f-511a-45c2-a1c8-19b0ec26517f/e0a561da-6ec1-42f8-abbf-b9ac562f47a9/c5b52f4f-6c50-4e42-8061-ca4c608689a9/1754df61-6e72-4c18-875a-2608bb150b79/cf741b62-fba0-4553-8ddc-c3ea8f0eb1ca#742997c3904e234be7b57faf01f19ad0",
        "base_path": "/1b2d176a-7d0e-4446-b271-feef70ed2da2/dec34e44-b6d0-4444-879a-b98a78236746/c1023eec-c34a-4064-ba3a-25677d63898c/0ee526c2-8543-42b8-9f12-76e2e47ac1a9/60ecc647-97e2-4697-83c2-e9d075366bc6",
        "content_id": "59babd0b-8eeb-4fb7-9713-bc19ee8dae17",
        "document_type": "interdum. tempor sollicitudin nibh. purus interdum. tristique et Sed turpis porttitor Nam Suspendisse a ac lectus Ut vel Pellentesque risus imperdiet eros. eu pellentesque mauris tristique consectetur tempor lorem vestibulum. senectus hendrerit, Aenean sem leo sagittis Mauris vel nisl Ut malesuada morbi ac Nam Lorem eu molestie ultricies adipiscing risus dolor amet, non bibendum. aliquet. suscipit in, sed molestie libero. ipsum orci cursus est. ac sit dolor Quisque nibh at ac finibus, egestas. Duis non volutpat massa fames elit. netus scelerisque. et habitant",
        "locale": "lt",
        "title": "nibh. lorem pellentesque ultricies interdum. Quisque cursus massa Nam tempor fames sem ac hendrerit, finibus, ac vestibulum. in, malesuada Sed consectetur libero. sollicitudin Suspendisse non nibh interdum. non Duis a vel elit. purus orci dolor molestie sed habitant egestas. tristique Ut bibendum. Nam nisl et Ut sit adipiscing aliquet. morbi eu ac at sagittis amet, vel eros. est. suscipit netus eu tristique leo imperdiet ac et volutpat turpis molestie dolor senectus risus porttitor Pellentesque tempor ipsum Aenean Lorem mauris scelerisque. risus Mauris lectus"
      },
      {
        "analytics_identifier": "non leo bibendum. porttitor netus aliquet. senectus risus fames sit Ut orci lorem turpis ac ultricies sed tempor mauris eu egestas. cursus Mauris lectus sem nibh. vestibulum. malesuada sagittis ac Lorem consectetur molestie a adipiscing interdum. scelerisque. est. nisl",
        "api_url": "http://example.com/209eaa0a-4e27-49b5-b249-e889cfe4d63e/5ab75c57-a16d-42ec-be1b-5fce73cca947#cd33d1266a9b2cf3b22196996d10f24c",
        "base_path": "/b0b2e984-e415-4550-9fed-393fea2b6c4d/20800891-9c9d-4dc6-b1b1-f04d1d1f6d22/4099597c-b7eb-4649-a09b-44b989a0a471/d930f31a-287e-421b-a4d3-7d1ee644c496/28c3d98f-dbf8-49f5-a102-ab5589b4780e",
        "content_id": "437f2fa6-6068-4742-be5b-56e677e503b3",
        "document_type": "Lorem et Duis fames ipsum interdum. interdum. a adipiscing cursus est. Aenean tristique elit. vel at in, orci tristique Sed tempor vel ultricies libero. Suspendisse dolor Quisque eros. Nam imperdiet nibh senectus scelerisque. lectus",
        "locale": "es-419",
        "schema_name": "orci habitant Duis Lorem non netus imperdiet a dolor risus Quisque Sed fames Nam interdum. est. interdum. mauris bibendum. vel eu finibus, risus leo tristique pellentesque purus nibh. turpis malesuada massa Nam ac volutpat Ut aliquet. ac lorem tristique libero. et tempor in, vel Pellentesque amet, elit. lectus tempor at Suspendisse porttitor eu ac ultricies nibh sollicitudin sed senectus nisl scelerisque. Aenean et sagittis hendrerit, egestas. eros. adipiscing morbi consectetur dolor molestie suscipit Ut non molestie ac vestibulum. ipsum sit sem cursus Mauris",
        "title": "imperdiet non porttitor sit Pellentesque dolor molestie fames Duis Lorem vestibulum. libero. volutpat senectus at massa egestas. interdum. non ac Nam sed dolor suscipit Ut molestie orci tempor lorem Suspendisse vel morbi scelerisque. et Aenean Nam Mauris aliquet. tempor tristique interdum. sagittis Sed in, turpis hendrerit, tristique lectus ac consectetur mauris nibh. vel sem pellentesque ac eu malesuada amet, Ut sollicitudin leo ac habitant Quisque adipiscing risus risus",
        "web_url": "http://example.com/96747e5a-ce31-4a5b-bc25-9b8485356347#bda4d9a70728ff07cac5d4cebf67ffea"
      },
      {
        "api_url": "http://example.com/7e911e88-a871-4af8-8bf3-2c3a3126009b/80750a81-404a-4b09-b96a-bcd1557293c8/1be005f3-29a1-4dc4-a304-98bc3b013874/6a0a719f-d67d-4ae1-bfa1-10f5982837c2/23d503e2-ba09-47d1-a8e6-df4c9ee6ffeb#31e10702d0e4d243ec09d3bb5ea51073",
        "base_path": "/61227f2e-9d88-48f4-b853-5619b9c15809/33240028-0adc-4d59-ae65-b9cd1b1c00b2/d0c7bc0d-7603-4a6d-bc61-e7ed5ed8ffdc/357e2440-21eb-479e-9b82-3be6951bfb2d",
        "content_id": "384d9010-9cc5-4733-9a3a-b0f73a88f323",
        "locale": "de",
        "title": "risus eu Quisque vel libero. sagittis scelerisque. Nam nisl habitant at Lorem nibh. interdum. malesuada et ultricies non leo dolor porttitor amet, orci egestas. Duis et turpis nibh bibendum. non Ut mauris cursus fames ac lectus Aenean Ut vel suscipit a tristique eros. sollicitudin senectus netus in, ipsum sit interdum. purus volutpat risus tempor ac imperdiet lorem massa tempor finibus, sem eu hendrerit, aliquet. tristique ac sed Mauris consectetur dolor",
        "web_url": "http://example.com/a931d177-98d1-4ed1-bca6-65939ed9b699/a6e175ff-14c0-4914-ac5a-b2007ef42b5b/f73c5d56-c454-4336-8428-d363dc8a6fd5/4f286a1d-43f1-460e-92b1-c4e59f15662f/e6a802d4-4c77-43b6-a217-86f4c888e6fd#d6d718b1f453b649ec653eba1f61dcb1"
      },
      {
        "api_path": "/2ba7a5a7-b59d-43ab-9198-8eedde4638fe/b8b1f57a-9fdf-4907-99b8-f83800a626d1/9b6a74d2-7d1e-4ae1-a9b1-3bb93cb51790",
        "base_path": "/47430d5f-8461-43e8-8bb6-ee6146ea4856/075ccdeb-502a-4aea-aaea-50edf8bafffc/d0bf33e3-1027-4919-b16d-063ef35161a1/c181a8f0-33bf-491a-afce-7e937f2e5ef3/bd664e8c-c047-4a10-9a1c-6aa194e048b2",
        "content_id": "ec16012f-1c0f-4ed9-b170-792fa649da71",
        "document_type": "ultricies et sagittis eu sollicitudin senectus dolor tempor eros. risus eu consectetur elit. finibus, tempor dolor bibendum. tristique ac interdum. morbi porttitor non interdum. et est. adipiscing ac molestie mauris orci ac sem purus a Ut vestibulum. in, Ut Nam fames Duis nibh turpis nibh. pellentesque Quisque Mauris amet, tristique at massa netus Suspendisse non scelerisque. hendrerit, lorem leo risus molestie malesuada sit lectus imperdiet ac sed vel cursus Nam suscipit libero. Sed nisl habitant ipsum aliquet. Pellentesque volutpat Aenean vel egestas. Lorem",
        "links": {
        },
        "locale": "tr",
        "schema_name": "Aenean amet, ipsum ac hendrerit, vestibulum. suscipit sed at netus cursus bibendum. molestie sit morbi et in, Pellentesque leo malesuada tristique Suspendisse risus lorem Duis fames Ut risus est. interdum. non lectus eu tempor dolor sollicitudin Ut Nam Mauris eros. ultricies nibh",
        "title": "at porttitor tristique eros. Ut netus elit. bibendum. morbi molestie a senectus ac Lorem Sed dolor vel dolor nibh habitant Pellentesque Quisque molestie ipsum ac lectus Duis Nam Nam non consectetur interdum. aliquet. et turpis ac suscipit eu libero. lorem"
      }
    ],
    "related_to_step_navs": [
      {
        "api_path": "/1a1dc3b3-0843-4ee7-9e65-4d3abd69d59e",
        "base_path": "/611f18eb-3ed3-44cb-a28d-41cdc5628d63",
        "content_id": "80ff4600-a5b8-4858-a2c1-c84fba4ff5db",
        "document_type": "ultricies mauris et amet, at egestas. turpis sollicitudin tempor purus ac porttitor cursus aliquet. orci Duis Quisque Nam tempor volutpat finibus, et Ut sagittis vel interdum. libero. imperdiet non habitant tristique Pellentesque Lorem vel consectetur risus hendrerit, suscipit Mauris ac eu Aenean ac lorem morbi in, bibendum. Ut sed massa a risus lectus non malesuada nibh. sit nisl elit.",
        "links": {
        },
        "locale": "si",
        "public_updated_at": null,
        "schema_name": "ac bibendum. Pellentesque sit pellentesque non consectetur habitant cursus dolor volutpat Quisque et non senectus Ut vel elit. tristique leo eros. nibh. massa interdum. tristique nibh adipiscing Ut suscipit turpis risus Sed libero. et a aliquet. molestie sem ac finibus, imperdiet malesuada lorem Aenean amet, dolor scelerisque. morbi risus at tempor netus molestie est. fames sed Mauris Suspendisse",
        "title": "egestas. tristique habitant Pellentesque eu consectetur molestie Quisque Nam nisl sit non dolor lectus suscipit sem molestie risus et vestibulum. est. adipiscing sagittis Aenean cursus risus ac a fames at bibendum. Nam interdum. pellentesque volutpat eros. amet, scelerisque. mauris interdum. nibh elit. vel ac vel libero. ipsum leo tristique non et Suspendisse ac dolor porttitor imperdiet Mauris orci sollicitudin nibh. netus Ut ultricies sed massa lorem purus eu Duis Lorem in, tempor Sed finibus, Ut aliquet. hendrerit, ac tempor malesuada"
      }
    ]
  },
  "locale": "tk",
  "navigation_document_supertype": "eros. tristique vel suscipit volutpat in,",
  "phase": "live",
  "public_updated_at": null,
  "publishing_app": "contacts",
  "scheduled_publishing_delay_seconds": 1,
  "schema_name": "redirect",
  "title": null,
  "updated_at": "2018-08-27T12:56:47+00:00",
  "user_journey_document_supertype": "scelerisque. cursus libero. volutpat ac ipsum tempor Duis suscipit finibus, interdum. molestie Lorem Suspendisse sagittis ac bibendum. non consectetur a molestie et vestibulum. morbi eu purus ultricies pellentesque leo est. lectus",
  "user_need_document_supertype": "hendrerit, molestie Duis sollicitudin vel fames Aenean volutpat netus et tempor sed molestie orci est. purus leo lorem sem nibh. Suspendisse amet, porttitor senectus scelerisque. consectetur imperdiet interdum. Ut Sed"
}

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

{
  "access_limited": {
    "auth_bypass_ids": [
      "a2b1a362-769e-4b5c-8069-f607db4f2419",
      "7770e265-da5d-4935-8fad-a3d946972ab0",
      "95e716fe-5f67-453e-96dc-ed6ae90b0d1c",
      "f1e81e18-18b4-4c10-8aa6-38bde22aca9a",
      "bb3a9988-36f5-4825-9606-98f7b6a8c9f7",
      "703d49a1-e380-4d13-a192-c2d55113be24",
      "74b53d91-8edb-4867-8ada-63a1416a474c",
      "1efad88c-3a7e-48ae-962c-d9f80a1f3328",
      "e8be533b-247d-4b56-a230-b10c5cafbcaa",
      "7308afe8-dd9a-43c1-8639-afd1621f0d0d"
    ],
    "users": [
      "cursus interdum. Suspendisse Sed imperdiet eros. tempor lectus orci Lorem Quisque sem leo a ac turpis egestas. Aenean sagittis consectetur et tristique nisl in, fames sollicitudin vestibulum. aliquet. lorem dolor bibendum. scelerisque. vel malesuada tristique ac dolor sit porttitor interdum. volutpat netus finibus, Nam amet, hendrerit, non at purus Nam",
      "aliquet. eros. interdum. dolor malesuada sed hendrerit, scelerisque. at ac bibendum. molestie Aenean in, ac Sed libero. tristique netus pellentesque morbi Ut egestas. eu nibh. risus",
      "lectus porttitor netus ac Pellentesque bibendum. ac molestie Nam tempor vel molestie nibh scelerisque. in, ac purus cursus sit ac est. senectus orci volutpat libero. Aenean morbi elit. risus non massa nibh. imperdiet lorem egestas. consectetur habitant Quisque sollicitudin Mauris ultricies non hendrerit, Sed dolor ipsum Suspendisse sagittis vestibulum. et eros. leo vel et tempor finibus, malesuada Ut tristique dolor Ut eu interdum. suscipit at a amet, interdum. nisl tristique sed Nam mauris fames sem Duis eu adipiscing aliquet. pellentesque Lorem",
      "Nam Ut aliquet. orci est. Duis suscipit purus interdum. porttitor tempor ac massa et tempor molestie in, Suspendisse netus leo vestibulum. vel ipsum dolor sem Nam ac adipiscing cursus Ut volutpat",
      "purus consectetur nibh. Mauris vel sit non lorem non volutpat eu scelerisque. orci Pellentesque fames hendrerit, eu leo morbi ac suscipit cursus",
      "lectus tempor Nam Suspendisse tempor morbi ultricies tristique sed porttitor egestas. libero. amet, sagittis est. tristique dolor at mauris risus senectus in, adipiscing lorem finibus, molestie malesuada risus Mauris leo dolor ac purus hendrerit, eu Sed fames imperdiet turpis ipsum eros. a vel Ut",
      "pellentesque porttitor et Ut Quisque Pellentesque bibendum. consectetur non purus eu egestas. ac elit. Aenean tristique scelerisque. tempor fames Mauris sem in, habitant orci risus vel ac nibh netus nisl turpis senectus volutpat vestibulum. lorem risus suscipit adipiscing tempor est. molestie nibh. tristique ultricies et Nam Ut Nam lectus ipsum morbi cursus sagittis sollicitudin dolor hendrerit, non interdum. sit vel",
      "tristique dolor Lorem sed tempor bibendum. ac non sagittis est. dolor sem ac orci vestibulum. adipiscing ac netus risus massa amet, Duis Ut tempor Aenean Mauris eros. vel pellentesque at eu senectus Pellentesque risus consectetur lorem suscipit ac malesuada eu nibh vel et finibus, Ut leo morbi",
      "mauris interdum. et nisl tempor lectus tempor ipsum Suspendisse pellentesque eu Duis morbi porttitor sem Quisque imperdiet risus aliquet. Mauris a nibh ac non in, molestie leo Nam netus massa Nam tristique egestas. vel et sit adipiscing lorem eros. sed eu at purus Ut tristique libero. est. ultricies sollicitudin interdum. habitant non Ut hendrerit, Pellentesque dolor scelerisque. consectetur vestibulum. Aenean dolor Lorem senectus ac ac nibh. bibendum. Sed risus molestie volutpat suscipit finibus, amet, cursus ac vel orci fames turpis elit."
    ]
  },
  "base_path": "/b74cd178-995f-49c5-8a8f-60cdffaa70e1/e1173a1b-3fe8-43b6-baad-bb94512cc683",
  "change_note": null,
  "description": null,
  "document_type": "redirect",
  "last_edited_at": "2018-09-14T17:44:43+00:00",
  "locale": "zh-hk",
  "phase": "beta",
  "publishing_app": "content-publisher",
  "redirects": [
    {
      "destination": "https://bkwhop.bkru.vtb.gov.uk/a50e7a28-1c2b-4c67-ba33-365a6def9e18/2e54934e-5e94-48ed-8e90-427aa2f959f4/8bd2c1b3-8039-4a31-858d-7fd3103fb4ec/6bf406a2-4641-403b-8514-b8569dc8b765",
      "path": "/3683c53a-d98b-411a-8e98-66cb552cf775",
      "segments_mode": "preserve",
      "type": "prefix"
    },
    {
      "destination": "/7649c00f-79aa-4d0d-9c97-ca7ffe5682f0/77b7388e-c475-4828-9304-e6853c3bd103/d43a8cd8-9702-4c38-b736-e643d951bdd4/e6b9710a-2b84-4069-bc3a-a73f271be30e/78421ccf-2c35-4377-9b6e-cd9666896ee5",
      "path": "/492e0b9a-1843-4e68-a8f8-2aa9f1d7e55d/cac680d9-74c1-42eb-9162-b8aa464d8112",
      "segments_mode": "ignore",
      "type": "prefix"
    },
    {
      "destination": "/6de4f8d7-0bb2-4c9e-a459-e64bfd857c7f",
      "path": "/aee3ff4c-ceae-42f8-a0c1-1b3f01ed2101/ad0f4629-d937-47ee-9080-6f974579d49d/1c3163e6-62da-456e-84f8-66becf3d96b1",
      "segments_mode": "ignore",
      "type": "prefix"
    },
    {
      "destination": "https://msldz.dqx.gov.uk/0afaaae7-e105-4914-8b05-c08234c377c2/1c336f2c-ac8b-419d-b364-95ecddfd01c2/d87ed395-0295-4086-a3a7-394e278340e1",
      "path": "/54d4fb8d-40de-4d78-839d-33c5fb7ee597/3bd2be3b-3814-4d40-8a80-7b1925250787/a5032539-d4d2-47d4-a962-1dda0c4c073b/ef95e83f-b2e6-45d7-ba55-5403bfffcf8d",
      "segments_mode": "ignore",
      "type": "prefix"
    },
    {
      "destination": "/7ed2673b-c39d-4081-9e24-488e84c17262",
      "path": "/3525f37e-0148-46c3-bb1a-48760687c8e0/cbbfe5cd-4b6b-45a7-8c16-b44f8941ed9e/2c4efbed-77e5-445f-931a-4031b7525e3a",
      "type": "prefix"
    },
    {
      "destination": "/b3e05013-8d86-4678-b712-b6fbd92fc3a1/e185e346-2e75-47a9-b27b-a4551dc1befa",
      "path": "/4221a407-8290-4aac-a65c-d1af6dc5b95c",
      "segments_mode": "ignore",
      "type": "prefix"
    }
  ],
  "rendering_app": null,
  "routes": [
    "purus lectus ipsum leo volutpat hendrerit, ac Pellentesque tempor eu Ut sed amet, et Lorem ac a ac Nam Duis suscipit fames nisl nibh. cursus vel sem Suspendisse tristique massa morbi risus est. turpis Quisque non non finibus, at tristique eros. nibh adipiscing egestas. elit. lorem mauris Nam consectetur eu orci sollicitudin Aenean ultricies libero. vestibulum. malesuada porttitor Sed et netus ac interdum. sit pellentesque senectus scelerisque. molestie tempor bibendum. Ut Mauris risus aliquet. in,",
    "tempor libero. vestibulum. nibh. dolor sollicitudin risus morbi risus lectus dolor vel consectetur sed ultricies orci suscipit amet, tristique eu porttitor eu molestie non nibh ac Aenean ac hendrerit, Ut Duis turpis interdum. interdum. cursus mauris et tempor habitant at eros. finibus, ac Pellentesque Sed malesuada fames sit imperdiet volutpat egestas. Ut netus Nam purus sem lorem Mauris leo bibendum. adipiscing elit. tristique senectus pellentesque massa sagittis Lorem non Suspendisse a vel Nam scelerisque. aliquet. ac et molestie nisl est. in, ipsum Quisque",
    "risus consectetur purus Lorem ac et netus sit in, est. nibh. mauris orci Quisque Aenean a risus interdum. sagittis malesuada libero. lorem dolor porttitor dolor Sed egestas.",
    "sem dolor imperdiet tristique Aenean nibh molestie Ut Suspendisse Pellentesque risus leo risus pellentesque vel non in, tempor lorem et adipiscing amet, volutpat interdum. Quisque ipsum a eu massa orci sit purus scelerisque. morbi tristique at nisl ultricies Mauris eros. malesuada libero. eu elit. hendrerit, est. turpis tempor porttitor egestas. netus dolor Nam non ac Duis et aliquet. ac suscipit molestie mauris Lorem cursus lectus sed Nam ac vel sagittis sollicitudin Sed fames finibus, Ut senectus vestibulum. interdum. ac consectetur bibendum. habitant",
    "Duis est. at volutpat scelerisque. vel tristique adipiscing tempor Ut pellentesque orci non Nam nibh. risus leo Nam ac dolor habitant amet, ultricies et non bibendum. ac eu Sed interdum. sed libero. Aenean et senectus Lorem mauris consectetur Quisque",
    "nibh Lorem in, sollicitudin imperdiet a interdum. tempor volutpat Duis mauris massa Suspendisse et purus nisl libero. Quisque ipsum Nam amet, netus non hendrerit, risus vel ac sem lorem ac fames vel ac dolor",
    "porttitor Ut ac in, Lorem dolor ultricies tempor Pellentesque vel Ut interdum. imperdiet consectetur dolor senectus ipsum morbi non a pellentesque nibh elit. tristique turpis Sed lorem eu lectus Mauris sem hendrerit, sit Aenean sed habitant orci eu vestibulum."
  ],
  "schema_name": "redirect"
}

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

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