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

content_purpose_document_supertype
string
Document supertype grouping documents by 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
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, 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, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
rendering_app
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

{
  "base_path": "/7a3a9211-4656-4521-bdfd-0af5ec643e11/6f7b9379-e638-4a19-9562-065460f4a73a/2a87060b-b70e-4b19-ba83-8da16c0fc7db",
  "content_id": "cb4e002b-6d97-45a2-85f7-21b6ba44c15f",
  "content_purpose_document_supertype": "morbi Quisque Sed adipiscing non eu pellentesque fames scelerisque. vel tristique in, cursus volutpat risus vel ac hendrerit, malesuada Ut lectus est. ultricies netus a aliquet. finibus, Pellentesque suscipit ac Lorem mauris interdum. orci sit risus massa molestie non ac Aenean nibh. eu molestie bibendum. dolor leo ipsum nisl sagittis et sem tristique nibh elit. imperdiet Nam eros. vestibulum. tempor Suspendisse et ac Ut habitant egestas. senectus Nam dolor",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "first_published_at": null,
  "links": {
    "available_translations": [
      {
        "api_path": "/6880d4f9-213d-4eab-a843-6986218f5ab5/dfd12c7f-d556-4f2f-a3a6-f1b5e12bebc9/7984f9d2-8f77-4eb4-b686-57ea1f3fc4d6/51b3ea14-cda0-4330-9d73-0e2181c40f0d",
        "base_path": "/086cea64-b55e-4d14-a6ed-a1da5fbce84e/9e9cdcd2-ca56-4501-a17f-79a96c159323/0f965145-905d-42c0-9594-5af68ebb17d4",
        "content_id": "3c86c6da-1da7-496a-a209-601ca3c04578",
        "locale": "id",
        "title": "Quisque ac hendrerit, Nam amet, nibh et turpis ac in, dolor tristique lorem Lorem ultricies et interdum. ac eu lectus eros. dolor sollicitudin elit. sem sit molestie a molestie est. leo",
        "web_url": "http://example.com/a4afeb3f-d1c8-42ec-815c-714b5cbd51fa/29dcdd8d-078c-4262-b00a-a9a230ace33d#8dfbe7a45073fc871cc2ec833506cc5d"
      },
      {
        "analytics_identifier": "est. molestie eu aliquet. turpis libero. tristique bibendum. Suspendisse Ut vel ac senectus Sed a ac risus et interdum. Quisque consectetur vel molestie sit et egestas. Ut netus elit. orci purus fames sed scelerisque. Lorem Nam massa porttitor ac leo mauris dolor Pellentesque tempor tempor non nibh. non amet, at sagittis lectus Mauris",
        "base_path": "/8009b850-5c99-4b02-ba19-204eca9aaa96/01a051be-6816-49b4-bef2-34e69c700c6f/3a36fee6-e6aa-4df9-9c5f-83cc3a2ce157/66c5409c-3877-4161-82cc-d491357d52bd",
        "content_id": "bbde105e-77f0-44ff-abc3-7f7983bacd3e",
        "links": {
        },
        "locale": "bg",
        "public_updated_at": "2017-12-26T14:31:11+00:00",
        "schema_name": "scelerisque. vel consectetur tempor ac risus malesuada pellentesque ac est. molestie dolor turpis lectus adipiscing Duis Nam vestibulum. tempor eu tristique ac volutpat aliquet. egestas. nisl sit Suspendisse mauris in, et morbi Mauris nibh at non purus hendrerit, Pellentesque Quisque risus fames ultricies Ut Aenean tristique elit. amet, cursus ac orci massa lorem libero. sollicitudin imperdiet suscipit non leo interdum. interdum. ipsum Ut a et vel sem eros. finibus, dolor sed senectus habitant netus bibendum. eu sagittis Sed Lorem nibh. molestie porttitor Nam",
        "title": "eros. malesuada ac interdum. bibendum. dolor Lorem leo tristique eu volutpat Ut hendrerit, adipiscing lorem ac mauris sollicitudin ac scelerisque. eu turpis Ut sem orci molestie vestibulum. tempor habitant at ac consectetur Duis sit risus imperdiet senectus sed libero. purus nisl porttitor fames nibh amet, tristique massa interdum. Aenean aliquet. molestie est. ultricies Sed pellentesque ipsum Nam cursus Suspendisse non sagittis vel lectus a dolor et tempor Mauris nibh."
      },
      {
        "base_path": "/9e65eb31-ace4-4654-8abd-38a7adeebe44/d8957060-a810-4e67-934a-c5f118028058/b72a0309-7544-4529-a472-5d7b218dec63",
        "content_id": "d051d392-e4a4-4365-ba80-eabe7bfe4df9",
        "locale": "lt",
        "schema_name": "ac eu habitant mauris pellentesque egestas. dolor ac vestibulum. est. Duis Quisque Mauris malesuada non non sit interdum. cursus nisl elit. lorem vel fames eros. interdum. ipsum tristique in, risus Sed risus Aenean a lectus molestie amet, sed consectetur aliquet. bibendum. netus volutpat vel nibh. Nam morbi senectus imperdiet eu tempor et ac sem porttitor suscipit dolor leo libero. ultricies hendrerit, nibh sagittis purus Nam Pellentesque et finibus, tristique scelerisque. Lorem Suspendisse ac massa at tempor orci Ut turpis",
        "title": "eu netus sem et Nam interdum. tempor dolor ac malesuada ac dolor elit. Pellentesque vel lectus Lorem ac Aenean pellentesque sed eu orci ultricies sit est. Mauris molestie senectus lorem Sed habitant morbi"
      },
      {
        "api_path": "/a06c4fe3-f714-47d3-acba-365b8ed90779/8798695b-e6b9-495f-a5a3-07be6c88b6ab/0fa0044d-467a-4950-872b-46dbe65d8708/b13662f3-0211-432a-a126-45e86ed37dde/5ef6a539-2fb4-4348-9dc9-205aea07c5ac",
        "api_url": "http://example.com/e475fb0f-6660-4a7d-9adc-6d4cc12444d2/09c05d68-da92-478e-ba63-e3c5d034bae9/79beff7a-e1ea-4103-92a8-5582f30ee0f7/bcddd800-7285-4e15-9d22-5f7087890f28#e5a96dab71b65f627efd7c8224f1419f",
        "base_path": "/d6ae28b0-55e8-4a8f-aab3-1640a8d7562a/b72bf3cd-c953-4644-94b8-4ee3d950ae56/60285742-38be-481e-b113-ae39f6713a1e/cdf38d79-acb9-4559-a2c5-a9bb3779bfa0",
        "content_id": "4af50bef-9be1-4aae-af81-c4eef0c5b1db",
        "document_type": "in, risus vestibulum. nibh et interdum. aliquet. habitant purus pellentesque nisl Suspendisse risus imperdiet est. tristique elit. lorem",
        "links": {
        },
        "locale": "el",
        "title": "adipiscing interdum. porttitor Suspendisse tempor Ut ac ac vel Quisque finibus, molestie risus lorem leo non massa est. ac cursus tempor Ut orci consectetur sit molestie risus et dolor suscipit netus turpis et purus morbi ultricies sagittis tristique sollicitudin non fames Lorem Pellentesque in, habitant nibh. dolor elit. libero. at tristique amet, lectus scelerisque. Nam a sem hendrerit, Duis volutpat sed senectus Aenean eu egestas. nisl ac malesuada vel eros. imperdiet Sed mauris interdum. aliquet. Nam bibendum. vestibulum. eu Mauris pellentesque nibh ipsum"
      },
      {
        "api_path": "/4924bd5f-285f-432d-95fc-e6ada611a3cd/3abaac80-28ba-4cbf-924f-c354d15ed8ee/3d354054-b570-4eea-a459-047312d9ee98/f87acbc2-289c-4b71-8cb0-86de8dc5ef22",
        "base_path": "/903257ce-5ffa-40c2-bb8d-e0d31faf1f54/221d51f8-09d5-4636-8126-551280acb094/e70e82e0-2425-4b87-a8b5-4667e0c62f88/c2017ec0-4ac5-4d9f-af1c-66ad551f5c82",
        "content_id": "1f304933-8b61-44b2-81e3-367d24a9df97",
        "document_type": "Duis senectus imperdiet purus Lorem Mauris Ut eu aliquet. scelerisque. lorem risus tristique consectetur finibus, Quisque dolor Nam elit. malesuada Pellentesque molestie bibendum. in, hendrerit, ac orci sem lectus at egestas. a ipsum est. suscipit netus leo Nam cursus pellentesque vel amet, tempor non massa fames Aenean morbi porttitor nisl eu libero. molestie interdum. non ultricies vestibulum. nibh tristique volutpat nibh. mauris",
        "links": {
        },
        "locale": "lv",
        "public_updated_at": "2017-11-09T01:36:01+00:00",
        "title": "eu finibus, est. Nam nibh. Mauris suscipit massa netus lectus sed hendrerit, a non tempor elit. tempor vel Pellentesque Ut porttitor sagittis malesuada sollicitudin leo consectetur pellentesque tristique tristique ac dolor et risus lorem ac at Quisque nisl in, molestie eros. risus Sed non aliquet. purus Suspendisse eu sem vestibulum. bibendum. Ut ultricies ac mauris imperdiet turpis orci Aenean Lorem morbi vel ipsum cursus adipiscing dolor Nam scelerisque. libero. fames et Duis amet, interdum. molestie senectus interdum. ac volutpat egestas. nibh habitant sit",
        "web_url": "http://example.com/54a1edf6-78f0-40e3-96f9-4807564afaeb#6e4fe6e352519c2d77025d2094509a20"
      },
      {
        "base_path": "/fa16bacb-617d-4ca7-bffd-c00591b55f82/c819a15d-2bda-455a-b2bc-fb98522aa1e4/1d42f80f-2090-422f-92e2-95998268c3a2",
        "content_id": "be390d3a-2e48-4dc2-8d84-3adad04d867b",
        "document_type": "porttitor nisl Suspendisse Nam dolor dolor massa interdum. consectetur cursus netus morbi Pellentesque nibh ac leo Nam sit pellentesque imperdiet habitant risus molestie molestie non orci adipiscing eu Lorem Sed et Ut Ut ac mauris ac aliquet. ipsum sem libero. Duis turpis suscipit vel at sagittis vel nibh. Aenean tristique sollicitudin finibus, egestas. Mauris sed fames amet, est. lorem purus",
        "locale": "ru",
        "title": "molestie nisl sed elit. senectus Ut tempor eros. habitant ac interdum. ultricies et at adipiscing eu ipsum dolor non vestibulum. morbi purus Quisque non mauris in, imperdiet porttitor Duis vel vel tristique tristique orci ac massa Aenean tempor netus eu libero. Lorem cursus finibus, risus suscipit aliquet. dolor Nam sagittis scelerisque. Nam egestas. volutpat nibh molestie turpis malesuada risus sit et Sed bibendum. Pellentesque sollicitudin amet, consectetur ac ac a"
      },
      {
        "api_path": "/715ca4d0-55d3-414b-a9c0-a22f84c67732",
        "base_path": "/94f5a449-f847-4d87-90a3-38eaab918019/74ca8950-ecb0-4296-9729-ec104a715b40/103cb9d4-a3bb-4520-a20d-d6e5fb221383/a86ed0c5-dbaa-45b5-8b24-1e417d138d73/888c5b91-aeea-4caa-aa5a-f56a3bb7682d",
        "content_id": "35e856ac-3d14-4f92-9232-14c4cdbb4e5e",
        "links": {
        },
        "locale": "tk",
        "schema_name": "bibendum. dolor elit. non nibh vel fames risus sollicitudin netus mauris sagittis Nam habitant cursus Mauris",
        "title": "in, Sed nibh. tempor Aenean Mauris mauris vestibulum. massa lectus dolor sem consectetur Duis tempor ac imperdiet est. lorem orci molestie elit. nibh et Ut Quisque Pellentesque Nam interdum. egestas. Ut morbi malesuada fames",
        "web_url": "http://example.com/a29bdb07-8392-4319-94d8-ec5edf4f7811/13a470ec-d006-4faa-b384-67543d1b9910/88e55893-6f80-4965-843c-2dc42e27d734/d1605e0f-8e31-4132-9e59-3d8f4db0eef3/96714739-cfa8-4ae2-b234-77b2bfe18641#14ad3d0d80e63f48a6a2c3e0b640e212"
      }
    ],
    "child_taxons": [
      {
        "base_path": "/9a41da04-aaf2-461c-8da7-662b6adbdea3/642a0d0c-64cf-446c-b8dd-0934d8bc88f3/1c701343-8bd8-49e4-8367-f025d383b8b9/0b73721b-1d28-4289-b06b-f3742fc8996c/6f310714-5104-455c-a0a0-8730e1275f96",
        "content_id": "98138859-46e4-49de-b5e1-ecfbc0e2e673",
        "document_type": "turpis nibh vestibulum. aliquet. purus mauris ac Aenean cursus Lorem risus porttitor amet, in, Mauris pellentesque elit. et sit volutpat eros. non tristique tristique sed adipiscing molestie tempor Nam risus Ut egestas. interdum. sem bibendum. lectus suscipit Duis nisl ac nibh. sollicitudin non hendrerit, malesuada morbi finibus, dolor eu leo molestie est. a Sed ac ac at vel orci ipsum consectetur Pellentesque fames vel imperdiet Quisque Ut tempor sagittis libero. eu massa senectus et lorem scelerisque. netus habitant Suspendisse ultricies dolor Nam interdum.",
        "links": {
        },
        "locale": "he",
        "schema_name": "lectus risus est. tempor turpis risus malesuada cursus netus hendrerit, massa suscipit sagittis nibh purus eu eu",
        "title": "eu eu Ut aliquet. massa eros. et est. tristique Aenean egestas. molestie Duis habitant sollicitudin Nam leo sed mauris finibus, scelerisque.",
        "web_url": "http://example.com/3227dfb4-ec99-40db-a903-bbd52afc7540#27b43855a4ea30d7eca8748fbc7d4aaa"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/5399ea6d-3311-4dc8-bbae-68785217c6e6/6b9abcdd-d757-48ad-8936-f9379c36cfad/0a61a52b-aeb8-4dc8-a611-70436fb55be9/ec5e16fb-0932-4da7-9ba5-4aa148e23170#d17ff15cb68c19ba878b0a311e46f8ce",
        "base_path": "/9075023d-ecdc-47a7-9c7f-181c58bca95f/563cd434-5b4d-44f6-9cbd-1e79fcd760c5",
        "content_id": "ea338651-2221-4622-8b82-8ee987051b16",
        "links": {
        },
        "locale": "be",
        "public_updated_at": null,
        "title": "risus scelerisque. Ut porttitor Aenean eros. ultricies amet, elit. Duis eu at malesuada sit ipsum molestie Ut vestibulum. Nam dolor non volutpat Mauris Suspendisse dolor Pellentesque et vel ac eu sollicitudin tristique pellentesque mauris Lorem a netus leo non imperdiet purus senectus tempor consectetur finibus, libero. vel in, risus bibendum. et sem tempor nibh habitant interdum. morbi orci hendrerit, sed sagittis est. ac interdum. fames egestas. nisl adipiscing suscipit tristique massa ac lorem Nam ac cursus turpis lectus Quisque aliquet. nibh. molestie Sed",
        "web_url": "http://example.com/6897531c-8050-4dae-9640-cd1f403034e2/01b56a51-0511-4eec-b3d2-127272fd34ac/3df065d4-5195-473d-9922-697373ac8190#f37b228c99a0c663506096c49605b2f6"
      },
      {
        "analytics_identifier": null,
        "api_path": "/84b81bf3-1268-4529-b790-bf90d8a1926c",
        "base_path": "/592be5e0-38d2-4795-8c57-b7129b80c8e9/e2e6f7c3-501c-4eba-9962-18a6f923e649",
        "content_id": "24f273cd-1e79-45ae-8d64-d0fdf6a8a8d0",
        "links": {
        },
        "locale": "ta",
        "public_updated_at": "2017-11-14T20:02:44+00:00",
        "title": "sed in, Suspendisse libero. purus a nibh senectus et risus sollicitudin ac vel eu volutpat lectus pellentesque dolor molestie adipiscing ac Lorem mauris risus vestibulum. interdum. scelerisque. Duis morbi ultricies Sed non ac Nam sagittis tempor suscipit ipsum interdum. massa sit amet, tempor ac malesuada elit. egestas. Ut imperdiet bibendum. lorem fames orci Pellentesque turpis hendrerit, est. molestie finibus, leo eros. vel at Ut tristique eu tristique nibh. Nam et Quisque sem habitant consectetur nisl"
      },
      {
        "base_path": "/92b48ccb-1969-49f5-b471-c247423f593e/6be24cc6-4bc0-48b2-ad42-fb1d3314d98c/91cee837-f2d7-4a75-9738-8d37611394e1",
        "content_id": "9d17e67b-7f0d-4c51-b3a2-967cfb2d862d",
        "document_type": "lectus tempor sagittis Ut eu dolor mauris ac aliquet. vel Nam egestas. turpis netus a tristique morbi habitant Aenean et eros. orci ac molestie Nam ipsum risus tristique Quisque Duis finibus, scelerisque. nisl pellentesque nibh. malesuada porttitor",
        "links": {
        },
        "locale": "es-419",
        "public_updated_at": "2017-12-23T13:14:05+00:00",
        "schema_name": "mauris a Duis ac eros. vel risus senectus Quisque at finibus, leo et egestas. nibh non Aenean sollicitudin malesuada dolor libero. scelerisque. netus amet, Nam molestie interdum. ipsum est. sit eu suscipit adipiscing dolor vestibulum. tristique sem lorem cursus turpis lectus volutpat non vel sed ac Pellentesque Mauris Suspendisse Lorem bibendum. habitant nibh. tristique ultricies hendrerit, imperdiet fames Ut morbi interdum. massa aliquet. Ut",
        "title": "egestas. est. tristique Aenean dolor Ut malesuada lorem volutpat ultricies ac non consectetur Sed",
        "web_url": "http://example.com/46d9b2ec-2184-423c-8328-525dd5ce9bd7/fc1c0abb-fe97-47f7-b821-d14e9b39c6a4/2c35e8c7-fce3-497c-8e6e-7e8b0d403701/d7bd9a63-9e2e-4f5e-8cb6-d824d3eec7a7/f37b9dc2-070c-47ae-9c9d-3eb948ff7181#150a518747469d6e8306d3dd8cc21381"
      }
    ],
    "level_one_taxons": [
      {
        "api_url": "http://example.com/02793075-fc0a-4dc2-b377-e85629904915/bfdd7cb3-2242-422b-b2f6-ad75a7087e57/de915ef3-8d0c-4a22-96cc-7704056fedd8/5af53fc4-d87e-4153-a6b8-e31b0e46b994/f69ef286-52e8-482f-b9f2-75fc790f3ec9#42bce5778907131dd548c1e173ce0955",
        "base_path": "/d894893c-8721-40a6-9fa5-1ce656bd29ab/588bccbd-c8cf-4a1a-83db-40587664452a/fe5d2221-27f5-4730-a724-2eeee2bac53b",
        "content_id": "42ced9cf-8b42-408c-8d60-847d42862efa",
        "links": {
        },
        "locale": "tk",
        "public_updated_at": "2017-12-22T07:16:14+00:00",
        "schema_name": "interdum. elit. tristique Aenean hendrerit, non lorem leo molestie et Quisque Pellentesque Nam orci netus volutpat ac risus ac sem ultricies turpis egestas. habitant tempor aliquet. Mauris ac",
        "title": "Sed ac eu Quisque lectus aliquet. fames netus interdum. interdum. suscipit consectetur tristique sem"
      },
      {
        "analytics_identifier": "morbi Suspendisse Lorem lorem interdum. dolor Aenean molestie turpis ac vel risus suscipit Nam malesuada nibh egestas. orci non elit. adipiscing aliquet. mauris est. Pellentesque hendrerit, tristique Mauris volutpat tempor lectus ultricies cursus in,",
        "base_path": "/78ae6f49-613e-4bd3-a69e-423a7548481d/688746b4-363a-45ec-a782-f21efe260666/e189a38d-3a22-4c60-a93d-6e94b93d0659/4c4267c1-e489-4810-9058-9725861bb8f2",
        "content_id": "e16ca0be-c48b-4bd3-8fd9-02b7533966da",
        "document_type": "",
        "links": {
        },
        "locale": "el",
        "title": "Duis elit. sagittis finibus, ac eros. tempor egestas. mauris Nam netus ac et suscipit Suspendisse habitant sit Mauris massa consectetur sem Lorem risus Aenean morbi adipiscing imperdiet molestie fames vel tristique eu nibh. interdum. libero. tempor Pellentesque lectus ultricies scelerisque. aliquet. bibendum. leo eu risus interdum. dolor amet, est. vestibulum. vel cursus non non sollicitudin Quisque Ut porttitor orci dolor et a nibh sed senectus hendrerit, tristique Ut ac pellentesque at Nam ac malesuada volutpat Sed ipsum",
        "web_url": "http://example.com/7a227699-4c30-4f9d-952e-6aaa1c1d1c1c/b617be77-4d6f-4ec5-bc35-07565b4873e5/540d5bcc-9876-4a9f-a613-434bafbc2286/73e8bf61-abd5-402b-83a8-ca44bb8cbc00/25efe34b-43f7-40c0-9f17-233c3d7c7065#c13aa0b4d6888b329002f1891db99f0b"
      }
    ]
  },
  "locale": "it",
  "navigation_document_supertype": "interdum. amet, Quisque purus turpis pellentesque libero. vel habitant tristique morbi at Aenean dolor lorem scelerisque. interdum. malesuada ac tempor eu Mauris suscipit lectus egestas. ultricies sed est. ipsum consectetur ac nibh. adipiscing ac volutpat massa sollicitudin finibus, et dolor tempor non imperdiet eros. nibh a sem risus non eu fames nisl senectus",
  "need_ids": [

  ],
  "phase": "beta",
  "public_updated_at": null,
  "publishing_request_id": null,
  "schema_name": "redirect",
  "title": null,
  "updated_at": "2018-02-05T17:42:41+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, 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, 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

{
  "base_path": "/65f778a6-2417-4f66-ba8f-e6c11b387da0/d5d2acb7-55ec-4e8e-a495-6c6d2b16628f/3573287d-4606-47d5-bcf4-bc634e8dfcbe/ee997a1d-79ac-4e7c-9437-f85d66bb0300/0311207a-045c-4a5d-b384-5878f64bba78",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "first_published_at": "2018-01-15T13:10:34+00:00",
  "links": {
  },
  "locale": "ar",
  "need_ids": [
    "tempor a volutpat aliquet. vel ac elit. massa lorem purus sed nisl non molestie senectus porttitor Aenean leo egestas. dolor eu suscipit Nam Sed at sagittis libero. interdum. netus vel ac risus Lorem finibus, orci eros. imperdiet cursus",
    "purus Ut sed vestibulum. Sed bibendum. finibus, tristique malesuada amet, sem elit. ac habitant tempor nibh. nisl interdum. netus ac dolor hendrerit, risus volutpat Lorem tristique in, sit Quisque Mauris ac dolor non et egestas. sollicitudin massa at Duis sagittis consectetur risus cursus interdum. Nam et molestie molestie mauris orci leo senectus lectus est. eu Suspendisse eu suscipit",
    "lorem eu tristique et Ut Suspendisse risus porttitor molestie ac at leo scelerisque. interdum. sed in, risus vel Aenean et adipiscing ipsum sollicitudin nisl tristique sem amet, habitant Ut",
    "ipsum Suspendisse dolor Sed non bibendum. pellentesque egestas. suscipit Nam ultricies porttitor morbi dolor hendrerit, Mauris Ut leo sem Pellentesque nisl sed risus ac lectus a scelerisque. massa Quisque in, molestie Duis sollicitudin at aliquet. ac interdum. molestie habitant lorem ac cursus Nam tristique orci adipiscing netus et libero. imperdiet ac Lorem tristique turpis interdum. vel et tempor fames nibh eros. Ut Aenean malesuada mauris vel vestibulum. risus purus finibus, amet, nibh. eu non volutpat consectetur est. tempor sagittis eu senectus elit. sit",
    "aliquet. leo amet, cursus sollicitudin adipiscing ac pellentesque tristique Pellentesque mauris dolor tempor ac sit eu tempor vel non non eu Duis nibh Nam at habitant tristique Suspendisse Aenean nibh. Mauris vestibulum. ipsum suscipit eros. molestie ac porttitor scelerisque. senectus lorem Ut fames netus",
    "interdum. eros. senectus molestie a non ac amet, sagittis scelerisque. sit aliquet. adipiscing purus interdum. ultricies vestibulum. Quisque lorem ac finibus, nibh."
  ],
  "previous_version": "sagittis scelerisque. non ac morbi suscipit in, interdum. ac leo at vestibulum. habitant senectus interdum. pellentesque Mauris",
  "publishing_app": "service-manual-publisher",
  "redirects": [
    {
      "destination": "https://kjsv.vrpkbse.gov.uk/4fa78e80-97a3-4b21-8836-fe51a9e04e5c/cbadca6b-a19a-40d8-97b0-8e6865edaa16/9b165d8d-948c-4717-a446-ea7751243a20",
      "path": "/53c05557-b2fa-4b1f-9ff4-cb868927f158/9ad8f189-3f60-41f1-ae57-3a3a71100db8",
      "type": "prefix"
    },
    {
      "destination": "https://zwlj.sjqxhi.yxip.gov.uk/12d431e4-bfd9-45c6-b7de-17cfe1caf709/43e309a9-202c-4987-9240-469a26ffdd21",
      "path": "/d591a932-02c4-4008-9523-aa41b870582d/8750de5a-6ab8-48e8-97c1-80a8e7ba6114/6cd4b2aa-66ef-436e-824d-7ebeb8b8632b/26bb91c6-4ec3-402e-bd97-fa0f4a2e9e80",
      "type": "prefix"
    },
    {
      "destination": "/aa716559-f2b1-42c5-bf40-21ed123603d4/c1e68c3b-3017-427e-b8c5-c70b81f4bb39",
      "path": "/0d127d2d-d164-4702-9219-273c6d38a083",
      "type": "exact"
    },
    {
      "destination": "https://ivcqs.vuk.jgovzifr.feyr.gov.uk/4c34f7ab-3739-4814-be3e-7f3ae2681f52/61940357-e685-4bbe-b5a6-bf7e8f4978fe",
      "path": "/7228d03a-e45f-4b53-aafc-c2068e619f36/b582ae9f-ccfb-4ff9-afda-8cac605b18e3/67466366-21a7-4e18-9290-0c7035a6750f/7c87c582-71f5-4090-936e-308e49bab82f/ce6a5bcb-66be-4a5c-855d-7d2f8e4c66b8",
      "segments_mode": "ignore",
      "type": "prefix"
    },
    {
      "destination": "/4019b095-fce3-4799-9f74-6fb890de42d8/26801a39-83c8-4f82-9e85-bbbe1f1b7199",
      "path": "/a2afc5db-1fca-456d-94e3-dcf8730d2060/b09fe980-96ba-4aab-a5b1-c805acd1aca8/454fbba1-9aea-4c56-bd77-1d2589144b07",
      "segments_mode": "ignore",
      "type": "exact"
    }
  ],
  "routes": [
    "purus tristique et mauris turpis at imperdiet scelerisque. Ut fames adipiscing non ac hendrerit, eu vestibulum. eu tristique interdum. aliquet. sollicitudin vel leo ac nisl Mauris malesuada bibendum. libero. habitant dolor lorem senectus ac non risus Suspendisse Nam cursus consectetur ac Pellentesque egestas. netus porttitor Ut est. lectus tempor finibus, et molestie Duis suscipit Nam vel sem morbi ipsum nibh pellentesque sagittis amet, in, Sed eros. Lorem orci Quisque interdum. sed massa molestie a ultricies nibh. tempor sit elit. volutpat Aenean dolor risus",
    "dolor interdum. et libero. pellentesque scelerisque. sem Sed eros. netus amet, hendrerit, purus orci consectetur a eu",
    "porttitor consectetur libero. et aliquet. molestie nibh. non mauris tristique ac ac eros. fames leo adipiscing Suspendisse Pellentesque ac vel sem morbi senectus sit est. lorem egestas. volutpat risus scelerisque. elit. orci Duis tristique bibendum. pellentesque eu sagittis imperdiet in, Ut netus non turpis tempor eu suscipit hendrerit, lectus sollicitudin amet, interdum. molestie tempor nisl malesuada ac at Lorem nibh vel cursus sed ultricies Quisque ipsum",
    "nibh. sem habitant Aenean elit. ac lectus cursus risus risus interdum. eu ipsum Lorem Quisque Duis at dolor Nam bibendum. Ut lorem ac sagittis imperdiet libero. senectus tristique Sed sit dolor malesuada egestas. volutpat amet, eros. ac molestie et Pellentesque morbi finibus, fames vel in, Mauris aliquet. Nam Ut interdum. molestie netus ac est. hendrerit, non a scelerisque. tempor massa suscipit tristique purus Suspendisse nisl eu pellentesque orci sed mauris adipiscing porttitor turpis tempor vestibulum. nibh vel consectetur sollicitudin non ultricies leo et"
  ],
  "schema_name": "redirect",
  "title": null,
  "update_type": "republish"
}

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

{
}