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
string

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
policies
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-tagger, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
rendering_app
null

schema_name
string

Allowed values: redirect
title
null

updated_at
string

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

withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": null,
  "base_path": "/4194a69c-dc2a-48f2-890a-98e8cc12f3fd/8923b46b-a849-479a-91c2-5d773b767c03/b2b9dab2-d804-4db4-b836-3e08f7f1820b/7858d61b-0488-4c54-baa5-aaa6a2e8fc34",
  "content_id": "c8f539f3-250f-4789-8b8b-6c8dd27f2c8e",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "email_document_supertype": "molestie suscipit Mauris sed netus mauris aliquet. risus vestibulum. ipsum Quisque sit sem non fames Ut Lorem porttitor Ut leo at turpis ac libero. finibus, ac vel ac Duis Nam interdum. adipiscing Aenean lorem pellentesque sagittis massa cursus interdum. ultricies tristique orci eu in, ac risus scelerisque. elit. hendrerit, est. senectus amet, nibh. vel dolor et Suspendisse molestie Sed tempor consectetur lectus egestas. a morbi purus habitant nisl nibh dolor sollicitudin malesuada non bibendum. Pellentesque",
  "links": {
    "children": [
      {
        "base_path": "/427f3001-b609-4d02-808e-d2a14c7d81f9/a44a1d8a-c805-4d0e-aa59-9178365f03db/ae8c3771-36f8-4928-b9e4-8cd6d98163c1",
        "content_id": "ac1aaffa-d600-45c4-9f82-6cee8938a821",
        "document_type": "libero. eu hendrerit, vel Aenean sem sed at volutpat non Mauris finibus, eu interdum. Ut et",
        "locale": "fa",
        "public_updated_at": null,
        "title": "cursus porttitor interdum. senectus eu tempor a volutpat vel tristique ipsum non tempor nibh. sollicitudin Nam libero. sem bibendum. dolor molestie habitant in, netus massa nisl pellentesque ac amet, Ut est. consectetur lorem imperdiet ac et hendrerit, Pellentesque suscipit Sed interdum. purus ultricies Duis Mauris tristique molestie scelerisque. Ut risus sagittis lectus leo malesuada eros. at orci non vel vestibulum. finibus, fames egestas. sit eu mauris Nam risus dolor et Quisque adipiscing aliquet. Lorem nibh Suspendisse morbi sed ac ac elit. Aenean turpis",
        "web_url": "http://example.com/0dd2bd06-1712-4d46-9342-414d4e0975eb/a262ac3d-4182-4b65-86e8-82944f0a8da2/9d0e09b0-1a41-4d85-9f4c-14e549c7e36e#60a99aa27fe799d9e3c70b7c017135f7"
      },
      {
        "api_path": "/9acb4154-8c9e-4132-b8a9-dbfb265a4103",
        "api_url": "http://example.com/3697ff1c-1787-4366-a5d9-536b47034bc3/7c8281d8-78b7-46cc-bf4e-6651eafda76a/a40ab5d1-1791-4b9a-82b7-718612b9e11f#967ff957d22da8a3814dc5e564e63a7b",
        "base_path": "/3467f98b-96b0-473a-bfa4-e6dd335f165c/416ac17d-5a54-4425-a049-c206f0e05a8b/2637904b-f538-400e-aaab-41c31820372e/1bf26b51-2f30-403f-ba9f-7ac55402d5dc/5bc2b8b0-0d03-4017-94e9-6c6848ba19f0",
        "content_id": "76ee60f1-693f-4745-ab57-ff8ec0784685",
        "links": {
        },
        "locale": "tr",
        "public_updated_at": null,
        "schema_name": "non ipsum lectus eu tristique cursus Nam molestie eros. interdum. risus est. interdum. Duis pellentesque malesuada sed non Pellentesque tempor et Nam Ut Suspendisse",
        "title": "adipiscing cursus Pellentesque nibh bibendum. orci porttitor senectus lorem molestie"
      },
      {
        "analytics_identifier": null,
        "base_path": "/9662da71-24ea-459d-95db-52e6493037ce/549af64e-a567-48f3-ab5a-63708b59d8de/54b595cf-23ba-499d-895b-718baf3dd2c0/1d18c46e-3b59-4242-931a-63c1df066e16",
        "content_id": "23ff031f-80b8-4ec1-a4a8-9700e19ccd00",
        "document_type": "et eu Ut turpis vestibulum. eros. dolor egestas. ac senectus cursus nibh risus morbi consectetur bibendum. est. fames tempor nibh. Duis habitant at lorem sem purus nisl aliquet. ac non amet, tristique scelerisque. ultricies ac molestie risus tempor interdum. sagittis in, malesuada libero. interdum. Sed suscipit Nam tristique hendrerit, Pellentesque netus Quisque et Mauris vel adipiscing mauris Nam finibus, ipsum eu leo massa Aenean",
        "locale": "ru",
        "public_updated_at": null,
        "title": "Ut leo volutpat dolor consectetur risus ac mauris tempor sit et fames ac in, Sed et Suspendisse nibh Lorem nibh. non Ut interdum. amet, lectus vel habitant scelerisque. ac finibus, malesuada libero. orci sollicitudin massa ipsum ac purus cursus lorem aliquet. nisl molestie Duis at suscipit morbi interdum. adipiscing senectus Nam tristique sagittis netus sem"
      },
      {
        "analytics_identifier": null,
        "api_path": "/31ba2ab6-12a2-4b00-83ba-c9404d220da5/e9ed56e4-8432-4c92-9a45-721b60270805/a0551b6c-d449-4f25-b46b-8473373874ff",
        "api_url": "http://example.com/76601a38-19b2-41f9-a5cb-254aa356eb31#f27acd2c539f6ce5bf4b2e5fb63af072",
        "base_path": "/4af38236-7b85-4007-bd93-1f8852bf1840/8f217b0b-d00f-4199-96d7-a0cf18c3f310/a2064e57-cf68-4893-b755-0e4d3024b9fd/03af015f-f8ec-421b-b4ee-8ad8a1bf9972",
        "content_id": "bc55ca89-c1eb-4494-96e8-0e678f0f379d",
        "links": {
        },
        "locale": "uk",
        "schema_name": "Duis sollicitudin et mauris libero. sed malesuada Quisque suscipit interdum. lectus orci Mauris risus at eu Nam sit eu amet, bibendum.",
        "title": "non bibendum. Quisque purus adipiscing nibh habitant ac scelerisque. libero. dolor tristique est. turpis lectus Mauris imperdiet molestie Ut tempor cursus Aenean Nam malesuada Lorem Duis vel tristique interdum. nibh. et ipsum risus vestibulum. consectetur porttitor lorem in, aliquet. sit Sed volutpat fames pellentesque tempor molestie sed non et egestas. Ut ac eu orci ac Nam eros. sollicitudin Pellentesque sagittis vel morbi elit. nisl ac amet,"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/bbca01d0-e3ea-459f-820f-52baec659757/33e5b7df-fa26-4c0c-bfd4-28dda2c69127#4a9f5a503e9a3595fbc288eef05d2c7d",
        "base_path": "/b66f1230-2139-4dd4-8010-7cf9b8bcf87e/ebedba02-880b-4a76-b6d0-e7808a2578dd/cd3c6659-b1b7-4c19-a50c-95177d2fbb0f",
        "content_id": "183bdd72-356a-41fd-81a0-5f12cea3bac1",
        "document_type": "purus molestie elit. est. adipiscing nisl nibh eu volutpat et Ut bibendum. netus at vel non tristique mauris cursus dolor ultricies eros. scelerisque. ac Nam non Quisque ac Aenean sem risus egestas. tempor amet, interdum. lorem senectus ac aliquet. orci tempor ac finibus, a imperdiet massa Duis vel vestibulum. risus pellentesque Nam Suspendisse Lorem et hendrerit, sit eu libero.",
        "links": {
        },
        "locale": "hy",
        "title": "ac elit. consectetur imperdiet sollicitudin sagittis tristique malesuada at volutpat Sed finibus, a Lorem Aenean ipsum bibendum. dolor suscipit nisl Duis ac"
      },
      {
        "base_path": "/78c205e1-748c-4c77-b66c-09f6e74568dd/b7d338c0-5bff-4682-b1a2-de22c6eaf1bd/794905a4-c7dc-415a-891a-42c7c4c6c8b5/a656f314-e498-4527-aed9-8e06e693eace",
        "content_id": "ab775120-650a-4596-922c-6229dc73e848",
        "document_type": "massa non Mauris mauris consectetur turpis porttitor leo vel sem Lorem Nam pellentesque purus vestibulum. non malesuada aliquet. habitant molestie sagittis eu Pellentesque tristique imperdiet Duis Quisque nibh scelerisque. a interdum. Ut",
        "links": {
        },
        "locale": "pl",
        "public_updated_at": "2017-12-02T13:19:39+00:00",
        "title": "risus hendrerit, vestibulum. leo Mauris molestie porttitor nisl non tempor orci netus Quisque massa adipiscing egestas. ac finibus, interdum. Ut tristique Duis malesuada senectus risus amet, eu ac fames aliquet. Nam libero. et sed et eros. Nam Ut pellentesque imperdiet sagittis vel non ac nibh turpis molestie dolor bibendum. cursus ultricies lectus Lorem purus vel morbi sit Pellentesque ac lorem est. tempor nibh. eu interdum. volutpat elit. Sed dolor consectetur in, at sem scelerisque. Suspendisse habitant sollicitudin suscipit ipsum tristique Aenean a mauris",
        "web_url": "http://example.com/ad9dfadb-e2c9-463c-a1ad-3b9c3294acc7/0024e7c5-75b3-45b5-9cc6-3cbb2cec25ea/692e153a-a5b6-427f-a6b3-a33766b05199/15cf83b3-0da9-4d68-a57a-f7819e09b0f8#220afaa37abd37c0350b574a7d4741a6"
      },
      {
        "analytics_identifier": "ac Quisque eu bibendum. non sem malesuada netus pellentesque morbi risus tempor cursus in, Nam molestie finibus, elit. tristique vel Mauris hendrerit, ac interdum. eros. scelerisque. dolor aliquet. Suspendisse molestie tristique Ut vel ac senectus massa et leo libero. porttitor et Duis risus lectus sollicitudin interdum. egestas. volutpat lorem Pellentesque fames mauris est. adipiscing nisl Ut at sagittis purus consectetur nibh. nibh Nam sit ac imperdiet Lorem",
        "api_path": "/bc094c6c-96d8-43e4-90b7-d300e178cacc/d81fa110-abac-4f4a-8b51-c0a09f34ceff/8c10b6ba-2312-459a-8eae-aeeb08863de6",
        "base_path": "/b44c3660-ea38-4bb1-a5a0-e9705ce82c17/c3757f68-fe52-4149-937b-b6924634a485/a4338b5c-83a5-4aeb-9562-b727136387fa/7a107c6e-8ee6-4631-ac4f-97583412f893",
        "content_id": "569ac090-f536-4fa0-8d5e-24dd88f755f5",
        "links": {
        },
        "locale": "he",
        "public_updated_at": "2017-10-02T08:50:01+00:00",
        "schema_name": "molestie vel lorem senectus in, Sed imperdiet purus ac morbi tristique habitant ultricies non tempor scelerisque. sed amet, ac Ut Mauris hendrerit, nibh. at aliquet. interdum. mauris Quisque Nam risus Suspendisse nisl sagittis Aenean a interdum. molestie bibendum. eros. pellentesque lectus malesuada non finibus, suscipit eu eu sem ipsum dolor libero. et et sollicitudin massa fames Nam netus ac vel cursus elit. porttitor ac adipiscing orci est. Pellentesque risus tempor vestibulum. turpis egestas. sit Ut Lorem tristique",
        "title": "lectus",
        "web_url": "http://example.com/9b16b81c-bd80-49d9-9b72-5f8a484f240b/29c295cb-a6a9-477f-bf78-d87d9cd7efb4#264e814ac895c789edf55948d1728696"
      }
    ],
    "document_collections": [
      {
        "api_path": "/ee192092-e25c-42c9-970d-88bf7bb7299e/3fb81755-805b-49b8-8536-7e062cb7a536",
        "base_path": "/357aa5e2-3b5c-4de2-b351-e43255dfaee9/ed1cb3a7-5042-41f5-b885-af7078344ac4/14d92807-12ee-4028-93de-83cbaa272ce0/c2adc3f6-8e64-48fe-930f-f7de61f84f0b",
        "content_id": "64c038cf-1ad0-44cd-aab1-3cf8b68c59de",
        "document_type": "ac interdum. amet, morbi hendrerit, Duis suscipit netus sit malesuada mauris lectus Quisque Nam et sagittis ac cursus sem egestas. nibh sed porttitor nibh. a eros. fames lorem pellentesque purus turpis",
        "locale": "cs",
        "schema_name": "interdum. Quisque Mauris volutpat Duis ac consectetur vel a et risus lorem imperdiet Nam amet, adipiscing eros. Suspendisse lectus nibh. hendrerit, malesuada leo molestie sit ultricies Sed netus vel mauris orci interdum. sagittis bibendum. in, aliquet. morbi non massa Aenean est. dolor Ut sem ac elit. dolor senectus",
        "title": "vestibulum. risus molestie adipiscing molestie at sollicitudin Nam et tristique Aenean a suscipit sit cursus Sed et scelerisque. massa ac bibendum. turpis lectus ac dolor Ut fames eu netus tempor elit. habitant Ut pellentesque volutpat Mauris risus Nam vel hendrerit, eu Pellentesque in, dolor tempor nisl eros. lorem egestas. vel leo mauris interdum. morbi imperdiet ac non non ac interdum. Lorem tristique Duis malesuada nibh consectetur sem ipsum nibh. senectus orci est. aliquet. porttitor Suspendisse ultricies Quisque purus amet,"
      },
      {
        "api_path": "/b7e51e9a-69d4-4398-a322-c99fa087283c",
        "api_url": "http://example.com/488f1195-24b8-4712-b4a7-e2f3edfec055/d339612e-77f9-40a6-a7fc-d686601b3698/e754f9bb-457d-4225-87c8-ffe8fe38df21/e228bd57-e665-46b3-8ce9-9738ff47f666#f7069c74a991b93aeedaffcbb325678f",
        "base_path": "/b8121886-317c-4eb0-a700-7c32f65b7abd/78208a5a-7765-4797-af4f-aae2f0ab8cf3/fdc595b8-b9d9-4612-8c11-6ad6c2d13cd8",
        "content_id": "41abfde8-2ab9-4bd9-8cef-50cfc93965da",
        "links": {
        },
        "locale": "de",
        "public_updated_at": "2017-09-10T17:18:43+00:00",
        "schema_name": "lorem finibus,",
        "title": "habitant elit. dolor interdum. pellentesque tristique turpis lectus volutpat et morbi ipsum Mauris sem vestibulum. Ut ac sollicitudin finibus, et fames cursus mauris sit interdum. amet, risus molestie tristique orci molestie dolor consectetur malesuada Duis vel non leo Pellentesque risus vel tempor ultricies porttitor bibendum. Suspendisse non est. sagittis aliquet. a Sed nibh imperdiet eu Aenean tempor massa eu ac egestas. purus suscipit Nam hendrerit, adipiscing Quisque ac Ut in, eros. senectus netus sed scelerisque. Lorem nisl lorem ac libero. at Nam",
        "web_url": "http://example.com/0fe6439b-b08e-485d-8e8e-aed0b47803be/dd2bdd3f-671c-4420-b523-6d579bdb7354/d2426e3d-f570-4a2b-8de8-d45e49b1aec5/c2c8a26a-92a5-4abc-aaab-c671890500b5/56a1f3ca-73b1-48c9-af80-9c017a667e56#bcca832dbad454bbfe07b2da93b8ae48"
      },
      {
        "api_path": "/2908966a-85ba-4d25-bc5b-1f37dfc486bd/f9ca12c6-2be6-44dc-b113-83c875bb17f8/d0fa10bd-dc05-4838-9f3e-38dbe1be2c32/34e620a0-d4cf-455a-b209-8e4b83a015f2/87c57e6b-1351-4460-8db5-d8813bb9ffd3",
        "base_path": "/04d49a91-705b-4512-948e-12fcd14724e6/61c80c67-914f-4fc4-8aa1-72a8b7924eb1/dfdb4a34-54b9-4886-b845-5416ebef383c/2b9cf384-a256-46e4-b655-8714d0ea4130/bd629da5-4273-48fb-9b44-047dea5f475d",
        "content_id": "ea690e6e-0ceb-48cd-9e31-a0855679696b",
        "links": {
        },
        "locale": "pt",
        "title": "nisl"
      },
      {
        "analytics_identifier": null,
        "api_path": "/20504109-12c5-4879-a29c-d91fa73530a7/212d0d67-76f3-4444-97f4-061c7aee14bb/2d568de2-7b4a-474a-8ba0-dfea98c47a55/1a29f2e4-e08c-4047-9b98-cc5923ac1ef5",
        "base_path": "/1f53e067-1f5f-40dc-a48d-f0f599a6bba4/311f470d-2df2-4d72-961d-a284db93e51c/ad670b1d-1433-4ae8-959d-e1b58e818683/b0bfd23b-5c1b-46e5-926c-401d27b20b90/a37da136-10c4-46c7-a0fe-3e196ef0d1a3",
        "content_id": "81e9832b-e0e6-4f6d-8496-864c0cc987c0",
        "document_type": "nibh. sed cursus malesuada Nam finibus, bibendum. orci mauris tristique",
        "links": {
        },
        "locale": "lv",
        "title": "sollicitudin leo morbi Nam nibh. sed Nam Ut fames elit. lorem ac aliquet. dolor in, vestibulum. a sit risus interdum. tempor scelerisque. non pellentesque nibh malesuada et tristique Lorem egestas. risus ac Sed consectetur orci tristique eros. Quisque Suspendisse Pellentesque Aenean tempor bibendum. massa non amet, vel libero. sem finibus, molestie"
      },
      {
        "api_path": "/928624c5-b546-4d61-a03f-7e9b0d6d41cf/d3f77d4e-359d-4db9-b3a6-8282d1c80781/07d20645-0b6e-40ce-b9a3-9f9e5975c19a/e961d2f6-4b8b-412d-a91c-27d7254bcd9e",
        "api_url": "http://example.com/9f30b40e-c6c8-45ef-b45a-0aeb3943de5f#6ca746b5512b9063d7292297fcb9a1c1",
        "base_path": "/1b66c21f-be19-456d-a91d-7768ab74389f",
        "content_id": "0857bcd8-1ad5-46ff-a10d-1db441ab35d5",
        "document_type": "ac dolor libero. massa at Ut suscipit non tristique nibh. Sed tristique Lorem malesuada morbi vel a et bibendum. Ut Nam lectus Quisque tempor sem in, fames ac nisl non sagittis purus elit. egestas. ultricies interdum. cursus lorem sollicitudin mauris Suspendisse Aenean sit est. molestie finibus, eros.",
        "locale": "hi",
        "schema_name": "et volutpat Ut Quisque Mauris risus non risus nibh. lorem vel imperdiet Ut dolor Sed pellentesque eros. tempor purus ultricies bibendum. eu Duis elit. at malesuada netus tristique sagittis egestas. a Aenean ac adipiscing massa habitant porttitor Pellentesque Nam suscipit Lorem senectus ac eu dolor libero. fames ac vel sem cursus in, amet, ac et orci mauris scelerisque. sit interdum. vestibulum. morbi ipsum",
        "title": "nibh. tristique turpis amet, non molestie leo non risus lorem cursus porttitor malesuada netus tristique ac et ac nibh sed ipsum imperdiet eros. at aliquet. habitant mauris bibendum. fames sollicitudin Nam Sed sagittis senectus vel vestibulum. purus lectus interdum. finibus, elit. adipiscing orci ac Aenean Ut et interdum. scelerisque. tempor libero. Pellentesque dolor egestas.",
        "web_url": "http://example.com/5ec3b4d4-a271-4f55-a83d-636a876e5a5c#76a903718fff0716225ea3bb53321772"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/11b6af6f-5153-4ac8-850e-30f0980d81f8/d050ae56-ded9-47a8-b443-7762114886e5/de5e9805-f6b3-417f-81a0-edd55987de65/35af7852-e4d9-48a7-8478-088abaa74e84#6eddad242f1035802d4d7e386e1f7c2b",
        "base_path": "/687b51a8-c393-4a9c-a6a1-88905229d8a7",
        "content_id": "d85aa0db-242d-402e-8caf-6d4818b9669d",
        "links": {
        },
        "locale": "az",
        "public_updated_at": null,
        "schema_name": "aliquet. elit. cursus bibendum. molestie scelerisque. est. netus ipsum senectus Mauris porttitor ac purus tempor lorem consectetur",
        "title": "senectus a Mauris eu tristique sollicitudin ultricies Ut libero. Duis nisl interdum. eros. ipsum aliquet. vel turpis eu Quisque non molestie sagittis Sed sed hendrerit, vel porttitor est. mauris",
        "web_url": "http://example.com/0de82105-2197-400e-85a2-b71fd0d47f64/7452d053-0544-4633-9812-0cbad2467d8d/3ab72a9a-dbd1-4a67-8c3d-1cd2cd2df921/25ebb34a-d3ec-4858-bf7e-df807aee74bd/4d1641a4-5c6b-4c82-8ba1-2b632b4581d3#b6184fe50c2a9766f7bb4b77916b2975"
      },
      {
        "api_url": "http://example.com/40f5d174-0370-4646-bf46-3c9c51cfd033/844e8249-a041-4355-9e01-fe90757d9f07#50a54d0f9e699ca9445d6f1d827ccb73",
        "base_path": "/7b661706-4bd1-4d15-8331-a2989047afce/5a3ed410-fa4a-4a83-951b-c3693f923b7f/7f90b0b9-3a03-422d-8085-a17ebed29a76",
        "content_id": "141c6b8d-fa6e-4bfa-88d7-e68bcc89c80c",
        "document_type": "a eu consectetur at tempor leo hendrerit, interdum. amet, in, scelerisque. Ut massa pellentesque sem Quisque Mauris Suspendisse netus Pellentesque volutpat tristique et nibh. est. cursus interdum. risus vel porttitor non fames vestibulum. sagittis non Sed senectus sit ac ultricies orci finibus, risus Nam dolor aliquet. et egestas. bibendum. elit. habitant nibh lectus vel malesuada Duis ac lorem Aenean ac tempor adipiscing nisl ac molestie sollicitudin eros. eu dolor tristique imperdiet mauris Nam ipsum molestie Lorem suscipit turpis libero. Ut sed purus morbi",
        "locale": "hu",
        "schema_name": "elit. adipiscing leo nibh. sagittis massa interdum. ac vel sollicitudin Quisque tristique Suspendisse Mauris et turpis porttitor vestibulum. Ut risus habitant tempor sit in, hendrerit, lectus Ut purus ac at ultricies dolor sem suscipit Duis egestas. ac non morbi ac ipsum eros. Lorem nibh interdum. finibus, sed malesuada dolor imperdiet aliquet. senectus mauris libero. orci amet, non molestie tristique Sed pellentesque risus Nam eu a Pellentesque est. volutpat Nam eu tempor et lorem",
        "title": "suscipit senectus eu Lorem finibus, mauris molestie scelerisque. turpis tristique at vel Duis Mauris tempor orci morbi egestas. dolor sagittis in, cursus porttitor risus ultricies est. a ipsum nisl ac sollicitudin aliquet. imperdiet hendrerit, dolor libero. Pellentesque ac lectus tempor sed tristique ac Aenean Nam massa sit Ut leo nibh ac eros. et vestibulum. vel non lorem interdum. amet, Suspendisse volutpat malesuada molestie non Nam bibendum. sem purus interdum. adipiscing fames eu Ut elit. risus netus Quisque et Sed nibh. habitant consectetur pellentesque",
        "web_url": "http://example.com/f4563e61-c80b-4da4-b61f-6b40802d425e#4fb27f2f5da90c481102773b929e0f48"
      },
      {
        "api_path": "/56751769-a79e-4313-8d4f-48156e26d110",
        "base_path": "/8212aac4-d24c-4c6f-b387-a7cab02bfc6f",
        "content_id": "81243f37-f1a0-40d6-801a-e8da3c47782b",
        "locale": "en",
        "schema_name": "Lorem libero. tempor tempor est. hendrerit, nisl porttitor bibendum. molestie dolor a risus molestie in, fames ipsum sagittis eu interdum. Suspendisse habitant consectetur volutpat sollicitudin purus nibh. adipiscing malesuada et amet, pellentesque Mauris orci massa suscipit non vel et Pellentesque Quisque vel tristique sit netus turpis mauris lectus leo Duis ac Aenean elit. vestibulum. ultricies ac ac eu risus egestas. at tristique interdum. cursus finibus, Ut eros. nibh sem sed lorem aliquet. dolor non Ut Sed ac Nam morbi imperdiet scelerisque. Nam senectus",
        "title": "sollicitudin orci vel at netus ac Aenean tristique Duis lectus Pellentesque risus pellentesque Nam lorem Nam Sed egestas. et eu porttitor dolor massa risus tempor volutpat malesuada ac Lorem consectetur tempor tristique est. suscipit imperdiet Ut non morbi eros. eu bibendum. finibus, hendrerit, adipiscing purus senectus nibh. ac libero. leo elit. mauris habitant vel Quisque ultricies molestie Mauris Ut ipsum interdum. cursus dolor ac amet, a nisl non sagittis interdum. fames sit sem turpis Suspendisse sed aliquet. scelerisque. et nibh molestie vestibulum. in,"
      },
      {
        "analytics_identifier": null,
        "base_path": "/4866dacf-c0f1-42dd-89a6-4ff6f46776b3/271abf52-130a-4ae2-a4ab-81c6dd14548a/11e68e78-3dd3-449a-84ef-8b38745eadbd/2e14d034-7a08-4920-ae2e-0a31049f583e/02a5c69c-16a3-4c1e-9307-05f92d988170",
        "content_id": "857dbae1-918a-4c0d-a757-324b9b12bdb2",
        "locale": "ja",
        "schema_name": "amet, porttitor Sed tempor morbi lorem risus senectus ac egestas.",
        "title": "lorem amet, ac"
      },
      {
        "base_path": "/e8d97b9e-7291-4d0f-ac93-122bff82afc6/4505ef39-9c7f-4ff6-84eb-5e506fdc2d0b/7a80885e-76bd-44ff-931d-72f12808a57a/641ea5fa-a8fb-4490-97aa-03fc8aa008a2",
        "content_id": "ad2c445b-f91d-4c61-8ea4-4fb34f2e273b",
        "document_type": "est. interdum. lectus risus volutpat non sem sagittis suscipit scelerisque. Nam Pellentesque egestas. aliquet. Nam Mauris turpis Quisque mauris senectus tristique molestie tempor imperdiet purus elit. Ut molestie dolor",
        "locale": "ta",
        "public_updated_at": "2017-11-21T09:43:56+00:00",
        "title": "vel suscipit tempor ac Quisque Suspendisse Duis eu egestas. malesuada dolor"
      }
    ]
  },
  "locale": "ro",
  "phase": "live",
  "public_updated_at": null,
  "publishing_request_id": "Mauris at",
  "rendering_app": null,
  "schema_name": "redirect",
  "title": null,
  "updated_at": "2017-12-14T08:23:20+00:00",
  "user_journey_document_supertype": "nibh. in, lectus Lorem vel porttitor Ut interdum. libero. et tempor ipsum",
  "withdrawn_notice": {
    "explanation": "sit egestas. cursus massa ac suscipit nibh. Mauris mauris elit. molestie et vestibulum. tristique hendrerit, interdum. scelerisque. sem a",
    "withdrawn_at": "2017-10-10T15:15:13+00:00"
  }
}

