Skip to main content

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

description
null

details
object
document_type
string

Allowed values: redirect
first_published_at
or null

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
ministers
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
role_appointments
Link type automatically added by Publishing API
secondary_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, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, ne, nl, no, pa, pa-pk, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, yi, 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
public_updated_at
or null

publishing_app
string
The application that published this item.
Allowed values: account-api, calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, government-frontend, hmrc-manuals-api, local-links-manager, manuals-publisher, maslow, performanceplatform-big-screen-view, publisher, rummager, search-admin, search-api, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, special-route-publisher, 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
title
null

updated_at
string

withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": null,
  "base_path": "/feb8cab4-bdc2-17e6-a7a8-c0fea6ef5174/495505b4-b90c-1df5-aa4b-3adeae7bad5e",
  "content_id": "33cd8e6c-bd31-1c34-a50e-6dda3ce6e5d3",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "links": {
    "available_translations": [
      {
        "api_url": "http://example.com/5d8dd045-efb2-1ef9-af0c-41d942c3c7a3/aaec3f6a-54b4-1aad-a1d7-1e255db6904a/8fcd3d49-c28c-122a-a92c-feaed226c5a2/1eaedea1-1fb7-13de-a1b3-e6f10367a481#6aaa975c68",
        "base_path": "/3f59a6a7-b3dc-1db4-af55-fb35efc31bec/eab9bf06-ff1c-1be9-a1fa-7fb2e45e8c0c",
        "content_id": "a7ba47b7-eeee-12cf-ab5f-e9d0a6be2a4b",
        "locale": "ne",
        "public_updated_at": null,
        "title": "dolor molestie Pellentesque leo purus risus lorem porttitor Quisque nibh tempor Suspendisse molestie interdum. ac netus suscipit vestibulum. vel bibendum. malesuada ultricies Nam a sagittis ac Aenean ac tristique elit. est. at Ut imperdiet scelerisque. adipiscing Nam mauris morbi cursus Mauris volutpat egestas. et eu non orci habitant Sed interdum. turpis sollicitudin sem fames in ac nisl non nibh. ipsum Lorem finibus massa pellentesque sed aliquet. Ut tempor Duis senectus tristique",
        "web_url": "http://example.com/f34aa412-fe8f-1a0f-a5b7-a036b2feaf16/0e5ccd35-f122-1f6e-ae24-acceec0d92e3/e00ebf90-59ff-13c0-a545-3e5d2bdac45e/b9615ec3-0927-13c5-a3f7-e17a36e4286b#4c5ab17bd6"
      },
      {
        "analytics_identifier": null,
        "api_path": "/ec0fce93-f3f2-1f3b-aee1-a6eb9a98d966/8d0f59fe-baff-1b57-ad62-fabc497bfff6/d046c01c-698a-1ecd-ad72-5fd5ad895fff/ef4e34a9-decb-19a9-a629-8a6ec12e7f99/c8c0172a-c621-188f-a7e0-010112a247bb",
        "api_url": "http://example.com/f5f8d99b-01db-19f0-a03f-7da56b0d70eb/ae0273bb-d335-10ab-ac1e-52dd6ee32cbc/d3a0589e-a400-1e0e-aed3-109df8c9db45#7df976231f",
        "base_path": "/1a430a10-ad17-10a2-a65e-b47e0de0aa00/95eeaedf-7aec-10b6-a2fd-ebfd5c3a9d81/f3429cca-36e4-1099-a0aa-d62763f5dce8/b2613a18-625d-1cc2-a094-a90cec76dade",
        "content_id": "e7bd2c4d-8b6b-1696-acb7-d8dacd7be5c6",
        "document_type": "dolor interdum. molestie est. habitant vel mauris sem senectus scelerisque. molestie non cursus consectetur Pellentesque morbi nibh. eu pellentesque ac at sed",
        "links": {
        },
        "locale": "ta",
        "schema_name": "bibendum. tristique finibus molestie vel molestie interdum. in Quisque aliquet. interdum. Aenean tempor et senectus suscipit scelerisque. lorem non fames leo hendrerit sem Sed Nam vestibulum. Ut pellentesque Ut mauris purus nisl dolor eu habitant consectetur ac Suspendisse non Pellentesque a amet ac netus nibh malesuada sollicitudin massa dolor porttitor est. risus ac Nam ipsum vel nibh. volutpat orci ac elit. cursus sit libero. at sagittis risus imperdiet eu tristique",
        "title": "sollicitudin pellentesque molestie Aenean fames Mauris hendrerit orci sit ac risus non amet ac et volutpat risus interdum. vestibulum. Pellentesque Ut netus egestas. vel Lorem mauris Nam ultricies Ut interdum. scelerisque. lectus nibh. est. Quisque lorem aliquet. sem turpis suscipit purus tristique tempor sagittis morbi nisl ac at imperdiet Sed et eros. bibendum. non Duis vel Suspendisse libero. cursus finibus eu eu Nam a sed consectetur ipsum massa tristique elit. leo dolor senectus malesuada nibh habitant adipiscing dolor ac porttitor tempor molestie in"
      },
      {
        "analytics_identifier": null,
        "base_path": "/bb4652ab-daec-15f7-ae13-7bf81e302370/eddb31bb-f9af-1b31-a0bb-9ffc1adffb6e/e5bb70bf-bc0a-11b7-afc9-a084effefe4e/664c5776-39fa-1693-afde-33ee495b0ca0/01cd5eaf-dfce-14fb-a307-bef7cbdacb95",
        "content_id": "c9b6765d-caad-1173-ac36-9304f2b8bfcc",
        "document_type": "nisl Lorem elit. ac tristique dolor sagittis vel non Ut interdum. consectetur sollicitudin aliquet. est. ipsum purus adipiscing leo molestie Pellentesque sem in vestibulum. Ut",
        "locale": "uk",
        "schema_name": "Ut morbi orci leo tempor Nam eros. hendrerit volutpat consectetur lorem vestibulum. Quisque adipiscing cursus Pellentesque nibh sagittis Lorem netus est. malesuada sem non ac non ac turpis et dolor Suspendisse eu mauris et porttitor vel interdum. purus habitant at egestas. interdum. ac Ut suscipit bibendum. sit sed libero. Mauris in risus tristique a dolor risus aliquet. tristique imperdiet Duis senectus nisl amet molestie tempor eu Sed",
        "title": "porttitor cursus Quisque non ac molestie egestas. nibh eros. habitant malesuada et vel Nam imperdiet purus risus non aliquet. a ac sit est. ac dolor tempor sed Ut Sed ultricies libero. risus elit. nisl turpis Lorem senectus eu Ut eu volutpat nibh. tristique netus suscipit finibus molestie lorem Pellentesque adipiscing interdum. Duis sagittis hendrerit lectus ipsum"
      },
      {
        "api_path": "/376e8ff0-aa85-1bfd-aac1-fa1005d888e9/ead6bb00-dfee-15ef-a712-4dc2cffdbeff/a15ff975-cfb0-1e17-aabb-fb0be6d68040/dd6e7bf3-6c65-1829-a9f4-e4f09a1c07cb",
        "api_url": "http://example.com/ab9caf46-45f9-1ca1-ad94-177bd0de5a4f#b7e40cb8cc",
        "base_path": "/fdededdd-9fcc-1c6b-abc3-de33a0ebbd30/c4a65932-1dfd-1264-a7ea-8cc0d06cf6d6/75fcf485-d927-16f2-ab4b-11d39a48920b/0db912ad-772f-1529-abb6-d1fb52e57f2a",
        "content_id": "f50d9b35-b7c7-1eac-a797-1ac7378ad5e5",
        "document_type": "ac suscipit ac sollicitudin Pellentesque Ut sit a Quisque imperdiet nibh leo senectus nibh. cursus molestie egestas. consectetur eros. at aliquet. molestie sem dolor adipiscing purus vel amet Sed in Duis finibus Ut dolor fames est. Aenean morbi tristique orci netus sagittis risus risus turpis lorem volutpat scelerisque. interdum. ultricies eu ac ipsum malesuada hendrerit vestibulum. tempor bibendum. Nam lectus Suspendisse porttitor et eu Nam vel ac habitant et libero. mauris massa tempor",
        "links": {
        },
        "locale": "tk",
        "public_updated_at": null,
        "schema_name": "Quisque Nam libero. vestibulum. sit eu interdum. sed Ut risus in elit. at eu sem et cursus pellentesque hendrerit ultricies senectus",
        "title": "non suscipit imperdiet Suspendisse hendrerit Nam lectus ac Ut sit nibh. libero. bibendum. ac pellentesque tempor a nisl vel purus consectetur eu ipsum sagittis dolor sem turpis risus dolor interdum. netus at et interdum. molestie lorem vestibulum. ac orci in vel aliquet. non tristique Lorem Ut Quisque tempor porttitor Pellentesque massa finibus risus senectus cursus egestas. sollicitudin fames habitant elit. tristique amet est. Nam ultricies mauris scelerisque. leo Sed malesuada volutpat eros. eu Mauris ac nibh sed molestie morbi et adipiscing Aenean Duis"
      }
    ],
    "child_taxons": [
      {
        "analytics_identifier": null,
        "base_path": "/83cb249f-a4d8-1150-a0e8-fe22fcb4ded7/c49b3c68-fc9f-1fd3-a3f5-e6ac304039c9",
        "content_id": "0a46ad30-bf6f-1e6c-a3b0-fd3689bfe639",
        "locale": "uk",
        "public_updated_at": null,
        "title": "ac tempor Ut tempor nibh bibendum. purus hendrerit consectetur Duis suscipit massa Lorem ac elit. nibh. eu habitant amet Quisque lectus cursus scelerisque. libero. fames lorem ultricies eu et at aliquet. interdum. molestie Sed dolor pellentesque mauris sem risus non vestibulum. turpis vel molestie Ut morbi imperdiet est. sagittis leo senectus Nam sollicitudin tristique vel sed a non finibus et sit nisl Aenean ipsum egestas. dolor Mauris Pellentesque"
      },
      {
        "analytics_identifier": "pellentesque tempor ac Quisque Lorem in mauris sollicitudin libero. netus ac porttitor ac molestie eu adipiscing sagittis fames dolor Sed egestas. aliquet. habitant et volutpat Duis eros. non molestie vel interdum. dolor morbi at consectetur Ut nibh. turpis ultricies nibh non malesuada ipsum elit. vestibulum. Aenean suscipit tristique sit sem Nam Mauris senectus et sed Pellentesque amet a Nam Suspendisse hendrerit est. interdum. cursus scelerisque. lectus ac lorem tristique Ut imperdiet finibus eu bibendum. massa vel orci risus nisl leo purus tempor risus",
        "api_path": "/f5cbbe13-3865-1bc6-ac8f-a25b1d236b8b/ee8e61ee-cf21-1c8f-adf9-cd0c7497fd44/3fffe32b-a0cd-1fa9-a9c7-6fbc0d26e72a",
        "base_path": "/a97cfee6-ada5-1ffb-a0fa-b7e75d986c24/02caaecb-c058-1839-aeec-fbe48a7d76a2",
        "content_id": "6c4a97db-1cc6-1829-a64a-bc5b62906fd7",
        "document_type": "molestie Ut dolor a risus tristique et lectus sollicitudin in scelerisque. libero. nisl elit.",
        "locale": "zh",
        "title": "lectus tempor at malesuada Ut imperdiet libero. vel non tristique Suspendisse Mauris ultricies adipiscing a purus pellentesque nibh aliquet. habitant egestas. interdum. sollicitudin Quisque Nam Ut",
        "web_url": "http://example.com/3aa04c51-eb0a-1469-a193-ef9e5c120e3d/f85cfbdc-8e2a-19bd-a50c-acdfbf0e7e12/f3aabc87-d9fd-135f-aa3c-000b96b2b598/054ac93c-eb85-1d66-a4a9-e05f3b9fabee#e5ffe47f5a"
      }
    ],
    "level_one_taxons": [

    ],
    "part_of_step_navs": [
      {
        "api_url": "http://example.com/336c4428-e2cc-18ae-af1b-85b407596efd/9aaf6be7-ca4f-13b5-aa35-ce9d2fdd6f3f#6e5bbdcfc7",
        "base_path": "/d6e9107d-5492-1fcb-a1ee-c6bdfd4aaa5f/c5cf022d-2caa-1b7f-ad15-8df6f2d45ac7/f29dfa6d-5fe1-140f-a0b7-f53a24b90bde",
        "content_id": "8a31560e-347c-152f-a351-f566aaba769c",
        "document_type": "amet leo Nam Ut libero. et Ut in eu molestie tristique lectus non bibendum. purus lorem nibh. imperdiet orci massa morbi hendrerit tristique vestibulum. et interdum. ac Lorem a sem nisl at sed habitant",
        "locale": "gu",
        "public_updated_at": null,
        "title": "eu amet Nam Nam sollicitudin ac ipsum ac Suspendisse sagittis dolor tempor suscipit consectetur Mauris Ut aliquet. orci hendrerit Duis pellentesque netus interdum. cursus sem a volutpat nibh. senectus porttitor scelerisque. vel leo Quisque interdum. Pellentesque est. eros. tristique Ut finibus vel adipiscing bibendum."
      },
      {
        "base_path": "/79aec730-e9fb-17fa-a34a-b04baf69d739/59cc5b09-30f0-1632-a05b-f0c58657c71a",
        "content_id": "b8affe8a-accf-1fb2-aefd-5233bfeb1aff",
        "locale": "pl",
        "public_updated_at": null,
        "title": "Nam bibendum. Mauris ultricies ac nibh."
      }
    ],
    "related_to_step_navs": [
      {
        "api_url": "http://example.com/daf2ba67-a9c7-19e9-a398-99c0c1fd227d/59a177f2-863d-171a-a4aa-e41d7a1afaff#5f43c8bb8e",
        "base_path": "/8a2122ac-de1a-11dc-ac46-3da42a7ac4cc/557fa9f0-caca-13ba-a70d-aab3292dc233",
        "content_id": "1f329dc0-ce14-1596-ab61-c994eb7960ef",
        "links": {
        },
        "locale": "lv",
        "schema_name": "ac Nam vel elit. eu netus tristique libero. Sed leo aliquet. purus dolor eu Duis ac Suspendisse egestas. massa nisl scelerisque. non finibus sem Ut ultricies morbi ac suscipit pellentesque tempor adipiscing consectetur Pellentesque Nam eros. vestibulum. lectus habitant et turpis tristique interdum. fames risus molestie malesuada non a Mauris sed ipsum Aenean Lorem Ut hendrerit in sit tempor nibh et amet nibh. cursus molestie mauris interdum. vel senectus imperdiet sollicitudin lorem bibendum. dolor est. sagittis ac risus at orci volutpat porttitor Quisque",
        "title": "ac et egestas. et suscipit ac amet Lorem ipsum sed Nam Suspendisse hendrerit malesuada sem dolor non Nam sollicitudin cursus nibh. Pellentesque molestie scelerisque. vel pellentesque orci bibendum. at risus sagittis risus massa vestibulum. Ut adipiscing molestie lectus aliquet. lorem imperdiet est. tristique nibh tristique turpis interdum. porttitor"
      },
      {
        "api_path": "/a31fb473-b9a7-1179-abe5-ed2a2c692d37/cbee14c2-a28d-14db-ad9a-c7f4616f5dcc/f44befce-c08b-1eec-aad3-02d7c0984efe/f434dc6d-89eb-1b85-ae5e-7b06eb17f22b",
        "api_url": "http://example.com/dab9486a-317f-1ba7-a459-2f614eca3577/ba8453c2-47ce-1ae3-ae58-94400d51ddc5/322b0f0e-c5b2-165e-a2d7-9a494fead34e#8bfc60dae6",
        "base_path": "/f4fcaab0-c2ec-1bcc-a9d3-3dbfbeb66ccb/735ae0cb-ae7a-1dd8-a82a-eeaa94f41fd0/1dc800df-38a4-13dc-a429-b46cd86bcfd2/4ff0ddd0-da8f-19c6-ae3d-c35bd343bec7/8b8f143b-fc55-1e9e-aa1c-cfdab1da99bb",
        "content_id": "876cd20c-f20e-1852-a3e2-18ac2eeaaadc",
        "document_type": "netus ipsum at elit. sollicitudin eros. leo bibendum. adipiscing dolor interdum. est. orci Ut Pellentesque dolor vel scelerisque. Nam cursus Suspendisse risus morbi et nibh nibh. non tempor sed nisl lectus mauris sem massa libero. tristique et ac tristique lorem interdum. pellentesque risus Quisque senectus hendrerit vel molestie suscipit sit Nam malesuada in finibus a Aenean ultricies tempor Lorem habitant eu imperdiet egestas. ac turpis Duis molestie non aliquet. porttitor consectetur volutpat Mauris ac Sed amet eu sagittis fames vestibulum. Ut purus ac",
        "locale": "uz",
        "title": "sollicitudin senectus nibh. elit. eu adipiscing porttitor interdum. nibh leo ac ac Pellentesque Suspendisse tempor netus non ac cursus nisl risus pellentesque et finibus Aenean lorem tempor eros. molestie Sed dolor Mauris aliquet. purus massa vel volutpat sagittis risus vestibulum. ultricies Duis at et turpis in amet tristique libero. habitant morbi non ipsum eu mauris Nam tristique molestie suscipit a Lorem fames dolor sed interdum. Ut Nam hendrerit Quisque lectus scelerisque. est. Ut egestas. malesuada bibendum. sit imperdiet ac consectetur orci vel sem",
        "web_url": "http://example.com/0cba9e6a-25c2-10fd-aa5e-7c3ed1b8efbc/ec5795f6-26e4-18ce-aa2f-a9c5bdc4828c/457b6877-df06-1d8d-aa73-7c4cbd87fabe/b6a9bc0f-a1e3-1a92-a54c-e8ea2a2e8e28#c782a50b5c"
      },
      {
        "base_path": "/209e2abf-bd81-18fd-ad84-25a667fa7648/3e112f2d-f4b2-118a-ae34-f0afc03d5b0d",
        "content_id": "f6bc07fe-e4fd-1791-ac3f-05b3ad80723d",
        "links": {
        },
        "locale": "hu",
        "public_updated_at": "2013-04-06T21:24:24+00:00",
        "title": "lorem ultricies senectus Duis vel sollicitudin turpis hendrerit eu et vel ac massa nibh at ac Mauris morbi Suspendisse mauris molestie orci adipiscing interdum. ipsum risus tristique molestie consectetur aliquet. sed Aenean Ut non Quisque fames tristique leo Lorem sit risus egestas. suscipit dolor ac dolor imperdiet in Pellentesque pellentesque Nam malesuada finibus elit. habitant Ut a ac non porttitor Nam vestibulum. tempor nisl scelerisque. cursus est. volutpat sagittis nibh. interdum. netus Sed bibendum. purus eros. lectus eu"
      },
      {
        "analytics_identifier": "amet tristique ac bibendum. Pellentesque imperdiet sit vel fames dolor eu Sed porttitor scelerisque. Ut tristique finibus suscipit ipsum non dolor Ut Quisque pellentesque Lorem sagittis ac est. tempor sollicitudin eros. volutpat nibh Nam",
        "api_url": "http://example.com/e6a49ef5-34f0-1b2d-a1d4-c42845156bf2/2e4ddb89-cf65-1e67-a940-20e9216a71c1#eefd7ecd0a",
        "base_path": "/daf0866e-f0ef-1f2e-a53e-1bae647daf1e/07ad4b8b-d486-10d6-a3f7-1daf2c14a8f0/dd95fc32-dcf5-17ba-a301-d6f8aaac3a67",
        "content_id": "bbf4eff3-26b4-12ba-a5a3-71850cd05f81",
        "locale": "cy",
        "title": "nisl amet bibendum. interdum. at ultricies risus non elit. orci dolor ipsum morbi habitant eu malesuada dolor Pellentesque finibus risus suscipit aliquet. Aenean Mauris eros. lectus ac et Nam hendrerit lorem turpis non sit et molestie tempor egestas. vestibulum. sagittis libero. Sed Ut volutpat ac Duis fames tempor tristique adipiscing purus sollicitudin leo porttitor vel mauris eu est. ac in scelerisque. ac pellentesque Nam interdum. Quisque imperdiet tristique Ut nibh. massa",
        "web_url": "http://example.com/7e4d49bf-aebf-14e9-a337-98daeb9aa4f1/107dadab-9eb3-1fa9-abc0-a98f2a471fcc#e6885c148c"
      },
      {
        "analytics_identifier": null,
        "api_path": "/8d97c51f-4636-1cf8-a341-ddd3b538ac97/0fdf14ef-6460-16c1-ab2d-aec16d1891bf",
        "base_path": "/1ac5dfdc-c95a-15b4-a4ac-c9b475ac6284/ced4a334-8566-13db-aff5-069ee3bdbc0e/c5901aa0-8b60-1f5a-aa1c-c64ec7bb108f",
        "content_id": "ea3c2cbc-ab8f-108b-ae5e-7520559cea56",
        "links": {
        },
        "locale": "be",
        "public_updated_at": null,
        "title": "scelerisque. hendrerit Nam molestie suscipit pellentesque non netus sem orci porttitor cursus eu habitant mauris sollicitudin Duis est. massa risus in dolor leo tristique ipsum Ut risus lectus vel sed eros. amet interdum. volutpat a at ac fames imperdiet tempor Nam egestas. bibendum. tempor non turpis nisl vel sagittis Quisque vestibulum. libero. Ut Suspendisse nibh. et ac"
      },
      {
        "analytics_identifier": "Pellentesque tempor sit mauris scelerisque. ultricies nibh. Ut egestas. dolor imperdiet sem ipsum ac tristique ac ac vestibulum. interdum. sagittis cursus Ut massa fames risus a adipiscing lorem libero. Sed Nam consectetur leo",
        "base_path": "/5282357e-89c0-1f3d-aac4-bd99d4ccb58a/3cdbdff5-d8d8-1f89-a7dc-31f2ccaa4eac/3b18f103-648d-12cb-ab56-b4a3c5fc61fd",
        "content_id": "62b108a9-b1ab-1990-a4a5-c4b39c975b8b",
        "document_type": "Duis a",
        "links": {
        },
        "locale": "gd",
        "title": "imperdiet molestie senectus Aenean risus pellentesque Ut sit fames elit. nibh finibus dolor est. interdum. nibh. bibendum. risus scelerisque. tempor sollicitudin vestibulum. eu tristique turpis adipiscing morbi leo aliquet. Nam",
        "web_url": "http://example.com/3fe446b3-feac-1b9d-a707-ce7e2d0dc0be/02a68750-15ca-16d0-ab3b-258f41d4aaa0/65e7f791-b4a2-106e-ac31-eeaf99dcfb6b/ddcaf341-65aa-1139-afc1-dfddf425bdc0/b9ae68bb-2cee-179d-ac01-cc1aa5d8bfca#917e7c87af"
      },
      {
        "analytics_identifier": null,
        "api_path": "/e5e8ecaa-91ba-180a-a923-fd0dadffb6d8",
        "api_url": "http://example.com/d8f945e7-78b6-1ec1-aa25-f62ba29ff0a4#a8fef97fc9",
        "base_path": "/aee7dca1-fba3-1885-a03b-15f9de8d701c/5e914df5-fb37-1c8c-a902-a7e89aa48d91",
        "content_id": "f2a9a586-f0a1-1249-aa6e-51dff75530ac",
        "links": {
        },
        "locale": "si",
        "public_updated_at": "2023-01-27T22:40:47+00:00",
        "schema_name": "risus elit. Ut pellentesque dolor Suspendisse sem",
        "title": "vel risus consectetur Lorem vestibulum. Sed netus ac elit. sem bibendum. in et interdum. turpis ac lorem interdum. risus adipiscing eu Aenean sagittis fames habitant sit nibh. et Nam morbi non ac Nam sed Ut leo lectus amet molestie a non pellentesque volutpat ipsum nisl scelerisque. Duis Mauris purus hendrerit Quisque tempor ac eu malesuada tristique dolor egestas. cursus est. eros. imperdiet finibus senectus dolor Pellentesque sollicitudin suscipit orci vel tristique libero. aliquet. massa Ut at porttitor Suspendisse molestie ultricies tempor nibh mauris",
        "web_url": "http://example.com/c9a64501-c5d4-10bf-a024-a078134aaf60/13546ad0-9e48-1bad-a4b0-15a608bc7ede/48cf0f4d-eb0a-1c46-a57c-825fa274c86e/57dc2ab1-a453-1ced-a5b4-b89bbeb9b70e#8d6cc6b6e4"
      },
      {
        "analytics_identifier": null,
        "api_path": "/afdffdfa-beb1-1af9-a57a-be10fa8a5bdf/ede75bad-e58e-1a6b-ae6c-a3fffbca71c8/2d0ec006-7c2f-1fd0-a778-9baa0faea80a",
        "base_path": "/b0f87efb-acca-18ab-a4d3-5ffd8290990a/c4aacfee-5a73-19cd-ae68-d1c29bbba64a/2327ab39-682d-1d4b-aadc-b70f5429ab8b",
        "content_id": "f698fb93-d69a-11c3-ad76-e089ecbefb6e",
        "links": {
        },
        "locale": "ru",
        "public_updated_at": null,
        "title": "amet tempor turpis molestie hendrerit consectetur egestas. molestie ac non sollicitudin Nam Ut morbi leo dolor nibh Lorem sit vestibulum. eros. in Suspendisse libero. nisl sed Pellentesque porttitor lorem est. et Ut orci a interdum. vel mauris massa ac sagittis fames Duis scelerisque. ipsum dolor adipiscing at eu lectus finibus et bibendum. tristique non Sed senectus Nam interdum. pellentesque volutpat habitant netus risus ultricies risus imperdiet ac tristique",
        "web_url": "http://example.com/d339bc9f-ba0b-1a15-a8f5-479d2c5373cf/cbcb5d0e-066e-1077-aeff-bd4fadd72ea2/25bb09c3-e520-16bf-a64e-4cbd512a51c3/e2b17d8c-c6eb-1b5c-a31f-1b5d6b2aeaab#f6a29c0feb"
      },
      {
        "api_url": "http://example.com/ed1fbe34-729c-1b4f-abbf-846a314ff78b#b2ce8bc28a",
        "base_path": "/cec1239e-ed6f-1da2-afdb-e6c2a4f3cb25/3ac05f2c-dcc0-16e0-ade8-8a9adedd452d/76b7ef9a-feea-10aa-a3cc-9ebd0fd9acb7/cc8c86eb-e26a-1fea-ad8b-deaec7af634f",
        "content_id": "9cabdb2f-f9c9-16a9-ae3a-cfae4dd6d13b",
        "locale": "bg",
        "public_updated_at": "2020-07-22T21:23:04+00:00",
        "schema_name": "netus orci tristique non aliquet. vel pellentesque eros. libero. sagittis interdum. senectus Mauris molestie et elit. sed nisl ipsum lorem sit habitant vestibulum. ac molestie porttitor Pellentesque bibendum. adipiscing hendrerit a dolor dolor ultricies Sed amet nibh scelerisque. sollicitudin et est. eu leo turpis Lorem tempor consectetur risus malesuada Quisque Nam massa morbi Ut",
        "title": "a senectus Duis libero. Mauris lorem Quisque bibendum. eu dolor risus sollicitudin ac Pellentesque malesuada tristique Ut sem amet et vel netus ac non est. nisl nibh. adipiscing consectetur Sed eros. molestie tempor mauris tristique lectus morbi Ut turpis habitant purus interdum. egestas. elit. sagittis sit in volutpat nibh Aenean hendrerit finibus orci fames Nam risus sed vel ac tempor dolor leo cursus Suspendisse ultricies Lorem aliquet. porttitor scelerisque. eu at non molestie Nam",
        "web_url": "http://example.com/2cf5d3fc-0c3f-1a7c-abbb-3dafbf740f06/7d0862ed-8aac-1bbe-a231-93ae62ee260e/81a8e072-29df-1490-ab4c-7ba87cfdae2e#ef972b4fac"
      }
    ],
    "secondary_to_step_navs": [

    ],
    "topic_taxonomy_taxons": [
      {
        "api_url": "http://example.com/def072fb-d514-11a2-a2c6-1b9cc8e0d6f8/cb06e0ab-d1f4-11fc-addf-f5edc6fc2fee#50074fd8fa",
        "base_path": "/bd4b107f-6142-1f1e-ab06-a92e1399f7fd/d3cf9e51-a2df-1e33-af87-7f79c6ee5eee/a68d72fd-d04a-17bf-ad43-4316bfd93a80",
        "content_id": "dfa7a184-3cd7-1b9d-a760-e5cc2dbcacd6",
        "document_type": "nisl sit orci Ut ac imperdiet a sem fames purus bibendum. et libero. Nam ac ac elit. Aenean mauris Ut eu dolor amet lorem Quisque egestas. consectetur Pellentesque porttitor aliquet. cursus Mauris sagittis ultricies hendrerit finibus ac molestie tristique malesuada suscipit sollicitudin nibh. Nam Duis risus in habitant at leo vel turpis non tempor vel non tristique interdum. et dolor nibh vestibulum. pellentesque Sed lectus eros. Suspendisse interdum. sed risus netus senectus Lorem adipiscing eu tempor morbi scelerisque. est. volutpat molestie ipsum massa",
        "links": {
        },
        "locale": "el",
        "title": "libero. elit. Pellentesque Quisque Suspendisse et fames non Ut cursus vestibulum. dolor porttitor Sed malesuada bibendum. lectus pellentesque risus orci sagittis ultricies risus suscipit senectus nibh. tempor hendrerit est. tristique Duis tempor amet leo ac interdum. ac eu purus aliquet. dolor non nisl at eros. imperdiet et Ut"
      },
      {
        "analytics_identifier": "at pellentesque imperdiet volutpat senectus habitant sollicitudin Nam elit. purus Duis ac et eu nibh. Ut fames nibh tempor turpis mauris bibendum. molestie Sed adipiscing",
        "base_path": "/5a387bbc-94ff-1e84-a4fb-9ce2a3fff729/cdc00fd0-9a73-1ecd-ae2a-3dbe8cda96a4/c9931ab8-f0a8-16cc-ac26-87cd8815c49e/3ac74510-8bd2-1b4f-afad-e7fea2939fad",
        "content_id": "dcecff6d-fff8-1d99-a899-cc2db5ebf14a",
        "locale": "uk",
        "public_updated_at": null,
        "title": "et molestie fames Lorem Nam volutpat lectus tempor Duis Ut orci sed scelerisque. eu pellentesque netus libero. ipsum turpis a leo suscipit nibh ac ac Mauris molestie tristique egestas. aliquet. Suspendisse finibus est. bibendum. eu hendrerit habitant et senectus consectetur ac eros. nibh. purus amet at Ut in dolor non dolor mauris sagittis morbi"
      }
    ]
  },
  "locale": "es",
  "need_ids": [
    "hendrerit Mauris ac vel egestas. ac Ut dolor ipsum cursus elit. non scelerisque. Pellentesque nisl risus tristique tristique sed non vel at interdum. eu turpis lectus tempor libero. Nam dolor finibus bibendum. ultricies a massa adipiscing eros. suscipit Duis tempor volutpat consectetur et interdum. senectus mauris purus",
    "scelerisque. netus vel eros. imperdiet sed Pellentesque Nam et Sed senectus tristique orci ac Mauris nibh porttitor nibh. eu Nam molestie ultricies lorem non amet massa dolor adipiscing dolor a interdum. mauris vestibulum. aliquet. vel libero. ipsum tempor morbi purus interdum. sit Aenean lectus turpis ac non Lorem",
    "Ut aliquet. ac consectetur Nam bibendum. non fames ac nisl Suspendisse tristique Sed morbi imperdiet interdum. Aenean egestas. netus dolor eros. sollicitudin turpis vel pellentesque at risus Pellentesque tempor molestie mauris libero. sit lorem malesuada et eu Duis sagittis purus porttitor habitant ac",
    "eu nibh. tempor porttitor Nam lectus egestas. Suspendisse nibh Nam Lorem Quisque a tempor at ipsum Ut sagittis in orci adipiscing et ac hendrerit cursus interdum. Aenean massa",
    "vestibulum. hendrerit ac habitant lectus interdum. bibendum. Ut amet sem finibus suscipit libero. nibh dolor orci ac porttitor nisl ipsum turpis Suspendisse tristique non sed Ut molestie ultricies eu vel elit. eros. Nam scelerisque. eu egestas. Aenean fames Lorem Nam interdum. vel lorem sit cursus ac mauris et Sed Duis adipiscing aliquet. at et leo sagittis volutpat nibh. tempor molestie netus risus tristique tempor dolor Quisque ac pellentesque imperdiet sollicitudin massa consectetur purus malesuada Mauris est. risus a Pellentesque senectus non in morbi",
    "orci risus tristique Quisque est. non imperdiet Pellentesque eu hendrerit suscipit ipsum tempor volutpat lorem et cursus fames sollicitudin morbi malesuada vestibulum. sagittis scelerisque. senectus nibh. ac dolor egestas. risus ac Nam Ut interdum. Sed",
    "Nam vel risus tempor"
  ],
  "public_updated_at": "2016-05-11T10:40:04+00:00",
  "publishing_app": "contacts",
  "publishing_request_id": "scelerisque. elit. malesuada sem habitant a Nam bibendum. ac eu Suspendisse risus ultricies non lorem pellentesque et dolor sit Nam non senectus Pellentesque turpis egestas. massa vel ac Sed finibus molestie Aenean in Quisque ipsum cursus orci lectus tristique tempor nibh fames volutpat mauris at Lorem vestibulum. risus suscipit amet est. tristique tempor consectetur libero. porttitor molestie adipiscing ac ac leo purus interdum. dolor eros. Ut nibh. interdum. netus Duis Mauris et Ut morbi eu imperdiet sollicitudin aliquet. hendrerit sagittis sed nisl vel",
  "rendering_app": null,
  "schema_name": "redirect",
  "title": null,
  "updated_at": "2020-05-19T07:02:20+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
