Skip to main content
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

{
  "analytics_identifier": "risus massa interdum. Pellentesque nibh sagittis suscipit bibendum. risus netus est. amet, sollicitudin non egestas. Sed Quisque Nam Mauris tristique dolor et nibh. purus Aenean turpis vel Lorem adipiscing molestie vel finibus, molestie scelerisque. eu aliquet. ipsum habitant tempor nisl sit ac",
  "base_path": "/2c11f04c-ab02-4b09-a7f0-c5a392a42dcd/f17d10df-9316-467f-9d5d-3c39152e5032/330ae59b-1514-4660-a66a-97f5df61b21c",
  "content_id": null,
  "description": null,
  "details": {
    "alternative_path": "http://example.com/3fd49a3e-6030-437b-8fac-cf0f86d3d4da/b7dd77f4-7481-46d4-b394-062c11a596b4#f4f0a1ecb8fa981f20b96298e91c8767"
  },
  "document_type": "gone",
  "first_published_at": "2019-07-28T00:42:23+00:00",
  "links": {
    "children": [
      {
        "analytics_identifier": "finibus, nisl ac scelerisque. ac elit. ac amet, Nam porttitor non libero. hendrerit, Quisque sagittis aliquet. fames non Duis dolor egestas. in, dolor risus vel eros. sollicitudin tristique netus eu lorem et",
        "api_path": "/64cefeb2-b49d-482e-9e26-5c97baf311a6/b795d36d-d37e-4635-8e15-d30e8daa3044/2958520a-1668-46f3-8e63-10c419f931f8",
        "api_url": "http://example.com/54dd63bb-60db-45d1-a314-0a090efdef89/6d064e2b-364d-4470-aea3-46b2f98f471b/76444bc3-7a66-4712-bbd6-f422324a6c5c/67b93fbd-d465-42a1-baae-6457dab568d2#e056cb23d7aa1ca78051a75600abcf8b",
        "base_path": "/acec1f66-60e8-4b9d-8b4d-69ff0f077907/a153ab7d-e985-4d38-9d03-c33b7f282379",
        "content_id": "578f1680-06ab-4542-9078-b6afb289e8c4",
        "document_type": "suscipit Mauris vestibulum. sed adipiscing mauris cursus Nam et elit. Nam malesuada morbi nibh a dolor Aenean nisl risus ac amet, est. sem Duis sollicitudin libero. nibh. eu ipsum habitant tristique sagittis Ut lectus lorem vel purus in, consectetur interdum. Sed risus Pellentesque Ut ac non leo dolor tristique pellentesque turpis volutpat molestie non sit senectus bibendum. finibus, tempor ac at ac eu imperdiet vel scelerisque. eros. aliquet. ultricies fames tempor egestas. Suspendisse et hendrerit,",
        "links": {
        },
        "locale": "kk",
        "public_updated_at": "2019-08-17T23:21:33+00:00",
        "schema_name": "Lorem ac fames interdum. tempor elit. Pellentesque porttitor sed eros. morbi Duis habitant eu interdum. mauris ac egestas. Sed Mauris lectus ac netus est. Ut et imperdiet tempor risus vel aliquet. Quisque risus bibendum.",
        "title": "massa mauris leo risus Duis eros. tristique ipsum amet, vel Lorem morbi Ut est. molestie sit lorem molestie lectus porttitor tempor Aenean non sollicitudin interdum. et aliquet. libero. habitant purus hendrerit, tristique a et malesuada pellentesque sed Pellentesque nisl at vel risus in, dolor sagittis egestas. Ut vestibulum. Sed Nam consectetur Nam sem interdum. Mauris scelerisque. orci nibh nibh. finibus, eu senectus imperdiet ac non ultricies Quisque tempor Suspendisse bibendum. ac turpis ac elit. cursus ac"
      }
    ],
    "document_collections": [
      {
        "api_url": "http://example.com/041a12bc-2bed-4525-be9f-993859c2a52f/c0934614-6643-49ee-899d-a20f09f63843/a2899c3a-35c9-4065-8a60-c529a148db1c#54b10e10c8d805a6068b9c4dcab5b9aa",
        "base_path": "/65ab4a46-3a98-469c-986b-e65fe418fd3e",
        "content_id": "28f0b776-6a60-4e5d-a773-4e14a412baea",
        "document_type": "malesuada et orci habitant ac Nam Mauris sit purus leo egestas. a vel lectus non eu Aenean imperdiet sollicitudin cursus Lorem Duis nibh Nam Suspendisse ac pellentesque ultricies turpis hendrerit, ac morbi lorem bibendum. interdum. consectetur tristique massa Sed vel vestibulum. tempor tristique et scelerisque. tempor dolor amet, aliquet. sagittis adipiscing eros. Quisque finibus, netus non nibh. dolor risus ipsum elit. ac risus libero. senectus at interdum. eu Ut est. sed molestie",
        "links": {
        },
        "locale": "ru",
        "public_updated_at": "2019-10-20T18:48:24+00:00",
        "title": "Duis fames Ut habitant ac et lectus in, risus Aenean vestibulum. turpis finibus, senectus Quisque Sed amet, molestie malesuada risus ipsum non suscipit ultricies sed Suspendisse ac interdum. tristique tristique Ut est. sem non orci purus molestie massa scelerisque. ac nisl sollicitudin nibh. sagittis at bibendum. elit. dolor eros. imperdiet porttitor eu sit vel libero. egestas. tempor mauris pellentesque eu cursus Pellentesque a consectetur nibh volutpat leo hendrerit, adipiscing et dolor lorem aliquet. netus interdum. Nam Lorem Mauris morbi Nam vel ac tempor"
      },
      {
        "base_path": "/a4406e59-ee88-4bed-acd7-267417c41702/d8f32448-d6a8-4994-bc47-57cd9a1917d4",
        "content_id": "85285946-d099-417e-aaec-8ed56e5e0f92",
        "document_type": "porttitor tempor in, libero. Pellentesque habitant Mauris nisl ac hendrerit, vestibulum. tristique et vel Lorem molestie ultricies eros. sed risus consectetur fames",
        "locale": "pt",
        "schema_name": "Duis amet, purus egestas.",
        "title": "vestibulum. libero. morbi cursus egestas. volutpat amet, pellentesque hendrerit, ac Ut risus dolor vel turpis Ut Sed adipiscing"
      }
    ],
    "part_of_step_navs": [
      {
        "analytics_identifier": null,
        "base_path": "/e2cc70da-738b-46de-b51b-d9efc8f9bc36",
        "content_id": "6886051a-d849-4ac9-b3dd-2984f548f742",
        "document_type": "Duis tempor Nam Quisque senectus non Pellentesque sed est. amet, vestibulum. risus a habitant bibendum. Aenean dolor non dolor molestie egestas. purus nisl ac hendrerit, eu leo Lorem nibh netus finibus, cursus morbi elit. malesuada ultricies ipsum scelerisque. turpis adipiscing in, vel lorem et massa eu pellentesque libero. Sed tristique Ut sit lectus risus sollicitudin Nam interdum. Ut fames Mauris mauris ac ac porttitor vel ac sagittis at consectetur suscipit nibh. aliquet. interdum. eros. et tristique volutpat",
        "links": {
        },
        "locale": "kk",
        "public_updated_at": null,
        "title": "interdum. tristique hendrerit, a vel habitant fames Suspendisse Aenean non pellentesque imperdiet cursus egestas. ac consectetur molestie et ac mauris Nam dolor tempor lectus tristique Ut risus finibus, sollicitudin tempor purus nibh massa interdum. bibendum. Lorem vestibulum. eros. molestie sem dolor netus Ut malesuada Duis Nam ultricies ac Quisque vel aliquet. Mauris nisl nibh. elit. morbi lorem leo",
        "web_url": "http://example.com/f4797f0a-869f-496f-b335-b1047a8201c8/fa70bf00-6beb-49a1-8e96-111d5511cb9a/bbb0d26b-f8dd-45ca-8e5c-531600a85ab4/21ec761e-f2db-4645-9c8e-6c02af1141f1#71378d8432c862662ec0cc404a4e58c0"
      }
    ],
    "topic_taxonomy_taxons": [
      {
        "api_url": "http://example.com/abc5523a-acc1-4161-a558-035d2297190e#0fdd0199ec0330842fbb7e375460f08b",
        "base_path": "/c6de6f1f-9d2d-4431-90e7-3a082baee99b/c4d03149-d39b-4c63-a736-d4af0664ca22/dd4ba5ec-f355-4c22-a0b1-195b6d73f703/cc0e8eff-f4ea-40f6-bb7d-4e27de8d766d",
        "content_id": "9634a4b4-e839-4b45-87b9-e6a2113e63c5",
        "links": {
        },
        "locale": "hi",
        "public_updated_at": "2019-09-20T03:26:16+00:00",
        "title": "sagittis egestas. eros. morbi fames tempor nibh nibh. adipiscing non ultricies eu porttitor non Mauris sed vestibulum. et hendrerit, elit. Nam est. risus mauris netus aliquet. vel volutpat ac at pellentesque",
        "web_url": "http://example.com/98186248-71d1-4611-88c8-abb41c1bfa02#076b295acd861a0af69a8f2698597fe8"
      },
      {
        "api_url": "http://example.com/29e62735-57b0-4a0e-a2a1-0357dc02d63c/1a838c74-588b-4d3b-86ae-9f712e002bc5#dd4c3e08b32ab4c8fe2acb05201620dd",
        "base_path": "/b3dcf114-e3c1-4946-a416-246b3f0214c5/44fee2d6-2602-43b0-9aa1-7001bb8960aa",
        "content_id": "416e318f-c9d0-4338-a41f-df2e73362450",
        "links": {
        },
        "locale": "hu",
        "title": "sollicitudin Sed risus Ut massa tempor nibh. netus at non ultricies"
      },
      {
        "analytics_identifier": "in, scelerisque. porttitor tristique Lorem purus Duis nibh. morbi tempor Ut turpis Nam elit. eros. amet, dolor molestie pellentesque hendrerit, adipiscing lorem nibh eu dolor leo sagittis netus Pellentesque a lectus non vestibulum. et molestie volutpat vel malesuada interdum. ac sed tempor Suspendisse non risus ultricies suscipit sem nisl aliquet. libero. Aenean orci Nam risus Quisque cursus ac",
        "api_path": "/17904942-cc14-4d4e-85e7-efb731117ec4/52aa0567-f111-438f-8ebf-1c84883d6087/4e7864f8-ceec-40d5-97e9-1fbd3dd94798/3405d7fa-2f66-4cfa-bff8-89bab378cd60",
        "base_path": "/7c7f897d-b19c-4175-89c0-3a3050303e1a/8bfa9e03-883a-45f0-af9e-9fc3160d51a2",
        "content_id": "d818b173-ae0e-4a88-8987-0aff5b1dc05e",
        "document_type": "et tristique dolor eu risus at in, adipiscing amet, eros. non a sem Suspendisse volutpat finibus, tempor Quisque libero. turpis massa vel senectus vestibulum. lorem ipsum ac fames nibh sagittis Nam interdum. Ut Mauris cursus Aenean nisl hendrerit, tempor lectus eu Sed et est.",
        "links": {
        },
        "locale": "da",
        "public_updated_at": null,
        "schema_name": "imperdiet interdum. Lorem elit. fames ac orci massa lorem finibus, adipiscing non at Mauris eu libero. consectetur pellentesque vel Pellentesque molestie dolor ac eu Sed tempor aliquet. porttitor a bibendum. habitant egestas. risus sed suscipit in, vestibulum. Quisque Ut hendrerit, netus scelerisque. est. sem ac nibh. tristique turpis ultricies risus sagittis interdum. sit Nam morbi mauris purus amet, eros. sollicitudin leo vel non molestie et Duis Aenean tempor nisl nibh malesuada dolor ac lectus ipsum Nam cursus et Suspendisse senectus Ut volutpat tristique",
        "title": "mauris sagittis ac tristique suscipit Ut est. fames massa interdum. aliquet. in, morbi molestie et senectus amet, non adipiscing et ipsum imperdiet nibh. vel Nam tristique porttitor molestie Sed libero. nibh dolor Nam at risus nisl eu consectetur turpis egestas. eros. scelerisque. tempor sit ultricies non cursus Suspendisse leo vestibulum. risus vel lectus Lorem Duis dolor elit. tempor eu netus ac Pellentesque sollicitudin a Aenean pellentesque volutpat orci interdum. Ut ac sed Quisque ac lorem Mauris hendrerit, habitant finibus, purus sem bibendum. malesuada"
      },
      {
        "base_path": "/e6a34020-3260-44fa-b45d-c7460c51daf0/4a7bab5a-60f2-40a2-bf64-53dac6f0b0e9/27c6b12f-83e4-48cf-855b-384ab99e6fbb/02529bd6-f44f-44dc-89e8-39fc6c54c643",
        "content_id": "db9b37d2-f553-42c9-9dc4-a3e379902d41",
        "document_type": "et risus cursus Mauris sit eu lectus tempor elit. porttitor adipiscing ipsum Suspendisse ac eros. dolor senectus in, interdum. vel ac sem Aenean ac egestas. dolor",
        "links": {
        },
        "locale": "ms",
        "public_updated_at": null,
        "schema_name": "Pellentesque Ut vestibulum. hendrerit, scelerisque. turpis cursus morbi vel bibendum. sit eu dolor elit. senectus sem finibus, eu est. nibh. imperdiet at sollicitudin Aenean amet, pellentesque Quisque molestie porttitor purus massa non nibh ac ac non a libero. adipiscing volutpat fames risus Nam lectus egestas. leo sagittis tristique in, malesuada lorem ipsum ac Suspendisse Lorem dolor molestie Sed netus et Mauris interdum.",
        "title": "dolor Sed a molestie imperdiet sem tempor Ut finibus, sagittis amet, egestas. suscipit aliquet. at morbi tristique purus orci et",
        "web_url": "http://example.com/627969ab-00e5-417e-a82f-951579194908/1ec58b32-9d62-419f-84da-340517f9d390#c7e849e55f217a6d96c88138f1265580"
      }
    ]
  },
  "locale": "ru",
  "phase": "beta",
  "public_updated_at": "2019-11-08T02:53:38+00:00",
  "publishing_app": "feedback",
  "publishing_request_id": "ac ipsum",
  "rendering_app": null,
  "schema_name": "gone",
  "title": null,
  "updated_at": "2019-08-18T07:21:13+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
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.
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": null,
  "change_note": "fames Mauris et ac massa nibh. non netus malesuada sollicitudin interdum. tempor sed Nam ac molestie vel vestibulum. Quisque dolor habitant eros. porttitor eu sem",
  "description": null,
  "details": {
    "alternative_path": null,
    "explanation": "leo nibh nisl ac suscipit risus Ut massa lorem aliquet. Ut elit. dolor et dolor eu Suspendisse a lectus Nam at finibus, amet, eros. fames bibendum. volutpat interdum. mauris est. pellentesque molestie non interdum. morbi orci ipsum nibh. libero."
  },
  "document_type": "gone",
  "first_published_at": "2019-07-26T10:04:49+00:00",
  "last_edited_at": "2019-11-10T11:58:35+00:00",
  "phase": "beta",
  "publishing_app": "frontend",
  "redirects": [
    "tristique sollicitudin ipsum vel ac leo lectus fames molestie est. egestas. libero. Aenean dolor ac bibendum. morbi Sed eros. ac Ut massa suscipit tempor imperdiet porttitor interdum. et Nam risus dolor nibh eu non malesuada adipiscing interdum. risus at tristique orci nisl scelerisque. Mauris mauris finibus, Lorem eu volutpat vestibulum. non consectetur ultricies Duis netus sit Suspendisse turpis amet, Nam senectus molestie et habitant ac tempor Ut hendrerit, sem nibh. vel sagittis pellentesque Quisque sed elit. a aliquet. purus in, lorem cursus Pellentesque",
    "ac sagittis in, molestie pellentesque Duis volutpat est. porttitor aliquet. fames a sed tempor sit nibh purus non cursus elit. ac vel scelerisque. tempor at Pellentesque dolor Sed risus massa Nam eros. suscipit ac imperdiet finibus,",
    "vel ipsum cursus finibus, tempor eu interdum. Ut Duis scelerisque. ac volutpat hendrerit, bibendum. a eu leo",
    "",
    "vestibulum. volutpat aliquet. lorem vel habitant sollicitudin leo ac nibh Mauris Duis netus tristique ipsum Nam molestie ultricies dolor dolor a eu et adipiscing cursus amet, Quisque purus in, eros. tempor Nam Ut scelerisque. tristique risus ac Pellentesque fames porttitor Suspendisse lectus imperdiet libero. bibendum. malesuada senectus finibus, Lorem est. consectetur egestas. tempor morbi eu massa turpis non sem molestie ac et sed Ut orci hendrerit, non risus nibh. interdum. Aenean mauris suscipit ac interdum.",
    "vestibulum. dolor in, orci at"
  ],
  "schema_name": "gone"
}

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
}