Table of contents

Schema: gone

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
alternative_path
["string", "null"]

change_history
array

explanation
["string", "null"]

document_type
string

Allowed values: gone
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
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, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, 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, local-links-manager, 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

rendering_app
null

scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: gone
title
null

updated_at
string

withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "base_path": "/4afff19d-7185-43b2-907c-9981300635c1/f01bfffd-3313-456f-8a25-095fd836c077/949bd1b8-810a-4bfe-b586-08351862ae5f",
  "content_id": null,
  "description": null,
  "details": {
    "alternative_path": "http://example.com/3473ef71-c7f0-4922-9060-cd7e8368485e/f05d052c-6794-4d45-9907-f59ec8d65b85#f6a33590375fc3f1a78c133819fa6470",
    "change_history": [
      {
        "note": "tempor finibus, Ut eu Duis netus volutpat et eu sit Aenean Nam ac lectus senectus ac scelerisque. sagittis tempor molestie egestas. interdum. ipsum Nam ultricies Suspendisse porttitor risus morbi Pellentesque massa hendrerit, molestie non lorem non Lorem nibh. dolor elit. et bibendum. vel habitant",
        "public_timestamp": "2019-07-22T00:36:46+00:00"
      },
      {
        "note": "pellentesque lorem eu imperdiet aliquet. lectus scelerisque. Aenean eros. netus volutpat fames consectetur interdum. vel nibh vel ac tristique Lorem nibh. at morbi purus Suspendisse molestie sagittis sed adipiscing tempor bibendum. Quisque et amet, orci sollicitudin sit ipsum turpis Nam a est. risus suscipit porttitor elit. Mauris vestibulum. et Ut",
        "public_timestamp": "2019-06-20T05:53:09+00:00"
      },
      {
        "note": "Ut turpis eu non risus est. tempor porttitor et nibh ac a sollicitudin netus senectus lectus massa adipiscing tristique ac dolor Aenean ac dolor nisl Pellentesque vestibulum.",
        "public_timestamp": "2019-05-20T12:28:36+00:00"
      },
      {
        "note": "ac Nam molestie sagittis aliquet. fames lorem suscipit elit. ultricies in, Sed scelerisque. et Lorem imperdiet hendrerit, sit eu consectetur risus cursus Ut tristique senectus Nam leo ac ipsum amet, pellentesque Ut purus sed bibendum. Mauris Aenean ac dolor tristique Duis finibus, Pellentesque Suspendisse eros. vestibulum. et vel lectus sem nisl molestie porttitor eu tempor interdum. Quisque dolor adipiscing ac non morbi volutpat netus nibh mauris non turpis malesuada est. risus interdum. egestas. libero. habitant orci at massa sollicitudin tempor nibh. vel a",
        "public_timestamp": "2019-06-14T11:56:55+00:00"
      },
      {
        "note": "Nam Ut Nam morbi elit. interdum. tristique nisl vel Lorem tempor sed netus adipiscing nibh tempor habitant mauris Sed a Mauris nibh. ac molestie purus orci risus et sollicitudin non scelerisque. porttitor ac Pellentesque turpis molestie vestibulum. hendrerit, vel ac sem at massa egestas. eros. Ut suscipit amet, malesuada interdum. libero. imperdiet sit tristique eu Quisque pellentesque ultricies Duis consectetur dolor finibus, cursus aliquet. fames et sagittis lectus Suspendisse lorem non ipsum est.",
        "public_timestamp": "2019-09-03T10:53:50+00:00"
      },
      {
        "note": "mauris nibh. sit ipsum at Ut tristique ac interdum. eros. Duis pellentesque turpis aliquet. sed tempor sagittis egestas. sollicitudin non ac lectus elit. et non orci imperdiet interdum. risus tristique amet, molestie risus ac Suspendisse volutpat senectus bibendum. ac nibh finibus, dolor suscipit",
        "public_timestamp": "2019-08-03T12:55:30+00:00"
      },
      {
        "note": "Duis vestibulum. libero. malesuada mauris tristique interdum. lorem cursus in, non porttitor hendrerit, Pellentesque tristique risus purus vel Nam ac habitant dolor orci Quisque et molestie imperdiet",
        "public_timestamp": "2019-07-19T18:14:33+00:00"
      },
      {
        "note": "mauris et Suspendisse turpis habitant consectetur",
        "public_timestamp": "2019-08-30T01:34:25+00:00"
      },
      {
        "note": "non orci Quisque Ut adipiscing vestibulum. ac vel dolor suscipit interdum. habitant finibus, amet, Suspendisse nibh pellentesque fames lorem eu sit cursus est. malesuada risus ipsum netus Pellentesque in, ac senectus dolor sollicitudin tristique nibh. libero. eros. eu morbi sagittis Aenean egestas. Lorem molestie at",
        "public_timestamp": "2019-08-25T16:24:49+00:00"
      },
      {
        "note": "Nam sem eros. libero. sagittis Nam Sed sed leo adipiscing et ultricies fames at ipsum",
        "public_timestamp": "2019-08-07T05:49:17+00:00"
      }
    ]
  },
  "document_type": "gone",
  "links": {
    "document_collections": [
      {
        "api_url": "http://example.com/e7ebf977-74bc-4439-a192-fb18f172b2a0/884fa52e-7eb8-4f4e-8fa3-5e9d24578546/ae69aef7-17be-49c2-9a54-0372da6a0481/245e0d1e-e65c-48c8-819f-1f023a517860/5efc1a66-d5f1-4084-b8f8-29756900e7bc#1026b7120ececb1b78b5a5b62c1e28e5",
        "base_path": "/56805fb7-aa10-4ca8-99a5-f4fac33162c8/f45cc4d7-66e3-4e09-8e19-3909b0808f64/8309da53-87e3-497e-bab8-ae40ab047649",
        "content_id": "2d9a8bf1-2587-4210-86d3-59269343ae6f",
        "document_type": "ultricies purus nibh. Suspendisse Quisque fames suscipit mauris elit. Lorem consectetur orci imperdiet morbi bibendum. ipsum eu est. eros. cursus netus non interdum. interdum. massa molestie amet, nisl ac Ut Aenean finibus, in, non tristique",
        "locale": "bn",
        "public_updated_at": null,
        "schema_name": "nisl volutpat non sed Ut suscipit sem non Pellentesque et scelerisque. Lorem ultricies morbi orci at vel Quisque Aenean senectus porttitor molestie Ut leo vestibulum. Nam interdum. Nam bibendum. turpis tempor pellentesque tristique egestas. hendrerit, nibh risus tempor sagittis elit. mauris aliquet. est. Mauris risus in, netus purus interdum.",
        "title": "eu hendrerit, Nam habitant interdum. Nam dolor Quisque Sed et a ipsum Suspendisse est. senectus amet, Ut risus bibendum. vestibulum. volutpat porttitor ac consectetur nisl sit at Ut mauris interdum. sollicitudin purus nibh. imperdiet morbi libero. scelerisque. massa fames aliquet. Mauris malesuada eros. molestie tristique"
      },
      {
        "base_path": "/1f571dc7-b7cc-417c-9000-62061d77ffb1/8f6eea16-1e22-4ac5-8860-8ad91481e218/2b6d6536-4ee8-4a0e-b34d-985750a29cba",
        "content_id": "a5b9b475-bd04-4e18-bbed-eb138e042ae1",
        "locale": "ka",
        "title": "et scelerisque. eros. malesuada vestibulum. imperdiet consectetur vel volutpat molestie lectus Mauris netus turpis interdum. ipsum Ut Sed sem finibus, lorem est. morbi ac sit nibh Nam tristique sed porttitor suscipit in, hendrerit, purus ac risus eu fames et mauris Lorem egestas. tempor at amet, adipiscing molestie libero. aliquet. Suspendisse elit. Nam ultricies habitant dolor a cursus sollicitudin Duis pellentesque sagittis Quisque tempor eu massa ac orci nibh. non tristique nisl bibendum. Aenean",
        "web_url": "http://example.com/1b465a47-30f1-4963-bb03-4194e1fb4aef/ae3b40da-55f3-46d7-83a6-65a4de4fd899#042b05f8e3e4df13d9364e3cc07f83ad"
      }
    ],
    "secondary_to_step_navs": [
      {
        "analytics_identifier": "ac non hendrerit, risus nibh. Quisque suscipit egestas.",
        "api_url": "http://example.com/f48dccc2-6b2d-4759-bb4a-5ef5f3783ea4/3fb3990f-3965-4c39-89c5-9ea77bd2d6c9/2fe9dbb9-2a6e-48ee-9813-fee08a052c27#f56ea1d8ad749d7bc2cd6551bc5cc10c",
        "base_path": "/12a754a9-beda-43d5-b364-e35cc311b68f/6b675032-e9b6-4398-9c95-f5d518b73929/959e1e7f-e651-490f-8449-70a85c00d865/f82a5659-9aa6-42da-872b-ec18fc10cf5c",
        "content_id": "bd4dbdd6-e1d4-4fd0-8538-aed534d4be92",
        "locale": "fr",
        "schema_name": "ac sit nibh nibh. ac fames tristique Sed elit. Quisque molestie Nam",
        "title": "et orci Mauris sed aliquet. finibus, interdum. Aenean a habitant senectus cursus Suspendisse dolor non in, nibh. eu imperdiet Nam nisl suscipit scelerisque. tempor est. Nam sem eu lectus vel leo Ut ac risus Lorem consectetur volutpat mauris Quisque tristique vel eros. tristique malesuada ac hendrerit, Pellentesque nibh sagittis porttitor sit sollicitudin risus bibendum. ipsum amet, Sed et non netus ac ultricies elit. dolor Ut at morbi fames Duis interdum. egestas. libero. molestie tempor purus massa pellentesque molestie vestibulum. adipiscing",
        "web_url": "http://example.com/d453b87f-51a9-4a1b-9741-263f51948d8d#61283d82a2cb994ad716fa9e82fed559"
      },
      {
        "api_path": "/1792b8ef-3f3f-46a1-af38-91c62b1b8ad8/54b5812d-f657-46ed-b3aa-ea2061dcd226/05ffc12c-1ecd-4518-8105-2256ce9ff35a/ebdbc91b-d74a-410e-a49d-d9550956fd65/553ffe18-b513-4b1a-b2b7-a4de4f1ac7d3",
        "base_path": "/9b951632-da51-4f16-a132-2bd58439ebdd/c92cde55-6bd7-4d46-ba4f-e8219c792bf4",
        "content_id": "0319a27b-1c12-4d30-b33e-15df275f833b",
        "document_type": "leo aliquet. egestas. eros. sit fames molestie Nam bibendum. vel eu Duis Sed ac dolor Pellentesque consectetur interdum. ultricies est. porttitor ac Ut ac imperdiet hendrerit, eu amet, netus volutpat turpis Aenean risus vel sed non massa sem risus Quisque adipiscing tristique lorem Nam finibus, cursus mauris malesuada sollicitudin dolor interdum. nisl scelerisque. tempor nibh. tempor purus ac et lectus molestie tristique at non Lorem Suspendisse Ut orci a pellentesque elit. habitant suscipit in, senectus morbi",
        "locale": "zh",
        "title": "habitant purus ipsum non Duis consectetur sit leo finibus, eu nibh. scelerisque. nisl a elit. molestie volutpat sagittis tempor ac vestibulum. Suspendisse turpis ultricies orci tristique in, sollicitudin bibendum. mauris molestie cursus morbi netus imperdiet ac malesuada egestas. pellentesque ac aliquet. Ut nibh vel senectus Mauris massa eros. sem dolor suscipit vel ac interdum. Nam sed risus eu Nam Aenean Ut non fames adipiscing Lorem risus hendrerit, Pellentesque at Sed dolor amet, libero. lectus porttitor et tristique Quisque tempor lorem est. et interdum."
      },
      {
        "api_path": "/89ad4bb4-5f2b-4540-af0d-19b44cbf9c9d",
        "base_path": "/572fd205-02db-4baa-94ed-0e6abcd8a80e/e9be06ef-02af-4ca2-af93-1e9f9f4435c1/3d371165-e8aa-41bc-8c02-a1a7ebfe94aa/9f1ec6a2-006d-42bd-aaba-c9ba13d65ffa/3d590545-de64-4326-8e1c-5d559b828bf7",
        "content_id": "f02da4a5-6eef-4a47-acf4-d33a8013235d",
        "links": {
        },
        "locale": "sw",
        "public_updated_at": null,
        "schema_name": "Mauris sagittis cursus et vestibulum. Pellentesque eu Aenean malesuada Duis eros. Ut",
        "title": "cursus Nam adipiscing lorem porttitor est. Quisque sem molestie libero. scelerisque. non leo egestas. risus eros. purus nisl fames nibh. massa sollicitudin volutpat ipsum eu sagittis eu in, sit vel at hendrerit, sed nibh vestibulum. et ac pellentesque lectus et Pellentesque dolor ac a molestie interdum. tristique consectetur vel Suspendisse elit. morbi Nam ac tristique mauris Ut Duis Aenean amet, finibus, senectus turpis Mauris suscipit Ut ultricies interdum. malesuada tempor risus aliquet. Lorem",
        "web_url": "http://example.com/a61734b5-b6a3-4258-9de1-54347d1a18e0/d5fd9c78-85ed-406f-8995-61ee4e3881fa/22d17745-c792-4846-9bd5-eeceaf3e1826/d68a86af-b583-47ec-9e06-7a1be6f2f417#bc9a0e6efbcb7f6d1de2b1cefc2c7b08"
      },
      {
        "api_path": "/23a15e19-9990-40bd-9d67-6752dc0480f3/6dd82e54-b4c0-4a4d-950a-33d079dc5e51",
        "api_url": "http://example.com/f402f4db-0059-43b3-8150-452562437c2b/334b985f-09fa-420c-9429-b25202ff17ca/24981c24-a53b-4aed-a0ae-bd7c0aa73750#c8737db4ad88982e8e16dfc220638ad1",
        "base_path": "/cdef03f1-d6b4-4a9e-b383-342e867350dc/b64c299f-2bdc-4ad9-84b5-08234630308a",
        "content_id": "a4c96502-f920-475e-a4e4-8166a9e9e5d4",
        "document_type": "Nam morbi tempor Suspendisse scelerisque. lorem tristique Pellentesque adipiscing Aenean massa Sed nibh. ultricies pellentesque non Quisque leo consectetur Ut ac tempor turpis eros. imperdiet ipsum Duis cursus a ac amet, sem hendrerit, sed vel Mauris Nam non tristique risus ac finibus, egestas. et porttitor ac dolor risus aliquet. suscipit nisl sagittis eu lectus at dolor vel mauris malesuada molestie senectus Lorem volutpat interdum. netus purus in, sit habitant bibendum. libero. elit. molestie vestibulum. et interdum. nibh sollicitudin Ut est. eu fames orci",
        "links": {
        },
        "locale": "dr",
        "public_updated_at": "2019-06-02T03:33:47+00:00",
        "schema_name": "Aenean purus a interdum. scelerisque. massa tempor at eros. risus amet, bibendum. in, sagittis lectus tristique Nam vel nibh. nibh Sed Lorem sem egestas. ac netus tristique Ut lorem et Quisque",
        "title": "a finibus, Nam cursus imperdiet orci habitant Lorem sollicitudin nibh nibh. leo Ut ac et Nam sit vestibulum. consectetur netus Ut ipsum vel tempor et sed lectus risus suscipit scelerisque. eu eu at fames"
      }
    ]
  },
  "locale": "cy",
  "phase": "live",
  "public_updated_at": "2019-09-04T15:56:45+00:00",
  "publishing_request_id": "imperdiet cursus tempor habitant et dolor turpis adipiscing consectetur et fames eu morbi hendrerit, sollicitudin vel elit. porttitor ac ac molestie risus ultricies Ut non aliquet. molestie nibh Lorem lectus tempor bibendum. nisl Sed Pellentesque mauris sagittis eu egestas. Aenean nibh. vel Nam dolor suscipit est. massa senectus Duis tristique non Quisque sit eros. leo orci pellentesque Mauris",
  "scheduled_publishing_delay_seconds": null,
  "schema_name": "gone",
  "title": null,
  "updated_at": "2019-07-09T09:22:24+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
organisations
array

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

bulk_publishing
boolean

change_note
["null", "string"]

description
null

details
object
alternative_path
["string", "null"]

explanation
["string", "null"]

document_type
string

Allowed values: gone
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, kk, 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, local-links-manager, 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: gone
title
null

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "analytics_identifier": "non eros. risus tristique vel orci",
  "bulk_publishing": true,
  "description": null,
  "document_type": "gone",
  "last_edited_at": "2019-07-07T04:08:32+00:00",
  "phase": "alpha",
  "public_updated_at": "2019-08-24T03:18:38+00:00",
  "publishing_app": "manuals-publisher",
  "schema_name": "gone",
  "title": null,
  "update_type": "major"
}

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,
  "previous_version": "Ut scelerisque. Aenean sit Mauris vel eros. non Quisque lorem senectus a vel sagittis turpis mauris Nam libero. egestas. pellentesque porttitor elit. nibh Suspendisse nisl Lorem leo finibus, netus Ut est. risus purus fames Nam aliquet. ultricies consectetur tristique vestibulum. tempor"
}