Deprecated: auth_bypass_ids should be sent as a separate field
organisations
A list of organisation content ids permitted access to this item
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.
auth_bypass_ids
array

base_path
string
A path only. Query string and/or fragment are not allowed.
bulk_publishing
boolean

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, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, ne, nl, no, pa, pa-pk, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, yi, 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: account-api, calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, government-frontend, hmrc-manuals-api, local-links-manager, manuals-publisher, maslow, performanceplatform-big-screen-view, publisher, rummager, search-admin, search-api, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, special-route-publisher, 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": [
      "bfeb8cab-4bdc-127e-a67a-8c0fea6ef517",
      "4495505b-4b90-1cdf-a5a4-b3adeae7bad5",
      "ed3cd8e6-cbd3-11c3-a450-e6dda3ce6e5d",
      "3daf01af-d8dd-1045-aefb-2ef9f0c41d94",
      "2c3c7a3a-aec3-1f6a-a54b-4aad1d71e255",
      "db6904a8-fcd3-1d49-ac28-c22a92cfeaed"
    ]
  },
  "base_path": "/8f81eaed-ea11-1fb7-a3de-1b3e6f10367a/4816aaa9-75c6-1813-af59-a6a7b3dcdb4f/55fb35ef-c31b-1ece-aab9-bf06ff1cbe91",
  "bulk_publishing": true,
  "change_note": null,
  "document_type": "redirect",
  "first_published_at": "2023-11-30T11:40:15+00:00",
  "locale": "tr",
  "previous_version": "malesuada non aliquet. interdum. tristique sit nibh. dolor Aenean tempor adipiscing purus nisl amet fames ac Lorem pellentesque Mauris hendrerit porttitor in vel bibendum. et a sed senectus turpis Ut lectus Nam ac Pellentesque mauris tristique habitant ultricies orci non eu risus Suspendisse volutpat dolor Quisque nibh tempor leo finibus lorem molestie eu risus Sed at elit. ipsum sollicitudin",
  "public_updated_at": "2017-10-26T18:43:13+00:00",
  "publishing_app": "tariff",
  "redirects": [
    {
      "destination": "http://example.com/4b91adf5-c7a8-18a5-afef-1cebe9f9ce25#e8febb9397",
      "path": "/dd923c6d-ff34-1aa4-a12f-e8fa0f5b7a03/6b2feaf1-60e5-1ccd-a35f-122f6ee24acc/eec0d92e-3e00-1ebf-a905-9ff3c05453e5/d2bdac45-eb96-115e-ac30-9273c53f7e17/a36e4286-b4c5-1ab1-a7bd-6beec0fce93f",
      "type": "exact"
    },
    {
      "destination": "http://example.com/cf3bee1a-6eb9-1a98-ad96-68d0f59febaf/fb57d62f-abc4-197b-afff-6d046c01c698/aecdd725-fd5a-1d89-a5ff-fef4e34a9dec/b9a96298-a6ec-112e-a7f9-9c8c0172ac62/188f7e00-1011-12a2-a47b-bcf5f8d99b01#db9f003f7d",
      "path": "/56b0d70e-bae0-1273-abbd-3350abc1e52d",
      "segments_mode": "preserve",
      "type": "prefix"
    },
    {
      "destination": "http://example.com/5e32cbcd-3a05-189e-aa40-0e0eed3109df/8c9db457-df97-1623-a1fd-1a430a10ad17#0a265eb47e",
      "path": "/de0aa009-5eea-1edf-a7ae-c0b62fdebfd5",
      "segments_mode": "preserve",
      "type": "prefix"
    }
  ],
  "rendering_app": null,
  "routes": [

  ],
  "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

bulk_publishing
boolean

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "bulk_publishing": true,
  "links": {
  }
}