Publisher content schema

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

Attributes

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

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
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-tagger, design-principles, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, spotlight, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
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": null,
  "base_path": "/b2bf6d5f-7c96-4161-877a-c2d21900f7af",
  "description": null,
  "document_type": "redirect",
  "first_published_at": "2017-11-25T13:23:21+00:00",
  "need_ids": [
    "Aenean massa nibh. Lorem et lectus Sed malesuada Ut ultricies dolor non vestibulum. risus Ut a sagittis ac suscipit imperdiet finibus, lorem nisl interdum. senectus habitant cursus eu orci netus morbi vel turpis tempor Duis est. Pellentesque Mauris at scelerisque. aliquet. sem non sit adipiscing eu eros. Nam et nibh fames sollicitudin ipsum dolor interdum. libero. tempor amet, purus hendrerit, molestie ac ac sed porttitor risus vel Nam bibendum. consectetur Quisque",
    "tristique pellentesque sollicitudin purus ultricies ac dolor",
    "Quisque orci Duis adipiscing imperdiet tristique morbi et amet, finibus, molestie Ut sagittis lorem Sed Nam pellentesque aliquet. Suspendisse porttitor suscipit tempor vel eros. a Aenean risus nibh. leo interdum. non vel fames est. libero.",
    "Suspendisse et tempor non fames Mauris ac Lorem Quisque et",
    "non consectetur lectus tempor porttitor tristique vel at a libero. risus massa Mauris eros. Pellentesque tristique ipsum sollicitudin cursus netus dolor Quisque Nam non ac interdum. nisl sem interdum. scelerisque. Ut nibh. turpis eu sagittis hendrerit, vestibulum. sit Nam bibendum. Suspendisse lorem habitant adipiscing molestie vel ultricies purus ac orci et imperdiet Aenean aliquet. morbi sed leo Lorem pellentesque Duis fames et",
    "cursus eros. interdum. senectus at tempor Ut amet, risus consectetur in, fames tempor molestie ac vel finibus, tristique Sed libero. sollicitudin vestibulum. vel Suspendisse Duis nibh. turpis Nam ultricies leo non habitant ac nisl sed scelerisque. et morbi volutpat orci",
    "dolor eu volutpat netus amet, vel Pellentesque molestie Aenean in, Duis tristique morbi turpis nibh est. elit. sed hendrerit, dolor scelerisque. nibh. sagittis tristique fames sollicitudin porttitor cursus Ut lectus Ut egestas. ac tempor vestibulum.",
    "pellentesque interdum. lectus orci a Nam morbi ac ac risus et tristique vestibulum. ac in, tempor sit aliquet. eu vel cursus Mauris finibus, netus Aenean Lorem ipsum sagittis amet, Pellentesque Nam egestas. scelerisque. elit. eros. habitant risus nibh Duis Quisque est. hendrerit, porttitor bibendum. non tempor libero. molestie massa sollicitudin adipiscing sed Ut Sed senectus suscipit eu dolor leo lorem vel sem imperdiet et Ut"
  ],
  "phase": "alpha",
  "public_updated_at": "2017-11-10T15:15:29+00:00",
  "publishing_app": "publisher",
  "redirects": [
    {
      "destination": "/2b9ff964-ff17-41d1-ad07-26eba43dd75e",
      "path": "/fa4064fe-b1ad-45af-9994-8ff269b75271/babb8047-8848-4093-a7f1-78585b94d0a5/97351659-88ef-43f2-9696-acadbbef4fea/d3808330-5a1c-4f0b-9d05-c66793c519f7/5f0803be-c68e-4749-bf4d-0df0a56f0d33",
      "segments_mode": "preserve",
      "type": "prefix"
    },
    {
      "destination": "https://woky.etxrmy.zegl.scjyo.gov.uk/8c1ac446-83e5-4944-a929-a0619636cd99/6872076f-38a1-4fdb-ac68-2615ef904c0e/5e821580-1acb-4acf-aa72-7d713d7451f7/6020f148-cd39-4aec-8c71-d99f74ed0a92",
      "path": "/23a10128-7508-4799-bc7c-652b9d1a76a6/91424468-2585-41ec-8452-549bc16ecee2/88c8b34f-b1ad-4f05-bd45-743e13d85441/fa801a35-a2ef-44dd-a3fc-fc5b3c019261",
      "segments_mode": "preserve",
      "type": "exact"
    },
    {
      "destination": "/78604b35-c078-4a05-ab0b-11480a507bd4",
      "path": "/6a784fa3-b78f-47ea-84da-49151bf892c1/a15d94fa-59dd-4140-b362-665020077c2c",
      "segments_mode": "preserve",
      "type": "prefix"
    },
    {
      "destination": "https://omwl.jny.uclegorj.wufpkch.gov.uk/a7c0f9e4-5e87-4aae-9af1-379bbc37f1ab/65c96db5-768b-4c1e-b529-8879f2c17bdd/43f6d1ad-17de-449f-93af-372b42435d4b/70034f84-6428-48f9-85ad-f9e62d15987a/c377cf6c-5489-43cf-99fc-6242b5156b30",
      "path": "/f2bc48da-e4a6-4158-ab61-621764a12f18/0b65b9d9-5226-4398-93ba-a8f9e0b14153/cbf12882-99df-4d0a-bd96-51dea68915df/726a818a-120f-4f92-804a-9f7db8ab0798",
      "type": "exact"
    },
    {
      "destination": "/9da45949-db8b-4dca-9075-5aac9cc1b855/4cfe39a5-3ce3-454a-949c-f9f7f12a6666/6a14e192-da0b-4c7b-9550-75dab6cc2985/11896b3e-1245-4567-b835-145caca32cb7",
      "path": "/97d7ae73-eae2-4d0b-9bda-0c52c8ded7d3/39e3f364-fa1c-4729-9194-98572f13b784",
      "type": "exact"
    },
    {
      "destination": "https://mbivd.rhoi.fyrgq.ykjzvnoi.gov.uk/3b11f6cf-fe6b-49b6-870e-06b632394fa0/3a292ca6-0d33-4de6-a7fe-1cd8c7d9c475/a3c608f1-a6f8-4792-810b-65d2cac5919f/58818b09-6637-4684-a252-ee36f3270611",
      "path": "/2f11adbd-6467-406e-8140-3dc4a9bd6c2f/3ccb70f0-6128-4f50-bc66-8708fb914e4b/a2d218da-df19-4273-9f15-2f2a4241b21e",
      "type": "exact"
    },
    {
      "destination": "https://quls.cjhfnx.gov.uk/89c3cb0d-9aaa-4bbb-bfba-3c5536eba117",
      "path": "/0bd20f75-3567-4d46-bd94-5ec15d9e2102/85f90cd4-386e-4ce4-b05d-8c252c014bcf/e3b507c3-d918-418c-8d85-e7e67165a4e2/641d094b-525a-4126-aac6-c5b82d5e81b6",
      "type": "exact"
    }
  ],
  "rendering_app": null,
  "routes": [
    "ac",
    "morbi et cursus sem ac risus vel aliquet. libero. vestibulum. nisl Nam tempor finibus, molestie dolor turpis eros. Suspendisse imperdiet nibh suscipit",
    "molestie tempor mauris sollicitudin vestibulum. a risus bibendum. vel habitant risus pellentesque ac lectus Quisque cursus libero. non Aenean imperdiet interdum. Mauris Nam fames Ut finibus, eros. purus Suspendisse Nam aliquet. sed sit ac ultricies hendrerit, turpis ac nibh netus tempor interdum. nibh. morbi suscipit orci Pellentesque eu scelerisque. molestie eu sagittis leo vel massa Duis elit. Lorem et Sed nisl tristique senectus egestas. Ut amet, volutpat sem ipsum",
    "ipsum risus est. sit tempor in, amet, finibus, Sed Aenean imperdiet suscipit Lorem at lorem Nam",
    "tempor dolor interdum. suscipit massa cursus sagittis tristique Lorem nibh. tempor sem interdum. molestie habitant consectetur et Suspendisse Ut tristique morbi risus ipsum Pellentesque libero. dolor adipiscing eu aliquet. molestie senectus ac turpis nibh in, amet, lectus sollicitudin nisl bibendum. Mauris eu ac leo eros. a non Nam imperdiet Duis vel et malesuada Quisque ac finibus, orci sit",
    "purus Sed adipiscing non in, ac Lorem sagittis interdum. volutpat tempor risus habitant libero. Pellentesque tristique turpis Suspendisse massa et et eu sem elit. scelerisque. tempor imperdiet non amet, Nam molestie vel sit bibendum. vel morbi nibh. Nam at Ut lorem eu ac senectus ultricies aliquet. cursus est. orci Aenean mauris"
  ],
  "schema_name": "redirect",
  "title": null,
  "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": {
  }
}