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

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
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, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, he, hi, hr, hu, hy, id, is, it, ja, ka, ko, lt, lv, ms, mt, nl, no, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, 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
public_updated_at
or null

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, 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

{
  "base_path": "/2e3f5707-1f0e-42f1-85fb-9cf32a7863e0/f2ae7c9c-8690-48d0-8ba5-dd7cb7652616/ab654510-4cd6-4dcc-a208-0f2e77c7b3dd/f74475b6-168e-482a-8f88-efbeebc0257a",
  "content_id": "ee0e683a-579b-4ff7-b699-6ee822a0adf3",
  "description": null,
  "details": {
  },
  "document_type": "redirect",
  "links": {
    "available_translations": [
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/0004812e-eb92-4763-8d5b-c816d050f50b/6c4264ae-0afb-495e-97df-5b8425461ce7/8eea4ba9-be12-40d3-b098-846cdda3f38b/3488a1e6-3892-40e0-b51d-18ed7c244547#d9216112c4d49fbea915bb20b3ec56eb",
        "base_path": "/ad49ee47-b929-4f88-b6b0-7585ee309ea6",
        "content_id": "509115e2-d387-4f64-90e6-b813418f0b42",
        "links": {
        },
        "locale": "vi",
        "title": "Duis bibendum. Mauris Ut et massa sit eros. in,",
        "web_url": "http://example.com/0cafd347-294e-48ec-a5cb-c4a27822e0c7/4b78ba55-7f63-4180-9965-e52b3a30cd2b#e426a3f082a152b5267e4bfd7c449dda"
      }
    ],
    "child_taxons": [
      {
        "analytics_identifier": null,
        "api_path": "/6da6b49a-acde-4386-a436-6461ea073385/678b5da8-765d-4811-8c60-335271fc9d1c/a4b6cfe3-3fc7-4dd2-af11-2d4b5c7326dc/a236718f-bf4b-497b-8377-071339209ca8",
        "api_url": "http://example.com/390f99bd-282f-40aa-a591-54ef6ffb2bbf/294f140c-26fe-4b6e-bfc9-8d36d35e8da8#433f495dd0b27c0340f23de7167092d4",
        "base_path": "/d137b050-535b-471f-aef6-b87088273ffa/cfae112a-7e00-43ff-9ea2-cf6b7fa55a3b/c11fe62e-547d-4428-a220-e34f61518e3f/62baf76c-a944-401b-850a-8061cbe8c138",
        "content_id": "9313a91a-4d0f-420c-8bd6-ea763e85ff19",
        "document_type": "nibh. morbi ultricies eros. eu a tristique sed suscipit volutpat ipsum eu leo et Mauris egestas. ac imperdiet interdum. tempor Duis senectus fames Suspendisse habitant dolor malesuada Nam massa orci molestie Ut interdum. tristique bibendum. non libero. lorem vel et adipiscing risus Ut sem ac vestibulum. turpis nibh scelerisque. risus cursus lectus porttitor Pellentesque consectetur mauris elit. Nam sit est. Quisque Lorem molestie non nisl Aenean netus tempor amet, hendrerit, ac in, Sed pellentesque aliquet. at dolor sagittis sollicitudin vel ac purus finibus,",
        "links": {
        },
        "locale": "uk",
        "title": "mauris ultricies adipiscing molestie sollicitudin in, Nam finibus, morbi sagittis purus non ac amet, hendrerit, dolor nibh. interdum. at Mauris massa tempor Ut"
      },
      {
        "analytics_identifier": "Quisque ac egestas. vel molestie hendrerit,",
        "api_path": "/23556442-425f-48e4-a168-db87f1a50c66/2adc9b79-8e7f-4da2-8ed7-a725b3797279/0fc82468-3e82-481c-8ebe-4e64c67ef8f3/27d994b3-40b2-4d4c-8be5-fd667289bf1b/ca00fdeb-649b-4688-96f4-ba1d548342ee",
        "base_path": "/3429060a-cd8d-436d-873b-38c7bbef459e/ff393904-d324-4b8c-a688-6940b0a93ed9/e3247ecf-c313-4a4a-b1ae-2f2b16fcecd3/87c18ee1-b25f-473a-912f-7aa080026d18/116fe2ac-b5ff-4d09-b325-d83664807442",
        "content_id": "71d55da3-f195-4b37-b775-8ea25e10cd38",
        "document_type": "dolor eu adipiscing vel ultricies turpis in, egestas. vel bibendum. Quisque finibus, ac habitant ac et ac elit. aliquet. interdum. Ut ac scelerisque. tempor lectus porttitor Lorem orci senectus eros. risus est. molestie libero. Pellentesque a vestibulum. et sagittis risus consectetur non netus volutpat massa pellentesque Sed purus Aenean fames amet, cursus non suscipit imperdiet eu nibh. Suspendisse tempor Ut tristique sed lorem malesuada interdum. sit hendrerit, Mauris nibh at Nam mauris molestie Duis tristique dolor sollicitudin leo ipsum nisl morbi Nam sem",
        "locale": "hy",
        "schema_name": "Nam et Nam sem consectetur eu malesuada Lorem eros. est. porttitor ultricies ipsum hendrerit, sagittis interdum. vel ac Pellentesque imperdiet libero. nibh molestie nisl tempor fames sit Mauris purus Aenean cursus netus scelerisque. pellentesque tristique dolor eu at suscipit sed et amet, aliquet. nibh. senectus turpis elit. volutpat adipiscing lorem a egestas. morbi vestibulum. non mauris tempor ac non leo ac massa Sed Quisque risus lectus orci Ut",
        "title": "non at Ut ac suscipit mauris egestas. hendrerit, libero. ac ac risus tristique dolor sagittis Aenean sem scelerisque. lectus dolor tristique vel sollicitudin eu ipsum habitant orci Pellentesque vel tempor pellentesque senectus interdum. fames Ut ultricies bibendum. a adipiscing molestie risus Quisque nibh massa",
        "web_url": "http://example.com/4845e775-6916-48af-8a94-a9da92799c05#fad7a4c10073bdbc3e4c2a7667773ebe"
      }
    ],
    "document_collections": [
      {
        "api_path": "/c66eb3b5-6da1-4be9-9dd8-463558f36b07/50192e91-dbd0-4acf-8f40-fb19f407a2f8/d586e60b-f374-4b5d-8b15-2dc7b367edf4/8b17f792-1667-4a80-86bd-055e33410dd5/8a4d9f06-3ab1-412f-9dbc-3d1734f591ec",
        "base_path": "/3d7afe2c-1ff5-445f-950a-89b4ba9cc25c/508fd4ab-446b-42b3-b5ad-2c67904df1a0",
        "content_id": "d3533e6e-1419-4e6e-bc27-858263329c67",
        "document_type": "elit. amet, Nam sem habitant imperdiet dolor tempor ipsum molestie aliquet. nibh porttitor Mauris ac lorem Suspendisse scelerisque. est. suscipit tempor adipiscing morbi turpis eros. sed Duis hendrerit, eu et finibus, vel malesuada ultricies ac netus tristique fames tristique massa Lorem a vestibulum. sagittis consectetur libero. risus sit Ut bibendum. senectus dolor orci ac Quisque non leo Pellentesque interdum. purus ac risus cursus Nam molestie vel sollicitudin lectus Sed pellentesque eu nibh. non Ut in, Aenean at nisl interdum. egestas. volutpat mauris et",
        "links": {
        },
        "locale": "uk",
        "public_updated_at": "2019-05-08T17:06:28+00:00",
        "title": "imperdiet vestibulum. Aenean nibh in, morbi Nam molestie leo eros. nibh. dolor Ut purus tempor et tempor et interdum. vel adipiscing ac massa netus sed at interdum. non ac Pellentesque Ut consectetur suscipit ac vel habitant hendrerit, porttitor tristique scelerisque. elit. lorem turpis Mauris sit cursus risus ultricies finibus, nisl mauris ac sagittis molestie risus dolor Sed amet, tristique Suspendisse eu pellentesque Duis ipsum lectus fames sollicitudin Lorem egestas. Nam malesuada libero. non a"
      },
      {
        "api_path": "/eccfbdb7-ed2f-40bc-b9a4-16094d0b5ee4",
        "api_url": "http://example.com/87c07c12-10b0-4a8f-9d32-5ab976fccc86#8c552e9268b03338052422e5fa1d8791",
        "base_path": "/f878e216-8260-4ad2-be44-31a8575a4f44/e00a2657-3749-467c-8e01-c2b219d031b4/6d68f128-a9f6-47d7-ba5e-62d9e2cd09ef/7f212ffa-0948-4fbe-8363-8a04eeb935b1",
        "content_id": "fd844b3e-935b-44d1-b6e3-4d28e96569ad",
        "links": {
        },
        "locale": "dr",
        "schema_name": "risus ac dolor libero. tempor finibus, interdum. nibh adipiscing vel malesuada sed Ut volutpat a ac eros. imperdiet sit morbi Nam Pellentesque nibh. suscipit tristique vestibulum. tristique sollicitudin molestie lorem senectus Aenean netus ipsum et est. nisl Lorem consectetur et orci fames eu",
        "title": "suscipit ac malesuada orci Quisque lectus Duis ac est. et Suspendisse eu tristique mauris sem sit sagittis dolor molestie vestibulum. finibus, Aenean et purus a sed at ultricies turpis Nam hendrerit, egestas. Nam non morbi ac interdum. scelerisque. habitant nisl tristique aliquet. Mauris sollicitudin imperdiet vel porttitor Pellentesque cursus adipiscing senectus risus molestie non"
      },
      {
        "api_url": "http://example.com/5d22c1c3-cc15-49ec-98ab-4d1b53036c49/305e9824-7066-45c1-96e7-60e52eb398bb/f262ddcb-6d00-43f7-bdfa-b255aed56343#2a76802cd180346795c2baec934db598",
        "base_path": "/5a9c5344-68b4-4edc-8e3f-ce50f2d65723/fc85e194-ce2f-4fac-8644-377a8de32d22/b4c24a30-1849-43d0-887a-988a7c10ecdb",
        "content_id": "5221d2cd-eb6e-4fed-b4fc-c9f79bfde775",
        "document_type": "finibus, eros. Quisque interdum. vel ac bibendum. lorem sed tristique ultricies tempor dolor consectetur adipiscing Duis ac massa vestibulum. et Mauris Nam vel imperdiet Nam turpis fames a scelerisque. ac volutpat nibh. ac sit hendrerit, tristique eu nisl orci in, pellentesque molestie est. non",
        "locale": "sv",
        "schema_name": "ipsum in, hendrerit, molestie Suspendisse pellentesque morbi sollicitudin eros. et Lorem Duis tristique habitant scelerisque. non vestibulum. a senectus dolor sagittis molestie vel tempor lectus dolor risus non eu Quisque Aenean orci ac amet, Ut nibh Ut bibendum. elit. ac nisl libero. Sed aliquet. porttitor tempor vel turpis interdum. malesuada sed cursus Mauris mauris consectetur est. volutpat Nam ultricies leo egestas. risus finibus, interdum. ac suscipit nibh. ac lorem eu Pellentesque sem sit massa at imperdiet tristique fames et purus netus adipiscing Nam",
        "title": "Nam habitant egestas. ac vestibulum. molestie et dolor nibh. eu ac nisl et eros. bibendum. sollicitudin Sed aliquet. suscipit sed vel sagittis tempor Duis malesuada sem risus non molestie senectus turpis lorem dolor purus imperdiet mauris est. eu netus hendrerit, Mauris tristique ac Nam ac Ut scelerisque. finibus, massa orci Lorem volutpat morbi fames elit. ultricies Ut Aenean ipsum",
        "web_url": "http://example.com/4c04121b-f2b4-427d-9124-efe350b38855/c9d64460-eb59-4dca-a6b5-fdfa1a2e40fa#a877f9f191c9b83fcf6dc37858f6df81"
      },
      {
        "analytics_identifier": null,
        "api_path": "/76320c2f-c68d-40d2-b5c9-1d977d31db95",
        "base_path": "/8338e947-44c3-465e-b5a2-674ed518e3bd",
        "content_id": "a9599e87-8c1a-4f32-aad2-f90930955343",
        "document_type": "Ut bibendum. malesuada lectus purus nisl non eros. tristique fames Suspendisse orci amet, cursus scelerisque. nibh aliquet. tempor est. eu Mauris vestibulum. pellentesque ultricies netus turpis ac sem finibus, Lorem elit. dolor ac ipsum libero.",
        "locale": "be",
        "title": "mauris Lorem ipsum Ut sagittis vel Mauris vel suscipit turpis malesuada hendrerit, morbi adipiscing nibh. sem",
        "web_url": "http://example.com/aca8ea90-4644-4be3-83b9-ce3e9ab6ad40/8564b9b5-90bd-4857-86ed-80163650fca7/6d66d360-5e7e-41b8-9014-de1414a9223a/0f8fbd58-025a-4881-bab6-6968163ec8c5/8e785e24-feee-4e71-82c8-ce9c4da610ff#1ab2476903d213401867313db1a354a1"
      }
    ],
    "part_of_step_navs": [
      {
        "api_url": "http://example.com/0fc5ce0d-25f2-4218-86b8-124f40b70ff5#8f590d896b00fef5bd18f3155cac02a5",
        "base_path": "/12130e19-263c-479c-82cb-7f4e83284d85/ce889724-f9c0-4876-8a35-d86268027556",
        "content_id": "0305f83e-66e6-42aa-9c7f-ff612e889552",
        "locale": "el",
        "public_updated_at": "2019-06-20T05:43:10+00:00",
        "schema_name": "molestie nisl sagittis tristique tempor ipsum amet, vel adipiscing ac Aenean Quisque senectus sollicitudin ultricies nibh. at cursus orci in, Mauris et malesuada interdum. sit leo non mauris ac lectus vestibulum. porttitor scelerisque. turpis volutpat bibendum. eu interdum. risus Nam ac ac tristique libero. lorem",
        "title": "scelerisque. lorem libero. Duis nibh molestie leo dolor aliquet. imperdiet adipiscing nibh. Aenean et netus bibendum. ac Nam in, ac massa ipsum sagittis vel tristique mauris Ut egestas. a risus tristique est. sollicitudin sit risus sed amet, Lorem molestie tempor eros. interdum. nisl Sed porttitor suscipit interdum. eu Ut Mauris Suspendisse lectus turpis volutpat Pellentesque malesuada non ac senectus dolor fames sem et at Nam ultricies morbi non purus vel ac orci eu consectetur vestibulum. pellentesque Quisque elit. cursus tempor finibus, habitant hendrerit,"
      },
      {
        "analytics_identifier": null,
        "base_path": "/c833bd59-34ae-42c2-b559-8e2b028c4beb/5abc6aaa-d5f3-472f-b020-291d19a4c7ce/c64601d0-ea38-4568-a0fa-34339619ca35/51ee708e-b954-4fbe-99a0-39a8dff1fabf",
        "content_id": "e09c4107-f8af-4cd5-b94d-77d84825eb87",
        "locale": "fi",
        "title": "ipsum Quisque Ut dolor dolor non leo Mauris Nam Duis eu non Ut aliquet. egestas. cursus amet, ultricies elit. scelerisque. sollicitudin orci nibh. Pellentesque bibendum. Sed finibus, est. in, interdum. malesuada",
        "web_url": "http://example.com/a7b63d37-fa2d-464d-95a5-57c2c980376e#026d10ba91e929088d629068af1248ca"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/87e91d7a-45e8-471a-83b3-4b5a63087699/064deb1a-bdd4-41af-81e5-32a7ff9e2ba0/1c78c089-5681-4c04-b68f-6a55a1c9fbd8/49811798-5ad0-4953-8700-971614a79902/4a6b69d6-611d-49c7-bfe9-d592ffc2daae#8e34371c79ec4e3257fc4e92e633df52",
        "base_path": "/72b2f393-a988-4ed9-ad3f-13e8503cc87f",
        "content_id": "131b18d9-5f4c-4e80-a1dd-c0994886c300",
        "links": {
        },
        "locale": "bg",
        "public_updated_at": null,
        "title": "Quisque libero. vel sollicitudin ultricies ac scelerisque. adipiscing Mauris turpis sem egestas. purus netus ac Duis Pellentesque consectetur eros. orci ac nibh. hendrerit, elit. molestie at nibh suscipit molestie aliquet. malesuada fames et habitant risus finibus, dolor cursus sit morbi vestibulum. tempor eu amet, est. Ut imperdiet ac interdum. pellentesque"
      },
      {
        "analytics_identifier": "at ac nibh risus Duis eu risus netus ipsum senectus turpis molestie nisl purus ultricies aliquet. fames Lorem eros. mauris",
        "base_path": "/2178c5e7-a500-4685-ae09-7c6285861a9b/042a7f74-39bf-4895-a8b3-c8fbb0f52cf5",
        "content_id": "7a4c8c62-13b8-4811-8245-bb9d4f7de43d",
        "document_type": "lorem Lorem nibh at ultricies vestibulum. pellentesque morbi adipiscing netus sit ac aliquet. volutpat interdum. Suspendisse finibus, amet, molestie ipsum dolor tristique fames vel senectus turpis suscipit scelerisque. risus malesuada non interdum. hendrerit, Quisque in, elit.",
        "locale": "ar",
        "schema_name": "Mauris pellentesque est. non nisl hendrerit, leo ac risus tristique Quisque a consectetur eros. netus elit. sed et tristique sem molestie imperdiet porttitor cursus ac volutpat interdum. egestas. Ut Nam Suspendisse nibh eu Pellentesque scelerisque. molestie sit dolor Duis adipiscing Ut orci sollicitudin ipsum eu massa ac fames lectus malesuada Lorem mauris at ultricies risus tempor morbi vel interdum. Sed suscipit habitant in, turpis dolor vestibulum. nibh. Aenean vel bibendum. lorem tempor senectus et aliquet. libero. purus Nam amet, non sagittis finibus, ac",
        "title": "Nam egestas. at ac sem est. sit pellentesque Ut tristique Suspendisse ipsum adipiscing"
      },
      {
        "api_path": "/df589a9a-be5c-4250-a24f-f28703b0b6d8/7a1d7074-9d2f-4442-9aeb-7cbc229934e2",
        "api_url": "http://example.com/255fe6a3-7310-4c7f-a729-0ed6b3f9d238/c96d22d9-58a2-43ac-a983-66bcff41491c/11810a20-e4f0-48db-8b0e-153aa17513ed/88ac4d47-b11c-4614-bd24-8c3cdd29807e/c768a303-2042-461a-8538-8a03b444a56a#700024a092926aa511cbdb6e50b64de3",
        "base_path": "/98066c19-6829-4555-9904-78f4b3475878/9c2b9adf-1f42-4783-9fb7-00126f37f5b4/df7e92fe-846b-41bf-9906-87a600eb0df3",
        "content_id": "4af07a95-e027-4ae8-a6c6-1be777153c2c",
        "document_type": "risus morbi vel Mauris et tristique lectus vel vestibulum. orci nibh sollicitudin libero. Nam volutpat amet, tristique imperdiet et interdum. tempor risus molestie Suspendisse nisl habitant Duis Ut interdum. ac Sed massa ac bibendum. suscipit Ut fames cursus sit egestas. Quisque molestie turpis ultricies senectus lorem consectetur ipsum sed ac malesuada mauris tempor Nam pellentesque a ac est. netus hendrerit, sagittis non eu adipiscing aliquet. eu leo elit. non sem dolor dolor Lorem scelerisque. finibus, in, at porttitor Pellentesque purus eros. nibh. Aenean",
        "locale": "da",
        "schema_name": "mauris malesuada morbi netus Suspendisse volutpat tristique in, et sagittis aliquet. fames ultricies adipiscing scelerisque. Ut Mauris nisl Nam egestas. turpis lectus imperdiet vestibulum. nibh purus risus ac massa tempor Sed Lorem pellentesque eu suscipit sem eros. molestie vel lorem dolor interdum. at senectus elit. orci bibendum. Aenean risus Quisque sit non a et molestie Nam sed interdum. habitant vel ac libero. leo ac Duis Ut sollicitudin consectetur tempor ipsum eu ac est. cursus hendrerit, nibh. finibus, Pellentesque non amet, dolor tristique porttitor",
        "title": "nisl molestie senectus ac finibus, vel tempor imperdiet consectetur turpis Suspendisse vestibulum. tristique Lorem nibh. in, netus cursus risus hendrerit, interdum. ipsum sem at sit malesuada Nam et Nam egestas. sollicitudin"
      },
      {
        "analytics_identifier": null,
        "base_path": "/0cc394da-8d42-4942-b514-07b4062374d9/fdf4a3b2-03c5-4c66-b1f9-9dd3e3e5b34a/0971aa15-87d0-4970-b888-f4a146c8db01/be6977ce-06d0-47a4-ba92-0246494a9f1c",
        "content_id": "acc6c226-713b-4307-9bed-b0978a515085",
        "document_type": "ac scelerisque. adipiscing nisl ipsum turpis nibh risus habitant Pellentesque vestibulum. nibh. Quisque senectus dolor ac a malesuada lectus consectetur lorem bibendum. fames molestie est. tristique amet, netus Nam hendrerit, pellentesque Ut et in, interdum. sem tristique Aenean massa non risus Mauris Lorem cursus vel orci morbi ultricies non leo libero. elit. Duis et porttitor vel interdum. aliquet. volutpat molestie ac dolor Suspendisse ac imperdiet sollicitudin sagittis mauris eu sed tempor Nam finibus, eros. egestas. at Ut suscipit purus Sed tempor eu sit",
        "links": {
        },
        "locale": "th",
        "title": "turpis et sagittis ac aliquet. malesuada suscipit molestie ipsum egestas. volutpat at nibh hendrerit, purus tempor bibendum. in, vel est. dolor sed Nam vestibulum. molestie finibus, a mauris Suspendisse massa Pellentesque et non amet, nisl interdum. ac lorem sem morbi Mauris Ut ac eros. Nam Ut eu Lorem orci adipiscing lectus non risus senectus interdum. sit scelerisque. eu sollicitudin libero. Quisque vel Aenean tristique habitant tempor elit. netus consectetur tristique risus cursus fames imperdiet dolor pellentesque nibh. leo ac porttitor Duis ultricies Sed",
        "web_url": "http://example.com/562888ae-aba1-43ce-8c43-1529a8dc6a3e/195b61cc-a81f-4354-9420-5df781fec263/7cbd98a2-a733-4748-845e-1a06d54d4242#5d411cba37ff0e0b8fc2f543beac9999"
      },
      {
        "api_url": "http://example.com/0fbf1828-05a6-4bb7-b6c3-578eaede0ca5/fc06538b-2874-4a03-a569-0ca254914e0d#1b551ca3702e52b6093a83e25cab72f1",
        "base_path": "/30d7e0dc-db73-4f27-82f5-4971b12730b0/75a23e37-bdf1-4957-af1f-a18403a5db0c/667cf450-3cfe-4abc-bc05-d0d1718890ed/be737e74-f26b-4d30-8b96-7453da18763b",
        "content_id": "ad513897-6ca9-4604-aade-379f5cf7c4db",
        "links": {
        },
        "locale": "sl",
        "public_updated_at": "2019-04-23T21:38:26+00:00",
        "title": "et finibus, Pellentesque ac malesuada leo dolor ac dolor Lorem purus sagittis Duis sit hendrerit,",
        "web_url": "http://example.com/9c800ffc-3fdb-48d1-960d-f5b84d590b8e#a69f72228c983eac30daae84ec23feb2"
      },
      {
        "analytics_identifier": null,
        "api_url": "http://example.com/7adb83a2-679b-4491-819f-7b9aaf9ca384/0224b6d8-22ea-44cd-b28b-f3b6246a7b57/73aff403-308f-42dc-9bf6-55b814e03780/fc8ab350-6bab-4bb9-a1c4-4644d63e7ce1/bb837ce0-b1db-440e-b8ed-2c4436fe3261#83099280e044854aff0be3350b755ae1",
        "base_path": "/c9b3495e-5aeb-4430-b53b-6cc64775f189/1bea03f2-988f-4d00-9006-84df6beef5fa",
        "content_id": "9827f249-58bf-4a6d-b6cf-1cf1c3d076cf",
        "document_type": "purus non interdum. morbi Duis Pellentesque consectetur risus suscipit Ut Ut sed eu nibh senectus Sed sem sollicitudin ac turpis vel egestas. massa est. in, a et orci ipsum ac vestibulum. eros. lorem interdum. Mauris at tristique habitant malesuada leo nibh. lectus tristique tempor nisl ac eu netus mauris vel dolor sagittis fames sit",
        "locale": "zh-hk",
        "schema_name": "consectetur non egestas. Mauris orci scelerisque. hendrerit, habitant tristique bibendum. ac vestibulum. Aenean dolor senectus interdum. leo nibh. non lorem Nam eu Nam nibh lectus netus Duis tristique at Lorem ac in, porttitor elit. Ut eu sit libero. dolor tempor molestie ac risus malesuada mauris vel pellentesque volutpat sem ac Pellentesque a risus fames massa sagittis sed interdum. Ut ultricies cursus aliquet. amet, nisl imperdiet Sed ipsum est. purus suscipit et sollicitudin molestie turpis Suspendisse morbi Quisque tempor et adipiscing vel finibus, eros.",
        "title": "molestie senectus eros. interdum. tristique pellentesque hendrerit, Mauris vel Suspendisse libero. lectus est. adipiscing molestie mauris vestibulum. risus sed egestas. ac netus in, sagittis suscipit finibus, eu interdum. orci turpis morbi Duis ipsum Aenean consectetur ac leo nisl aliquet. et Lorem tristique et imperdiet nibh porttitor tempor a malesuada sit nibh."
      }
    ],
    "related_to_step_navs": [

    ],
    "topic_taxonomy_taxons": [
      {
        "base_path": "/f8f0ca87-135f-4e87-9d03-43e53aaf5ece",
        "content_id": "a05df9bd-7a15-4bb1-a29c-407778ceb008",
        "document_type": "est. Nam cursus senectus turpis sollicitudin imperdiet nibh. tristique Ut dolor eros. a Nam netus ac ac malesuada mauris porttitor Lorem lectus volutpat bibendum. vel lorem suscipit sed scelerisque. fames interdum. tempor elit. in, nisl ac Pellentesque morbi interdum. ipsum pellentesque habitant ac aliquet. sem Suspendisse eu eu vel risus Mauris Aenean non sit risus adipiscing tristique finibus, et dolor Ut nibh Sed et egestas. libero. leo amet, at molestie Duis purus ultricies massa sagittis orci tempor molestie vestibulum. non hendrerit, consectetur",
        "locale": "pl",
        "public_updated_at": null,
        "title": "dolor amet, eros. Ut molestie et tristique et a purus mauris lorem elit. porttitor pellentesque non eu eu risus lectus sollicitudin est. sit netus vestibulum. ac ultricies finibus, scelerisque. cursus sem leo tempor libero. sagittis non morbi nisl egestas. ac turpis Quisque Ut ac nibh. at Aenean ipsum orci aliquet. vel massa Nam nibh risus Sed Pellentesque tristique consectetur adipiscing malesuada vel Duis Lorem in, tempor fames suscipit Nam interdum. Suspendisse hendrerit, senectus molestie ac interdum. habitant sed bibendum. imperdiet volutpat"
      },
      {
        "base_path": "/3f84a445-691e-43d5-9137-92abc61919ba/23bfe5ac-5801-4304-ac9b-d8d5253531ef/4c02edd3-30ac-4139-8c18-29fa2f0aae3f/117e0c00-a8f7-449f-966e-8b92594d69af/c0d8e218-d918-48d3-8596-2ad39a34ba8f",
        "content_id": "7496da36-ea36-4401-8098-dadce3fb02cc",
        "links": {
        },
        "locale": "sr",
        "public_updated_at": null,
        "title": "ipsum bibendum. in, ac non volutpat a vel"
      },
      {
        "api_path": "/6d3e595a-9a92-4d92-bf4c-7c7347669ff6/8fd06fed-1c34-4145-8a43-953b93475966/67f64130-f2e1-47bb-b049-975fe3b7cc0f",
        "base_path": "/bd3d069c-34a2-40ed-9f07-809d88112e96/cbe2ad0e-ff3e-4358-8395-3c3cc9fbaa5e/1a9d18c1-1cd5-4d63-b8fd-74c2c40de35d",
        "content_id": "ca18dbff-c9ab-44c2-ae40-aa7ff8fd0f51",
        "document_type": "molestie sem vel massa finibus, morbi cursus egestas. vestibulum. eu lectus Mauris sed Duis et fames adipiscing in, habitant risus sagittis ac consectetur Quisque amet, volutpat vel leo non interdum. pellentesque porttitor Ut nibh sit interdum. mauris Aenean tristique netus eros. nibh. suscipit ipsum orci elit. molestie nisl tempor at ac risus non Pellentesque tristique bibendum. est. dolor Sed malesuada scelerisque. hendrerit, senectus ac",
        "locale": "fr",
        "schema_name": "ac porttitor molestie senectus et in, purus ac Pellentesque Ut",
        "title": "orci bibendum. fames aliquet. nibh sed tempor Nam interdum. non netus in, dolor ac lorem vel leo porttitor sagittis sollicitudin risus tempor elit. scelerisque. Ut eu suscipit adipiscing Pellentesque Mauris vestibulum. mauris eu ac consectetur nibh. molestie Duis Ut sem ipsum ac Nam vel et Suspendisse at finibus, risus sit tristique a Sed morbi tristique amet, dolor interdum. lectus et eros. purus volutpat turpis egestas. senectus cursus malesuada non est. Quisque habitant hendrerit, ultricies Lorem ac imperdiet molestie libero. pellentesque nisl Aenean",
        "web_url": "http://example.com/5ebcc50a-e6ba-4616-8d94-e8d9ddbc7d0f#38f0ca37c96d3574fb13bfff10603ea9"
      },
      {
        "api_path": "/d10f2e69-432b-4edd-bff3-eb5b221f45ee/1cf62bb7-b07a-4f5b-902a-845062a0eec3/5d792b2a-f3d1-4e22-adf3-b680f8d5deaa/b1a337aa-3a70-4573-b2ab-096a6118ab83/079b914a-b500-4951-80b5-b8295a6b7ad4",
        "api_url": "http://example.com/6d102c13-1c6b-4574-b88f-9175c675cab5/6f9a3f8e-fbfe-44a9-a573-890faf3a39dc/98a2261c-89ea-4ae5-a11c-c7e0384b0fd1#d1dd3bc035ae7d12ebbc356abc90a11b",
        "base_path": "/3ee6c663-6df9-4bcb-957c-df1e171afcf1/d75e7936-65c1-4833-845c-4c90cdc93b02/05b839de-3a01-4e14-ba37-a03395841675",
        "content_id": "96d9ecdc-b0ae-431b-a599-81c30644f11b",
        "locale": "es-419",
        "public_updated_at": "2019-04-24T06:17:56+00:00",
        "title": "Mauris Suspendisse Sed lectus et adipiscing sed lorem fames senectus vestibulum. elit. est. hendrerit, eu Nam non eu leo nisl Aenean nibh eros. bibendum. interdum. ac Pellentesque suscipit molestie interdum. tempor Duis Ut aliquet. egestas. amet, Quisque habitant in, et purus sagittis ac vel porttitor cursus finibus, sollicitudin a ac mauris orci vel imperdiet libero. Lorem dolor consectetur Ut molestie sem nibh. morbi tristique tempor ultricies volutpat massa scelerisque. dolor turpis netus risus pellentesque non ac ipsum at tristique risus Nam sit malesuada"
      },
      {
        "api_path": "/9b84e2a9-beaf-4f8a-8500-b89b5c0b13ae",
        "api_url": "http://example.com/e917c146-fa90-4efc-8c00-b5d621cfcefb/8e9e6770-3ee9-412e-ac5c-3fac89f71e37/fad88dd9-1b1d-4413-a966-f11c397c845d/cec22f5c-37f5-4e5a-b49f-b8b74ef5a259#9fb91687e3228becd8bf78e094b3d8d4",
        "base_path": "/da3d40b1-0686-4f59-a3b6-856d1a31e3a4/32c86edc-56c5-4481-9a58-3d7b928093e0",
        "content_id": "eabf4d37-fc40-47e3-a5f0-7fcdda8850a6",
        "document_type": "Pellentesque habitant imperdiet sollicitudin Sed ipsum molestie risus tempor Aenean et Nam dolor fames est. sagittis turpis nibh. leo Nam dolor cursus eros. orci sem in, aliquet. Quisque malesuada Ut porttitor Ut sed Lorem lorem tristique non netus ac morbi eu vestibulum. a tempor scelerisque. tristique Duis hendrerit, libero. massa interdum. at bibendum. Mauris vel ultricies amet, lectus ac elit. volutpat egestas. senectus finibus, ac interdum. suscipit sit nisl risus molestie pellentesque et purus non vel mauris ac nibh Suspendisse eu adipiscing consectetur",
        "links": {
        },
        "locale": "zh-hk",
        "title": "est. libero. nibh. leo tempor orci Lorem aliquet. adipiscing mauris et et malesuada bibendum. purus habitant senectus lorem volutpat in, sed vel sollicitudin dolor tristique massa ac sagittis tristique Duis interdum. Quisque ipsum eu non eu risus ac imperdiet Ut elit. nisl sit egestas. cursus ultricies sem netus ac Nam morbi vestibulum. amet, turpis eros. a scelerisque. molestie suscipit Mauris risus Aenean Pellentesque fames dolor non hendrerit, pellentesque porttitor interdum. Sed at lectus tempor ac consectetur Ut nibh molestie Suspendisse finibus,"
      },
      {
        "api_url": "http://example.com/43365e65-f8eb-47aa-8dcc-367a5de82ad2/423c2392-995e-4278-9d2e-dc59e840c5de#d3822a322db332e62a11cec56e4e6e84",
        "base_path": "/477b11be-355e-4b8c-8f8a-c2059520afff/cd44a0d9-41b9-4cad-a044-d5c1244f1fa8/29ee0000-7ba1-4c1b-a1bb-7362ff16c4a3",
        "content_id": "6cdbe9c2-2995-44b4-8f05-a700b6561d7e",
        "links": {
        },
        "locale": "ur",
        "title": "interdum. dolor mauris ac bibendum. aliquet. eu nisl massa turpis scelerisque. morbi libero. non finibus, lectus cursus Suspendisse Nam ac lorem hendrerit, sem vestibulum. tristique consectetur Mauris ipsum nibh. habitant et est. nibh purus amet, eu imperdiet Pellentesque ac sagittis risus Aenean leo tempor egestas. Nam tristique et risus senectus eros. interdum. suscipit Duis dolor a orci vel tempor molestie molestie vel pellentesque volutpat malesuada fames ultricies sit at sed sollicitudin in, ac",
        "web_url": "http://example.com/29807859-fd4b-46c3-bc0e-3556749b1b87/11fd7159-3afc-4c5a-b66c-02fd180c2cd3#6c51ae0ff50b7614150d9e5b6e7b7516"
      }
    ]
  },
  "locale": "fa",
  "phase": "live",
  "public_updated_at": "2019-03-15T02:15:51+00:00",
  "publishing_app": "smartanswers",
  "publishing_request_id": null,
  "redirects": [
    {
      "destination": "/4840f034-d23e-42d8-8926-188cc1b3748c/f81a8386-7c07-42ab-a152-f1f7937df0a6",
      "path": "/d74ece20-33e9-4590-89a2-be73e52f6ec5/2eb88341-7e39-4cd2-b970-c385567db506",
      "type": "prefix"
    },
    {
      "destination": "/fef6d5ae-51f0-4879-b599-9aa032fced52/dbea2bde-3633-46e2-a976-a4954271904b",
      "path": "/499b312a-4870-42dd-887a-b11cb9da283f/c096258a-22a4-427c-b210-d767ae95777c/f567d914-612f-49dc-aed7-284da3e88038/ad5524c2-aa25-402a-ac68-d514c6ac8ced",
      "type": "exact"
    },
    {
      "destination": "/af1ff582-763b-479c-aa60-1138863dbc29/09e8eae8-9fc0-4d48-b4f1-3b23e366d4ee",
      "path": "/658d5662-c536-4337-8fe3-65bd43dd9dc3/5c37780c-a90c-467d-92cb-502a86a5ac36/d2b2d365-5310-4602-97fe-b906b4f185e4/a2d66506-6bea-4c4a-b5de-585e04de5fc4/5a489f8b-02cc-48cb-a8fa-f3d157d25db4",
      "segments_mode": "ignore",
      "type": "exact"
    },
    {
      "destination": "https://hqjftd.lqnvzto.kcm.pemgaoid.gov.uk/a655f5fa-c527-4f64-b7ab-3563dc76695d/588e7ef7-816d-4455-89c1-982e3a1c74d9/a9820d62-b7c9-4833-8729-1d4b4fc3a10f",
      "path": "/3454ac7b-538b-4da9-87df-1948aacc5fcd/7b73ab7b-a563-4538-9ea0-8c4ffe935ef3/db96093f-e240-4625-ba76-9895ed65ed60",
      "type": "prefix"
    },
    {
      "destination": "/a66d2605-3741-47e2-9d3e-2f44a53402b8/641ad27e-eee4-4bb4-84fd-bcad7f17cf39/d9a4d1a9-ea00-4617-9f39-bb62f747ed6e",
      "path": "/625d0781-2c04-4e11-a039-f7f1883fd545",
      "segments_mode": "preserve",
      "type": "exact"
    }
  ],
  "scheduled_publishing_delay_seconds": null,
  "schema_name": "redirect",
  "title": null,
  "updated_at": "2019-05-24T04:19:48+00:00",
  "withdrawn_notice": {
    "explanation": "fames mauris eros. finibus, Aenean vestibulum. ac dolor aliquet. porttitor sed massa a scelerisque. interdum. netus habitant senectus nibh. sit molestie cursus leo interdum. Pellentesque et nisl non tempor",
    "withdrawn_at": "2019-04-12T17:40:05+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.
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, he, hi, hr, hu, hy, id, is, it, ja, ka, ko, lt, lv, ms, mt, nl, no, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
need_ids
array

phase
string
The service design phase of this content item - https://www.gov.uk/service-manual/phases
Allowed values: alpha, beta, live
previous_version
string

public_updated_at
string
When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.
publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, 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": {
    "users": [
      "amet, suscipit dolor netus mauris ultricies vel tempor sem ac massa porttitor habitant malesuada ac sit Aenean sollicitudin et Duis leo Suspendisse est. sed hendrerit, scelerisque. lorem egestas. risus imperdiet volutpat non Nam Lorem eros. dolor nibh a fames turpis consectetur interdum. Sed aliquet. vel molestie Ut eu Quisque pellentesque vestibulum. ac bibendum. purus et senectus Ut interdum. molestie risus tristique lectus cursus sagittis nibh. ipsum",
      "Duis lectus libero. netus molestie malesuada tempor Pellentesque et vestibulum. nisl porttitor Ut sit eu molestie nibh scelerisque. Ut imperdiet ac in, tristique adipiscing sed bibendum. orci interdum. non Suspendisse ac ipsum ultricies vel elit. purus pellentesque morbi sagittis lorem eros. Quisque Nam non finibus, risus cursus interdum. a dolor fames suscipit Mauris consectetur vel Nam risus et egestas. habitant Lorem est. volutpat ac hendrerit, leo Sed",
      "mauris ac molestie Ut tristique ac sem cursus interdum. eu et purus eros. netus Ut dolor ultricies Quisque malesuada at sit scelerisque. Suspendisse Duis massa elit. finibus, volutpat est. vel eu a adipiscing ac turpis Pellentesque tempor leo porttitor in, molestie Sed non sed Nam habitant Mauris tristique lorem vestibulum. bibendum. vel tempor",
      "at ac imperdiet eros. Mauris tristique porttitor volutpat vel ultricies interdum. vestibulum. ipsum netus Suspendisse elit. lectus nisl mauris morbi nibh. in, interdum. sed Quisque consectetur non purus massa senectus Aenean tempor bibendum. ac risus molestie suscipit dolor dolor leo sagittis Duis pellentesque lorem a et scelerisque. turpis vel tempor hendrerit, Ut ac Sed est. habitant nibh orci finibus, cursus sollicitudin Nam malesuada risus libero. non"
    ]
  },
  "base_path": "/21e7d586-12cd-4dd7-bf9b-c5b8508d4528/d0f3a02b-9021-4cc3-9039-a9b7115bbe6f/6aa2d30e-06b7-4bec-8532-a36b566a195f",
  "bulk_publishing": false,
  "change_note": "tristique vel elit. netus malesuada adipiscing Suspendisse cursus eu aliquet. ac fames bibendum. nisl nibh. eros. non Lorem est. Ut molestie a et Mauris risus volutpat sed Quisque scelerisque. ultricies consectetur finibus, Aenean lectus Nam porttitor suscipit egestas. in, ac orci libero. eu molestie leo non interdum. sem mauris ipsum sagittis tristique pellentesque dolor nibh ac interdum. ac tempor sit Duis massa lorem Ut dolor imperdiet",
  "details": {
  },
  "document_type": "redirect",
  "first_published_at": "2019-04-22T18:54:55+00:00",
  "last_edited_at": "2019-05-10T12:37:19+00:00",
  "need_ids": [

  ],
  "phase": "beta",
  "publishing_app": "content-publisher",
  "redirects": [
    {
      "destination": "/5be0acda-9401-45fa-b8b3-1d36da7c36c2/3a4767a5-ec12-437c-a534-b74449906d80/f00eee5b-951e-4181-bb3a-0f2e51da31c7",
      "path": "/3999e7f9-63a9-45bc-962e-b075b2002560/821388ef-e802-4996-93b9-2a279d08a348/7489c325-a71d-456b-ae55-ee7d880b4e40/b518e756-f00c-4b1a-86cf-180470fbf8a4",
      "type": "prefix"
    },
    {
      "destination": "/663a861c-b110-4415-a5aa-1d0472b0b65d/bd17640f-2f3a-445b-b777-7776e7d71f3a/bd50f299-5c49-4a94-9f7d-1a017a93bd83",
      "path": "/a171be62-3209-4781-a553-5c8adf7076d8/0f3ed652-4a84-4302-9107-b2816e5b61bb",
      "type": "prefix"
    },
    {
      "destination": "/e6edbbff-61e7-45f1-ba77-015f410614b2/b261c171-d009-4324-8ab6-98b5a36cd75b/cc68b97a-54e4-4c35-b361-d7e723725072/739ae019-c85c-4e81-a5d5-e0fb0edd2fe5",
      "path": "/88d9f1f1-0fe4-4170-92e1-c4a8bd9ea3d3/9149160d-6d6d-40ae-bf6a-6b414e5134b7/609f1193-1634-4080-bd40-2cdf9eb80e43/9c40129c-ae2d-41eb-aa5b-4082702137b9/9b60b046-c754-4c8c-bc20-6adb4d083605",
      "type": "exact"
    }
  ],
  "schema_name": "redirect"
}

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