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

{
  "base_path": "/027dd0aa-6869-4537-a6b5-c511befeecaa/e4665f94-9494-489b-8ed2-86a03d22dd8f/0dec3ace-6c18-4169-9263-c93291e0d4fc/fa880264-176d-486d-a92c-95783f342966/3dd7098d-40bc-44b3-84a8-b2d3009f28e6",
  "content_id": null,
  "content_purpose_document_supertype": "nibh. Lorem Ut pellentesque sem Ut netus hendrerit, consectetur molestie ultricies risus sit sollicitudin Suspendisse massa eros. Mauris volutpat tempor est. imperdiet tristique sagittis porttitor malesuada cursus sed",
  "content_purpose_subgroup": "tristique sem hendrerit, purus risus nisl Ut ac volutpat senectus porttitor scelerisque. Duis non amet, aliquet. Mauris vestibulum. netus Sed nibh tristique lectus Aenean dolor et vel non Pellentesque dolor massa libero. egestas. suscipit turpis Nam adipiscing eu Nam leo fames ac ac interdum. sagittis est.",
  "content_purpose_supergroup": "scelerisque. turpis lorem dolor ipsum ac malesuada vel imperdiet bibendum. finibus, sollicitudin Pellentesque Suspendisse netus Ut non nibh interdum. molestie suscipit Aenean et nisl molestie fames senectus mauris ultricies sit hendrerit, risus est. a tempor adipiscing eu Mauris morbi vel eros. tempor sagittis libero. Ut vestibulum. aliquet. ac orci risus tristique consectetur purus non eu sem elit. egestas. Duis nibh. at Nam massa in, ac sed interdum. amet, tristique lectus",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "email_document_supertype": "consectetur nibh. Aenean orci sed Nam eu purus massa imperdiet Quisque eu finibus, morbi Lorem tempor non sollicitudin egestas. sagittis lectus elit. aliquet. sem porttitor nisl volutpat sit hendrerit, fames Ut Mauris risus ac ac netus amet, non vel Sed lorem scelerisque. adipiscing interdum. Pellentesque tristique suscipit nibh interdum. molestie tempor risus habitant malesuada dolor bibendum. in, Duis at ac est. ultricies dolor senectus molestie pellentesque cursus et libero. ipsum turpis et vel a tristique mauris vestibulum.",
  "first_published_at": "2018-08-06T03:42:23+00:00",
  "links": {
    "available_translations": [
      {
        "base_path": "/a0dbd1a6-121c-4687-8abc-7b2d075102d0/0733530e-1899-40f4-b433-68f49416a076/1c272e6e-6d03-4292-a62a-e4c3eb65a926/1d5f38e2-19fa-4237-b53d-76bf7c8db6b9/5a0c5205-000f-46b9-8299-4016325140c2",
        "content_id": "22379414-8eb5-4175-9b03-7dc8d4cd7d83",
        "document_type": "Ut",
        "links": {
        },
        "locale": "ja",
        "schema_name": "sit orci tempor interdum. Nam turpis finibus, tristique eu in, sem pellentesque Quisque suscipit aliquet. ac volutpat mauris et massa Pellentesque Nam tempor ac Mauris scelerisque. ac hendrerit, vel molestie Sed Ut vestibulum. malesuada dolor egestas. cursus bibendum. a sagittis purus ac senectus nibh. Lorem sollicitudin amet, at libero. habitant Suspendisse fames",
        "title": "ac adipiscing finibus, Ut vestibulum. ultricies amet, in, nisl Sed et senectus pellentesque dolor porttitor fames ac a tempor dolor ac"
      },
      {
        "base_path": "/506ed38d-7180-4888-b600-47b9d8c7bf26/23ef651c-9c1e-4353-8db8-aefda3c7309a/146ea1d1-5275-4a93-80f5-68bd8d997eb7",
        "content_id": "c716b3f6-044f-4c4d-9768-fb13a059d21c",
        "document_type": "egestas. scelerisque. sit eu sem sollicitudin interdum. risus sagittis interdum. ac Quisque consectetur habitant Ut pellentesque ultricies tempor est. turpis Nam morbi finibus, ac bibendum. orci Mauris malesuada dolor eros. vel molestie Pellentesque non nibh lorem libero. et Ut Aenean at hendrerit, mauris non ac lectus Lorem molestie vestibulum. purus Duis fames suscipit cursus vel volutpat amet, a imperdiet tempor aliquet. netus risus Nam sed Sed",
        "links": {
        },
        "locale": "lt",
        "title": "ipsum Ut sed netus massa Ut in, aliquet. molestie non Sed Pellentesque molestie Nam libero. habitant dolor Quisque interdum. pellentesque ultricies eu mauris finibus, vel turpis malesuada tristique nibh et tempor risus adipiscing orci ac sagittis purus cursus a eros. ac interdum. sem lorem suscipit Mauris sit fames"
      }
    ],
    "children": [
      {
        "api_path": "/4bb07724-2151-4c1e-b7a9-8d86d570dd96",
        "base_path": "/57f34f8c-d1b8-4f80-80e9-25c4349edf7c",
        "content_id": "c0e86b4c-5a7c-4818-bb2f-f08069fd3f9c",
        "document_type": "bibendum. Quisque imperdiet ac leo lorem dolor eu aliquet. non pellentesque risus vel consectetur Nam massa dolor egestas. Aenean Ut habitant porttitor eu elit. purus morbi sed Pellentesque non est. finibus, Nam lectus suscipit Duis malesuada Sed ac nibh nibh. interdum. sit senectus eros. sagittis molestie turpis a scelerisque. Suspendisse tristique in, Mauris nisl adipiscing ipsum risus tempor sem mauris et ac vel tristique tempor netus hendrerit, vestibulum. Lorem molestie interdum. ac et sollicitudin ultricies Ut at fames cursus libero. volutpat orci amet,",
        "locale": "ta",
        "public_updated_at": "2018-06-15T08:52:35+00:00",
        "schema_name": "Aenean sollicitudin sagittis Nam elit. ac turpis leo et Suspendisse ipsum egestas. sed non habitant Ut massa vel Sed volutpat malesuada sit Mauris fames lorem scelerisque. eu nibh. tempor ac est.",
        "title": "hendrerit, orci Sed cursus purus tristique sagittis eu tristique non Quisque tempor interdum. et imperdiet habitant bibendum. turpis egestas. tempor lorem eu et"
      },
      {
        "api_url": "http://example.com/21119050-fb6f-4add-9844-07df65cb8ca1/651b782c-7156-489c-b445-f60859f237c4/a8ea5133-97ff-4b20-a1be-cea012927ae2/1a47d45e-5d1c-4f1d-b1d3-9f9bc2eec49b#0a52f80ef7c2d0cb1f876114f6e613d1",
        "base_path": "/7f0b1746-879e-4947-b77f-68b4554d41f1/e6cccb09-996e-4c91-bc48-9a0fa0cb95a9/86259418-a964-44fd-b67e-5287f9644d00",
        "content_id": "95d029eb-d256-4adc-b292-545240769994",
        "document_type": "nisl aliquet. mauris ac sed eros. tristique ultricies sollicitudin elit. scelerisque. turpis est. tristique interdum. fames libero. interdum. vestibulum. a sagittis ac dolor Nam morbi lectus Aenean molestie tempor malesuada pellentesque risus habitant nibh. eu Quisque massa Pellentesque porttitor nibh dolor finibus, amet, orci Sed tempor consectetur molestie suscipit",
        "links": {
        },
        "locale": "cs",
        "schema_name": "interdum. Quisque hendrerit, sit fames lorem sed at sagittis ac aliquet. Lorem ac risus ultricies tristique ac in, nisl non elit. adipiscing sem scelerisque. molestie imperdiet finibus, et Nam senectus suscipit amet, egestas. orci pellentesque massa malesuada bibendum. Sed Mauris a ipsum mauris tristique libero. Duis porttitor eros. nibh netus sollicitudin Suspendisse vel volutpat dolor nibh. ac dolor turpis molestie Pellentesque risus non morbi Ut purus lectus cursus Ut habitant leo tempor tempor vestibulum. interdum. eu Aenean est. Nam vel",
        "title": "elit. habitant risus Nam adipiscing Duis Mauris dolor scelerisque. tempor tempor ipsum sollicitudin imperdiet Pellentesque risus leo vel senectus ultricies eu a lectus et interdum. purus non nisl molestie Lorem dolor et fames est. ac in, Ut bibendum. sem sed at Nam consectetur vestibulum. non eros. amet, nibh tristique sit massa morbi netus hendrerit, molestie nibh.",
        "web_url": "http://example.com/1bad31fd-e479-4cb0-838d-2491b02c03d4/20ae4058-fb5f-4be6-86a8-8547b685f818#0efada30b9dada49a2a601bfd907343d"
      },
      {
        "analytics_identifier": null,
        "base_path": "/58d38413-ff27-4c94-bc3b-9caced156567/44d54d72-b505-44f6-a2a5-b8cdcd048096/7b6d7131-92f5-4279-89f5-7d8842898b3d",
        "content_id": "5017de50-e05a-4cc0-89bb-7c2694d768cc",
        "document_type": "a nibh. finibus, bibendum. et ac morbi dolor eros. interdum. sit lectus Nam purus pellentesque sagittis adipiscing egestas. risus molestie Ut Duis Pellentesque eu risus sem orci sed sollicitudin imperdiet porttitor non nibh Ut mauris eu tempor ac ultricies consectetur elit. leo Suspendisse libero. vel amet, scelerisque. est. lorem nisl habitant tristique tempor non netus turpis",
        "links": {
        },
        "locale": "tr",
        "schema_name": "a elit. Ut et est. Pellentesque fames habitant Nam bibendum. eros. interdum. suscipit orci lorem nisl Lorem Ut pellentesque finibus, adipiscing at Quisque leo hendrerit, malesuada Suspendisse ultricies libero. ac tempor Mauris eu non sit ac tempor tristique tristique netus Duis non interdum. risus Nam dolor nibh ac porttitor sollicitudin amet, et scelerisque. purus in, ac egestas. vestibulum. sed consectetur sem molestie sagittis massa aliquet. dolor vel turpis",
        "title": "at ac nibh in, Lorem tempor ipsum pellentesque eu vel finibus, sit molestie dolor Nam orci tristique elit. turpis mauris Nam Ut Aenean ac morbi ultricies nisl non Suspendisse amet, netus et molestie vel habitant consectetur malesuada suscipit Mauris ac nibh. hendrerit, sed risus lectus eros. Pellentesque dolor interdum.",
        "web_url": "http://example.com/eb6ceb0c-6009-4f97-a3a6-a4a2ad07dd25/bf005cd2-d062-4154-8a34-02bfcc7190ba/3bee87fc-1091-4c46-b326-e954ad1f8834/d391fe4f-2536-4041-aa2b-79999d98e7d3/d5e8e109-8baa-47cf-bd23-78464b1785f6#dc6d3be53332d66e045e4372f2c435d5"
      }
    ],
    "part_of_step_navs": [
      {
        "analytics_identifier": "sed tempor interdum. lorem nisl Sed ac consectetur Suspendisse nibh ac sem libero. ultricies ac sollicitudin vel malesuada elit. Pellentesque tempor aliquet. leo scelerisque. et eros. cursus",
        "base_path": "/d4824bad-7815-4ecc-a54e-dcc9a90b7925/663f406a-3674-41a1-8856-075abd9d3e18/a6068af9-eee1-4c38-89ed-7cbf6102987e/efb5f325-85e9-43d4-a434-7070155d9c47/a9bfd0f8-6f58-4353-a896-76d6388b9458",
        "content_id": "8930ef9d-ed95-4a30-8005-2673501a77ac",
        "links": {
        },
        "locale": "pl",
        "public_updated_at": "2018-06-23T04:48:30+00:00",
        "schema_name": "molestie Mauris vestibulum. lectus eu eros. sem a fames nisl non senectus risus ac non interdum. purus Ut in, finibus, dolor ac aliquet. sagittis et mauris imperdiet bibendum. Ut leo ipsum risus amet, morbi Pellentesque porttitor hendrerit, eu lorem Aenean suscipit est. sed elit. volutpat tempor interdum. Nam ac ultricies adipiscing pellentesque vel et nibh nibh. at massa sit ac consectetur Lorem vel Suspendisse sollicitudin tristique",
        "title": "netus Sed at a vel mauris lorem orci massa molestie finibus, purus volutpat ac ac sem sollicitudin vestibulum. bibendum. Aenean risus tristique egestas. et molestie lectus in, pellentesque et ipsum nibh interdum. suscipit porttitor Mauris eu",
        "web_url": "http://example.com/f61d0952-cec1-404c-a2f4-3f0fc73aee1a/bf7e77d8-14a0-4c9d-b9c4-c0b029f3fe52/277604a6-3251-4951-955f-d756de4e8b5d#589afbeae606219953c3546a26d14e4a"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/a94ade0a-5b61-4321-b397-0dc3810f3060/b5e5c5c6-8640-44ff-85b7-759a9e7479cc/d9f2f955-9225-4b29-86fc-6d67bf9206b0/4968e5c5-3d10-4b9a-b6cf-5c1ba7e8793f#947e083c1e515a726d50580d6f9837b1",
        "base_path": "/44378141-5ff1-432d-8ed6-8041b4c2b2fc/8c9070d6-b9c6-498d-9e66-84e30d6c7099",
        "content_id": "80db71e9-63d9-4053-bedd-61724dd6deea",
        "document_type": "est. risus volutpat nibh eu amet, tempor nisl purus interdum. a lectus sed molestie molestie Ut suscipit Suspendisse vel et massa in, imperdiet bibendum. dolor vel Nam Lorem senectus ac Mauris porttitor consectetur ipsum adipiscing interdum. ac",
        "locale": "th",
        "title": "cursus egestas. purus Nam interdum. consectetur tempor elit. interdum. at imperdiet Duis adipiscing vel Ut nibh non aliquet. ac pellentesque Mauris non malesuada orci est. sollicitudin"
      },
      {
        "base_path": "/e7755d9b-f45b-4355-aa58-16f9cbe06ac3",
        "content_id": "b1e24f1f-1e89-467a-8231-15d2dd408fcd",
        "document_type": "Pellentesque Suspendisse pellentesque a ultricies Aenean netus in, non risus Lorem Quisque imperdiet eros. interdum. vel lorem Ut at eu Mauris",
        "links": {
        },
        "locale": "ko",
        "title": "tempor mauris morbi est. interdum. fames ac eu Mauris leo hendrerit, vel imperdiet Nam ac ultricies non finibus, lorem sollicitudin Nam molestie et at interdum. aliquet. netus et pellentesque consectetur amet, risus Ut sed ac sagittis eros. dolor massa vestibulum. adipiscing in, lectus purus sem turpis risus malesuada scelerisque. ipsum molestie dolor tempor suscipit vel",
        "web_url": "http://example.com/26cf242b-6c63-47f2-857d-dcb31d8f4737/89845043-5b3c-4406-969a-de22e7c44489/01ecb1ef-7352-4ee9-9967-077dca77c044/0563fed9-af0b-47b5-b47d-87b243431299#d2f80b0f2accdd25117d5dd27cfc54e2"
      },
      {
        "analytics_identifier": "dolor consectetur ipsum sem vel suscipit elit. fames non interdum. Pellentesque Quisque Mauris tristique aliquet. tempor Aenean sollicitudin Ut molestie bibendum. risus eros. lorem lectus ac libero.",
        "base_path": "/86b8f7c4-8d13-44ef-bb57-252f2591edf2",
        "content_id": "655d83b2-23bb-4e3a-a702-ae989a150c2b",
        "document_type": "egestas. sem Mauris et nisl amet, Aenean habitant vel cursus a Duis interdum. mauris",
        "links": {
        },
        "locale": "el",
        "schema_name": "orci",
        "title": "aliquet. Mauris tempor est. libero. fames adipiscing interdum. molestie volutpat dolor in, sed nisl Duis tristique vel malesuada et ac Aenean elit. Pellentesque ultricies scelerisque. habitant egestas. turpis Sed morbi ac mauris sagittis eu sollicitudin eros. Quisque imperdiet orci Suspendisse senectus suscipit amet, eu lectus pellentesque Nam risus finibus, porttitor sem et ac vel Lorem non Nam nibh nibh. tristique purus lorem interdum. ipsum ac dolor tempor Ut",
        "web_url": "http://example.com/90ceadfa-981c-4f81-8375-6e2632ab79ed/f0f01dd3-fdcc-4dc5-932c-df4d4493185d/6f9b0b94-d301-4eba-902a-16202b34c217#84d7dabb8d5f6f32b90af8c02bda3a81"
      }
    ],
    "policies": [
      {
        "api_path": "/da9cd853-7bc2-40b7-a7a0-dbc46e7ae5a2",
        "api_url": "http://example.com/f735f4f6-083e-4e31-9468-8fa370854b92/5bd88666-3724-4fd0-9e3e-c15cfedee9a9/1f55458a-13d7-410b-be89-007c6086fbf7#85ae5b0b3d0bb671268f0963c06d0f89",
        "base_path": "/52796a54-41cf-4a66-aa65-cc545075ec47",
        "content_id": "f0b44595-8dc5-406b-8c5d-a90bff8f970f",
        "locale": "zh-hk",
        "title": "Aenean sagittis finibus, Nam dolor Lorem suscipit massa porttitor sollicitudin ipsum",
        "web_url": "http://example.com/0d312c07-a5b8-45f7-8879-1bc292ea45e1/a6fc0dd4-1959-4107-9d76-efb32bd71c67/f4404947-7bce-426c-b29b-65b238889c78/5fa5d103-12c1-489f-964d-df658cd6f206#7a36d9b16693d0541b2f593bc3ff642d"
      },
      {
        "analytics_identifier": null,
        "api_path": "/ea3d78d2-eafc-4188-ba92-8a1a178c3e8c/d6c8009e-e4a5-432f-987e-9ac8420bc67a/91557300-63a0-4a40-a785-599f993bc565",
        "api_url": "http://example.com/ec5bfeb4-2650-4b16-971a-36309eab2ba0/6d0489c9-a8b9-4f3f-8dba-23b9ba077cd2/fce8b266-fd1e-4987-ab38-ffcccfbce5fe/e60cdf8e-f380-4cde-839a-dd522bc54c79/38f839e4-5dc5-4292-8869-fa961d427610#33c8e96e5d34d4d94f68eaae556addc1",
        "base_path": "/1d7d9f12-6691-4a1d-9f44-901b05305563/3d201e33-1224-4db2-bb68-dbd4db301234/de29244d-5f66-4e7b-9829-36a9a044ab9d/7b96bae8-e506-470d-9fe4-89db367eda0f",
        "content_id": "ee6a63c2-23d5-428a-9e3b-6d8a30702e4f",
        "document_type": "sit fames in, sem vel dolor dolor molestie Lorem vestibulum. netus et Quisque Ut lorem Aenean ac Mauris ipsum nibh elit. consectetur tempor vel porttitor cursus sagittis amet, imperdiet Pellentesque purus ac non Sed risus bibendum. pellentesque sollicitudin adipiscing Ut interdum. libero. at Nam est. a tristique Nam eu morbi scelerisque. ac egestas. Suspendisse tristique mauris ac Duis eros. non molestie sed interdum. eu et nibh. senectus nisl tempor suscipit massa finibus, hendrerit, orci risus ultricies leo lectus habitant aliquet. volutpat turpis malesuada",
        "links": {
        },
        "locale": "lt",
        "schema_name": "consectetur amet, ipsum mauris ac Aenean non sollicitudin Quisque et lorem interdum. est. massa dolor Nam bibendum. pellentesque orci Nam nibh. sem Sed eros. finibus, Ut malesuada eu Suspendisse suscipit Pellentesque sagittis leo lectus nisl Duis imperdiet nibh risus senectus vel porttitor interdum. et elit. a vestibulum. adipiscing scelerisque. aliquet. molestie non tristique tristique sed dolor volutpat purus habitant hendrerit, vel Lorem Mauris ac tempor netus ac cursus",
        "title": "consectetur a interdum. et Aenean lectus imperdiet lorem sollicitudin et scelerisque."
      },
      {
        "api_path": "/f5ce45c9-55ab-4cd6-b17a-6b31b971be66/66ed8e5f-d524-48a7-98fc-d2e2d96113e5/510d5919-0c31-4bc0-9066-d1e90afe7063/eacac706-cc4d-4fca-9531-ad6360489c8c/2397b85a-0bf4-4b6f-b6f8-134fbc287f29",
        "base_path": "/58dc2175-af7d-4785-b4aa-f0237d584d5d/fd435dfe-b071-4951-8478-330ea4569402",
        "content_id": "ac704b7b-474a-4e76-8b55-5db6eef179e6",
        "document_type": "amet, sagittis nisl ac dolor non suscipit et ipsum nibh Lorem senectus lectus egestas. netus non molestie eu scelerisque. Suspendisse est. dolor libero. molestie orci Sed adipiscing hendrerit, habitant sem vel mauris nibh. risus tempor cursus Nam tristique ac risus tristique ac Mauris tempor consectetur Aenean bibendum. vestibulum. Ut ac Ut Nam interdum. et eu elit. ultricies eros. Pellentesque sit in, vel porttitor sollicitudin interdum. massa at aliquet. Quisque leo sed imperdiet turpis pellentesque Duis a malesuada volutpat finibus, fames purus",
        "links": {
        },
        "locale": "zh-hk",
        "schema_name": "pellentesque leo sagittis ac adipiscing suscipit non orci est. vestibulum. Lorem scelerisque. libero. et eu cursus Nam nibh dolor sit sem habitant consectetur malesuada amet, nibh. Nam elit. sollicitudin Ut eros. imperdiet ultricies vel et ipsum lorem massa ac tempor Ut purus volutpat turpis morbi eu Aenean Sed non risus sed fames tristique vel a egestas. finibus, Mauris molestie dolor ac interdum. risus netus Duis bibendum. mauris ac in, senectus interdum. porttitor lectus tristique Suspendisse tempor nisl Pellentesque aliquet. hendrerit, molestie Quisque",
        "title": "pellentesque senectus imperdiet habitant dolor malesuada tempor lorem non massa sem Ut sed interdum. a"
      },
      {
        "analytics_identifier": null,
        "base_path": "/6472f3f2-58ed-452a-bde4-7ca78bb0a3b3/61a9d0c5-b8e3-493f-b147-c8d811aa3940/e3bf35c6-58f4-4ee4-8148-11e24d352894/4a7a8fe8-13f7-498f-9ec0-7217b0464940",
        "content_id": "908116cc-0fc9-4615-a55d-851d82d2f993",
        "document_type": "est. Ut nibh. vestibulum. tristique eros. morbi sagittis porttitor mauris hendrerit, molestie Pellentesque et ultricies tempor Suspendisse in, non Quisque elit. purus sit finibus, ac cursus interdum. sed Nam netus ac scelerisque. dolor turpis imperdiet Sed at nisl et nibh fames risus lorem malesuada a tempor molestie Ut vel ipsum consectetur senectus libero. Mauris Nam Aenean interdum. ac Lorem non habitant suscipit",
        "locale": "hi",
        "public_updated_at": "2018-05-07T21:10:02+00:00",
        "title": "nisl nibh hendrerit, risus adipiscing at molestie tempor elit. tristique Nam massa risus Ut Nam ac tempor volutpat Lorem non amet, suscipit Suspendisse nibh. Sed habitant purus leo pellentesque aliquet. sit interdum. sagittis bibendum. Pellentesque ultricies consectetur morbi dolor senectus Ut eros. ac Aenean egestas. fames vel scelerisque. lectus orci finibus, molestie turpis Mauris est. mauris lorem dolor eu netus vel ac tristique et sed porttitor ac eu vestibulum. non sem libero. imperdiet in, et Duis interdum. Quisque sollicitudin a malesuada ipsum cursus"
      },
      {
        "analytics_identifier": null,
        "api_path": "/3edc4ff5-954c-48d2-bd1a-50d2b35381a9/89e71eb7-d511-404f-8e74-f633f08194e0/57e78757-8302-4671-9b39-a401f1bb99fb/85d53c2c-5f5a-4a99-86e4-5b9be74d7ce0/9ac2d129-cc64-453d-b6db-eedb1bd6288f",
        "base_path": "/b514ed64-6588-4d21-8028-a379723879a2/4a182e6f-e436-41d6-9743-f883767c1bfb/9cd7d842-49a2-45c9-8eab-67fbb17cc64c/3add103c-5fa4-46d9-8db2-d4a40295ca53",
        "content_id": "337d1986-459d-45d3-b5f7-e26bfa3b6a7e",
        "document_type": "malesuada ac vel non adipiscing Aenean netus tempor molestie elit. sed Nam hendrerit, risus purus consectetur tempor sollicitudin a cursus sem Quisque",
        "locale": "ka",
        "schema_name": "sit in, interdum. nisl netus eu dolor Nam non Aenean consectetur eu libero. turpis tristique habitant Duis leo nibh. Mauris Suspendisse orci ac dolor malesuada sollicitudin et nibh morbi porttitor Sed lectus suscipit lorem elit. est. risus cursus Quisque Nam non at Ut tempor ac vel mauris",
        "title": "sem egestas. consectetur nibh.",
        "web_url": "http://example.com/85169732-a419-40a4-8653-c8477d3b36ca/eb491fc1-fe84-4bec-b58b-11586be055e3#238e7c4f825036257be33da5ca217f61"
      },
      {
        "base_path": "/00a9176d-0a37-4666-be67-1b84bff649f1/e36ea79a-846f-4875-b3c9-9dce0579fe7e/5089c41f-a4a9-4b16-ae6b-58180cf75fc9/dcecf6e1-24db-49c9-8f68-c7f731d15acc/1a43af6b-2715-4769-9f61-2328b086d7d1",
        "content_id": "1fe9aef9-1472-4f18-8947-1657036b071d",
        "document_type": "nibh. nisl risus finibus, Ut tristique interdum. molestie sed Duis in,",
        "locale": "en",
        "title": "ac risus sollicitudin Nam Mauris malesuada eu purus Sed vel nibh. cursus habitant ac Pellentesque sit tristique ipsum lorem adipiscing amet, vel et sagittis netus Lorem pellentesque imperdiet volutpat fames ultricies vestibulum. est. elit. egestas. sem non suscipit nibh leo Suspendisse Quisque massa Aenean interdum. consectetur ac Ut ac Ut dolor",
        "web_url": "http://example.com/bdd7a8f2-a37d-4e06-a8dd-d7df569736e3/093bc054-6ee4-463e-bf31-1b95162d45de/1cafd8a7-ed57-4c2c-b4b2-91c4bb201ce7/193713ea-43f4-490d-ba85-78460f9d1767/e526e053-541c-45c0-a641-ddb0872e9d8a#eb3e1573feb814dbad85c6c7c38a0fc4"
      }
    ]
  },
  "locale": "cs",
  "navigation_document_supertype": "eros. eu non sem ultricies consectetur et Suspendisse amet, ac elit. finibus, ipsum Lorem Nam purus risus Nam mauris tempor pellentesque sit aliquet. imperdiet ac bibendum. a scelerisque. non vel in, senectus Aenean leo et libero. orci adipiscing Sed risus tempor porttitor Quisque molestie sagittis malesuada hendrerit, interdum. molestie sed suscipit netus lorem interdum. nibh lectus est. morbi at fames vel massa sollicitudin cursus tristique ac habitant tristique nisl Mauris volutpat vestibulum. Pellentesque egestas. turpis Ut dolor",
  "phase": "beta",
  "public_updated_at": null,
  "schema_name": "redirect",
  "search_user_need_document_supertype": "eu libero. sit a in, nisl non egestas. et tristique risus Nam Suspendisse bibendum. malesuada ac consectetur est. at dolor et scelerisque. interdum. Lorem aliquet. leo Nam imperdiet Ut Quisque sollicitudin interdum. vel elit. Pellentesque cursus Aenean Mauris non purus ipsum morbi sem turpis ultricies amet, nibh Ut volutpat mauris pellentesque ac eros. sagittis tristique nibh. senectus porttitor netus lectus ac orci suscipit eu hendrerit, finibus, lorem ac tempor adipiscing",
  "title": null,
  "updated_at": "2018-05-31T00:55:44+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, 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": [
      "b8e88cf7-ce6c-4a2f-9ede-72bc59e19e69",
      "c9391177-4b8d-4343-aab2-16214ff5762a",
      "baf01b4f-e198-47d0-a798-2eb38c0f230c",
      "69bd7f50-88b5-4e55-9119-49cc79ac7a51",
      "19686b26-87ba-4d11-9476-1321a829e447",
      "11639ce9-4a3f-4534-ac11-60fa583abc71",
      "0ca377d3-f978-4040-86a5-e641d2cfe109",
      "f6b42f96-3100-4615-995b-b1cfda945ba4"
    ]
  },
  "analytics_identifier": "Sed",
  "base_path": "/939a0037-3177-4d42-bc96-7ebc4e23decf/efd31f5e-c966-4780-9b7d-a6766e58d1b7/7fe2bc5a-0230-4d06-88f1-f468f58ce520",
  "change_note": null,
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "links": {
  },
  "locale": "pt",
  "need_ids": [
    "ac tristique est. non Ut ac Nam Duis in, hendrerit, vestibulum. ultricies ipsum consectetur et Pellentesque scelerisque. Nam amet, Suspendisse volutpat netus risus adipiscing eros. dolor molestie Mauris finibus, pellentesque non Lorem et ac interdum. habitant tempor tempor interdum. bibendum. senectus suscipit molestie malesuada aliquet. risus sollicitudin eu leo turpis libero. cursus morbi lectus egestas. Sed purus vel at imperdiet porttitor orci vel tristique dolor eu nibh sagittis nisl Ut massa ac sit sem sed",
    "tristique molestie eros. tempor ipsum sem vestibulum. sagittis et fames finibus, adipiscing elit. Quisque a nisl Pellentesque nibh cursus sed ac hendrerit, massa dolor et vel netus Aenean ac at vel dolor in, non Duis imperdiet volutpat nibh. Sed eu Ut Nam ultricies sollicitudin Suspendisse morbi",
    "cursus risus Suspendisse sit ultricies vestibulum. at amet,",
    "imperdiet tempor molestie in, malesuada a orci at Duis bibendum. Nam ac senectus scelerisque. ultricies egestas. amet, Sed Nam non interdum. eros. nibh. nisl turpis ac molestie tristique dolor leo hendrerit, ipsum eu consectetur sagittis morbi Mauris volutpat cursus finibus, risus sem Suspendisse fames Ut porttitor sollicitudin risus et ac est. nibh sed mauris pellentesque sit tristique netus vel vestibulum. Aenean massa dolor purus vel interdum. suscipit ac Ut Quisque habitant libero. adipiscing elit. et Lorem eu tempor non aliquet. lorem Pellentesque lectus",
    "",
    "fames et habitant interdum. tempor Nam a lorem molestie finibus, amet, imperdiet ac egestas. molestie interdum. Aenean ultricies nibh. sem volutpat bibendum. Ut sagittis morbi suscipit turpis ac pellentesque risus vel eu eu vestibulum. netus est. sed et ac mauris senectus Lorem non orci Suspendisse consectetur purus Duis Nam nisl aliquet. leo dolor Ut massa dolor scelerisque.",
    "elit. tempor Nam in, ac Quisque sed dolor interdum. nibh ultricies a egestas. sem Ut ipsum volutpat Mauris sit sollicitudin vel adipiscing tristique Pellentesque molestie nibh. vestibulum. fames aliquet. porttitor lorem malesuada eu risus Ut habitant dolor Aenean amet, tristique vel non et massa ac morbi at purus non Duis Suspendisse consectetur turpis tempor orci est. eu ac imperdiet eros. risus Lorem hendrerit, suscipit Nam libero. interdum.",
    "pellentesque tempor interdum. nisl scelerisque. vestibulum. egestas. massa et non ultricies risus amet, purus aliquet. hendrerit, ac eros. at habitant nibh tristique ac cursus suscipit consectetur tempor Aenean morbi sollicitudin risus libero. Pellentesque molestie finibus, adipiscing sem ipsum a malesuada imperdiet Ut in, molestie leo nibh. lorem Sed mauris Nam est. ac Mauris interdum. Lorem sagittis ac tristique porttitor et orci fames Nam vel volutpat elit."
  ],
  "previous_version": "sit interdum. netus est. ac amet, lorem eu vel ultricies Mauris molestie ac habitant sollicitudin vel non turpis Ut Duis libero. molestie Suspendisse et nibh at mauris fames massa sem porttitor nisl interdum. senectus Quisque eros.",
  "public_updated_at": "2018-06-07T19:17:23+00:00",
  "publishing_app": "calculators",
  "redirects": [
    {
      "destination": "https://xsydb.qbtl.gov.uk/1b638138-6c12-428b-85de-0a5eba3e4b15",
      "path": "/4107ea71-826c-426d-a6cc-4bd82e471755/919fee7f-3184-4aac-9bf8-2ae69c4c90f7",
      "segments_mode": "ignore",
      "type": "prefix"
    },
    {
      "destination": "https://idhzowny.sbhqp.vpgchbnd.gov.uk/43a46a73-7008-443e-a7ff-e807a371fa93",
      "path": "/e568027e-b050-4cf9-b015-fd9eed527e19/4bdc7784-eee9-4002-b589-5639def913a1/154015d7-687e-4595-bf02-4ea49ea5115e/40db0976-09c9-4c2b-b87a-1c17e9ed5d73",
      "type": "exact"
    },
    {
      "destination": "/40ab0a78-169f-4cda-886d-c26dee0c6dbf/6bbeb676-54c0-4e2f-b149-d249eb85aa4b",
      "path": "/b2e5aad7-d96c-4440-bd0f-da2759eccceb/e391df12-6c15-4b94-9328-94c2ef45b2e4/9b104eee-9308-43bd-9016-02a7648e30a9/62ea0694-62c4-4c98-a196-b2468fdc2f1f/24edba8c-cee7-4176-acf5-c84673694c8f",
      "segments_mode": "ignore",
      "type": "prefix"
    },
    {
      "destination": "https://vyifqhe.cfbie.knb.vzhojl.gov.uk/245e2d31-bc10-42fb-a928-e1cb57d53010/93c9f7b3-b8f1-4fc6-a418-e5e91ef14c01/c7c863f0-a685-468a-bbcd-90a028bac112/f03c802a-b553-4ffc-b74f-837229f59222/a3451b64-d799-4702-b310-fff1e9d512bb",
      "path": "/fc3479b3-2a2c-46a2-bedb-d1f6750330e5/d0bec4b2-6d6c-41da-8cdd-3dab1fa5a4d0/e40c6b4c-e7d9-4c0c-9e0d-45a250ca5342/0e33a541-70ee-4b0c-b3d6-e8c738148cd2/65026834-ea1b-4f20-bc02-05958fdb92d6",
      "type": "prefix"
    },
    {
      "destination": "https://slrap.xglj.ljndpzu.sidzu.gov.uk/f42416db-7aca-4a85-92fd-39bc1aace77d/4a74f511-2088-4ecb-8619-c3acc8c3212c/b5f9955e-aae9-4cea-af9b-aad358f73397/8bf6c258-b96f-431b-8401-29e82c62c1fc",
      "path": "/e3ac9b21-e4e1-4ed3-b569-73e3482a9060/fec6e438-b159-4bfe-9efe-309042cee09e/879c3234-982b-49ae-9981-5ea042333a6a",
      "type": "exact"
    },
    {
      "destination": "/10652217-b8df-4689-8d6b-5c7a6dea6e91/e4f01a5c-f329-41f1-a6ed-f168a362a454/e9315a4f-fe75-4a12-b293-6742d47378f2",
      "path": "/e71e415d-bc09-443c-95ab-f2a996b63db6/b62a084e-b4ff-4e17-bc77-225d6d526415",
      "segments_mode": "ignore",
      "type": "exact"
    },
    {
      "destination": "https://bhr.ibupszg.blsqmpvr.udcfam.gov.uk/f552699c-a624-42d4-9710-641103355213/4ace24e2-3b87-48f9-88c2-8228efface37/4adbcf4b-d40b-4fb8-ad6a-545070f097af/a36cc75f-7179-4a20-8b67-3da9ca8c4a68/6872e738-9712-4e86-8446-c080a581cad2",
      "path": "/852b5100-7c59-46e3-a127-2843a2a6189f/b0df74ce-fd9a-4329-bdc3-281912986588/2c5a96aa-4e36-422b-8cf8-596e44bc6f24/3e5da365-7e75-4181-a84a-5bf7b05ae9d3/18473e29-991f-42fa-adee-89bd9cd0e8a9",
      "type": "prefix"
    },
    {
      "destination": "/2f290d31-f74a-4080-b297-39bdf7ae15dd",
      "path": "/3dabd96d-4e1b-49f1-9e37-76772dd87813/b8bfa85f-7200-4f4f-8282-a170dc8c1768/2929322a-d125-4196-9185-4afce7477ac5/9e83d8a8-dea6-42e2-a249-3ca875aa8eeb",
      "segments_mode": "preserve",
      "type": "exact"
    },
    {
      "destination": "/8f349f8f-3c38-4752-b41e-a0be5ccecf23/be8172f0-5231-4ecf-804c-5a8c48e570c3/0f34e6d3-ef1c-472f-99cf-6c2c1ec7c4dc",
      "path": "/ed58e755-f653-4118-810d-d61e68f4516c/f8bacc04-a2d8-40f1-aa86-bd027107f839/2cec71f3-9a54-440a-9835-0cbbfeaf0cb9/c87aff4a-e99d-4966-b875-134a3192b614",
      "type": "prefix"
    },
    {
      "destination": "/e50190df-84ba-4b9e-b5ec-4e20b40c6169/0634555c-0311-400d-95b6-290fe22fa300/eee682cf-1db6-4704-b876-fbf679aa5f66/9bb9a4b9-d72e-49ab-b153-4e7f269e9cf2/810e944c-9195-42d4-91f4-220863e4abda",
      "path": "/9d8bd279-a6cd-4b1f-83da-e0e1502869d9/018989ad-965b-4d53-90a2-b24fb5833307",
      "segments_mode": "preserve",
      "type": "prefix"
    }
  ],
  "rendering_app": null,
  "routes": [
    "Nam molestie eu interdum. Duis morbi Lorem risus hendrerit,"
  ],
  "schema_name": "redirect",
  "update_type": "major"
}

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": {
  }
}