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
string

content_purpose_document_supertype
string
Document supertype grouping documents by purpose
description
null

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

change_history
array

explanation
["string", "null"]

document_type
string

Allowed values: gone
email_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
first_published_at
or null

government_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
links
object
available_translations
Link type automatically added by Publishing API
child_taxons
Link type automatically added by Publishing API
children
Link type automatically added by Publishing API
document_collections
Link type automatically added by Publishing API
level_one_taxons
Link type automatically added by Publishing API
policies
Link type automatically added by Publishing API
locale
string

Allowed values: ar, az, be, bg, bn, cs, cy, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
navigation_document_supertype
string
Document type grouping powering the new taxonomy-based navigation pages
need_ids
array

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

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
publishing_request_id
A unique identifier used to track publishing requests to rendered content
rendering_app
null

schema_name
string

Allowed values: gone
search_user_need_document_supertype
string
Document supertype grouping core and government documents
title
null

updated_at
string

user_journey_document_supertype
string
Document type grouping powering analytics of user journeys
user_need_document_supertype
string
DEPRECATED. Use `content_purpose_document_supertype`.
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "analytics_identifier": null,
  "base_path": "/67bca490-dbc6-44e5-9d60-b9266dd0e89e/55a702ed-122f-4b13-81af-ae62bdb49ed3/01b90e98-0c44-4f26-845e-6380f5c7201b",
  "content_id": "0db2b38a-ccbc-4f7c-bda6-89e28bbb18b9",
  "content_purpose_document_supertype": "Quisque imperdiet porttitor Duis molestie morbi lorem suscipit eros. ipsum in, eu sit ac hendrerit, ac est. sollicitudin consectetur a aliquet. dolor Ut vel vestibulum. interdum. habitant elit. risus",
  "description": null,
  "details": {
    "alternative_path": null,
    "change_history": [
      {
        "note": "Pellentesque mauris eu scelerisque. sed amet, turpis et non hendrerit, ac molestie porttitor a Mauris Ut Quisque ipsum nisl ac sit dolor Duis non eu lectus malesuada elit. Sed sem fames risus ac vel Lorem leo adipiscing egestas. morbi vestibulum. consectetur lorem vel eros. orci at nibh. Ut risus netus Suspendisse sollicitudin tempor libero. bibendum. sagittis Nam massa ultricies est. interdum. dolor tristique tristique volutpat Nam ac Aenean senectus finibus, et in, cursus tempor",
        "public_timestamp": "2017-10-22T20:03:50+00:00"
      }
    ]
  },
  "document_type": "gone",
  "first_published_at": null,
  "links": {
    "available_translations": [
      {
        "analytics_identifier": null,
        "api_path": "/1d025fe9-fb23-432f-83f3-5242362125ee",
        "api_url": "http://example.com/c3fcee8c-32c3-4649-8f71-75a73432f43e/91060073-0f1a-4b6b-b5dd-f8c263f21cea/6de111db-60b1-43e9-a38a-f4cbe442502f#31a2671dcb26d0708aecc798d8c399d8",
        "base_path": "/34f78c47-9a67-4eea-a9fb-95f7f30f4715",
        "content_id": "eaeda5e5-86fb-4f02-a64d-2d01bd868858",
        "links": {
        },
        "locale": "tk",
        "schema_name": "lectus at ac non finibus, egestas. interdum. nibh",
        "title": "sem Ut scelerisque. Lorem mauris vel nisl malesuada sagittis leo risus sollicitudin Ut finibus, egestas. pellentesque Pellentesque amet, lorem molestie ac senectus ac ultricies aliquet. hendrerit, orci Sed nibh. Mauris tristique Duis interdum. at a est. dolor Suspendisse cursus massa et tempor in, molestie adipiscing suscipit consectetur habitant elit. sed fames dolor non vel eu",
        "web_url": "http://example.com/380f3c78-b31c-4312-9391-82e0e740557a/e37df463-0f6c-43e6-b0a6-25c8151eb556#5f1748adda4be9f8a4f58a2d3ea51bca"
      },
      {
        "api_path": "/860be4c2-f174-4de5-8d40-83b7e21d055d/dd890769-d855-4c3d-b62d-f672b20bd2bc/6e0c719e-1217-4951-96dd-e1e666f3c7d2/89a8a0fc-3638-4e11-b568-1545042a1cf1",
        "base_path": "/535562f9-1b69-4860-9516-d642024bf19f/dbc97892-e0c1-40b6-a3eb-0c91a07cb695/99e2994e-c212-4d2b-af3f-6c17440925a0/c365d39c-6b95-430f-b451-5dd5712df593/fcfc3b67-de19-45f4-b860-ae95df474628",
        "content_id": "35659673-0722-45f9-bfc3-1c842723e02e",
        "locale": "bg",
        "public_updated_at": null,
        "title": "non vel egestas. ac interdum. porttitor purus tristique habitant Pellentesque Sed et lorem elit. adipiscing nisl Nam Aenean hendrerit, sed morbi vel leo scelerisque. ac cursus Nam tempor mauris interdum. dolor nibh amet, senectus sagittis eros. molestie a libero. netus eu ac orci aliquet. ultricies et Quisque Ut lectus risus at pellentesque in, massa Mauris ac tempor molestie sit tristique bibendum. ipsum Lorem dolor suscipit volutpat fames imperdiet finibus, vestibulum. sollicitudin Duis risus turpis consectetur est. eu Suspendisse sem Ut malesuada nibh. non"
      },
      {
        "api_url": "http://example.com/5abd15c1-c791-4f14-afb2-12cb1a509b11/82839273-6436-40ff-9fa3-d45de605ba18/38cfcbac-5200-4319-b336-4d2576a2b539#4bef78821a25a81e228d1bd352432330",
        "base_path": "/c133676b-f26b-4dcd-b8a0-90ac59bd02df",
        "content_id": "a345d035-efdb-434e-b6a8-bcdbb5fa261e",
        "locale": "ps",
        "title": "non est. sem ultricies nibh. eu",
        "web_url": "http://example.com/e9addc70-f2a0-416f-959f-209ac1695062#3416fcea645cc719285203e0aeda0138"
      }
    ],
    "level_one_taxons": [
      {
        "analytics_identifier": "non massa molestie ac pellentesque ac turpis scelerisque. fames Nam eu vel nisl netus at consectetur tempor et ac risus senectus vel purus nibh. sed aliquet. Ut elit. Aenean ultricies Duis tempor libero. non Suspendisse est. ipsum sit",
        "api_url": "http://example.com/149a052a-1ae7-4c25-a300-f50958e2d1c7/bb2b4a76-2bf5-487b-80ae-b35850e44f60/3c1e249c-c365-417d-b1e8-ab737448d027/71fffeee-a8bb-4b96-a91b-792ceaac52e3/817bd272-a64c-42eb-8bfd-99088bdeb2b5#3d74773c7fcfc12c6713e107d42e33e8",
        "base_path": "/7fbe7ca5-c93f-4091-9cb7-638289aec1bc/36f595ec-58b3-474b-9643-71193238c7d0/5661a765-22fe-4cb2-852e-54b86c8cbe86",
        "content_id": "fb824aa8-8457-4b7c-a3f5-077d509851b1",
        "document_type": "dolor est. egestas. tristique ac nisl dolor purus libero. fames volutpat orci Suspendisse adipiscing tristique lorem pellentesque in, porttitor habitant massa interdum. eros. ac Nam a sit non at sagittis tempor morbi Quisque eu senectus sollicitudin molestie finibus,",
        "links": {
        },
        "locale": "sw",
        "public_updated_at": null,
        "title": "sit eu ac pellentesque netus morbi mauris vestibulum. sed vel sagittis sem massa leo Nam risus molestie ac imperdiet porttitor lorem nisl Lorem non risus dolor malesuada elit. ac dolor",
        "web_url": "http://example.com/fe7f874a-10e5-4c96-ad31-42b022152ad5#af200e5e51bc77b20647760361c35269"
      },
      {
        "analytics_identifier": null,
        "base_path": "/c70f6bab-93d1-463c-8753-a4994a0b94c1/309f2afd-ef34-47f4-826d-323511f1c868/329b8baa-9bc4-47b8-8b74-2b67f17845aa/1b12aa32-0af6-47db-955a-f8da53ce04ff",
        "content_id": "b2408230-e55a-46ea-8698-5053369f3d2b",
        "document_type": "cursus tempor tempor dolor Lorem ac interdum. interdum. nibh. Quisque lectus eu in, ac senectus eu adipiscing vel Suspendisse massa tristique vel Mauris ac eros. ipsum dolor volutpat purus Ut netus turpis imperdiet libero. morbi orci risus sit nibh amet, Pellentesque tristique finibus, sem a non molestie bibendum. ultricies risus egestas. Sed suscipit leo Duis elit. et porttitor habitant Nam pellentesque sagittis nisl Ut sollicitudin vestibulum. lorem consectetur molestie Aenean est. fames scelerisque. Nam at aliquet. non malesuada hendrerit, mauris sed ac et",
        "links": {
        },
        "locale": "be",
        "public_updated_at": "2018-01-07T13:26:48+00:00",
        "schema_name": "massa Aenean ac Suspendisse Quisque nibh Sed",
        "title": "dolor habitant sagittis scelerisque. Ut ultricies molestie Ut massa risus non eu malesuada consectetur aliquet. Aenean vestibulum. et fames sed ac vel Sed sem eu Duis Lorem cursus a porttitor Pellentesque mauris morbi interdum. suscipit tristique Nam sit eros. Quisque adipiscing ac at dolor turpis non nibh finibus, ac sollicitudin tempor libero. netus in, bibendum. hendrerit, risus nisl Suspendisse volutpat egestas. vel interdum. tempor nibh. est. orci imperdiet tristique pellentesque elit. et senectus Mauris Nam leo ac amet, molestie lorem ipsum purus lectus",
        "web_url": "http://example.com/2d1a0e1a-fd81-40d3-b44d-e0f1d8d974c8/9cadee8e-d41c-4424-8a19-bee16c115b42/80c2eedc-31fa-49ec-8648-323f9c82b5b5/51f4184f-bd4c-4ed8-8b57-5636baf1409a#096fa76c4fdfeb2d9f1a16119c84e8be"
      },
      {
        "api_url": "http://example.com/dbb7047c-8098-4b97-8486-e2380bcad555/ba632790-e59a-439a-877f-7682d89e0789/48d46999-9f3f-4a62-bc86-a82f40565214/86dda44c-f6ac-49a3-9f81-16536e575227/938b91b3-02c4-4f98-bc74-317f71d6699e#b1f76348f254f18bab552a032457a079",
        "base_path": "/671760a4-fc53-41df-816e-ae65bf3a822d/9ac20fa5-1c1c-4f72-9c71-6ef219579367/19df81f7-4406-4e2a-961a-f17634dcecde/edf5de31-3c4e-43e7-a028-c71315d5d3a9/571a2752-7472-4ca8-be1d-75ce113ef2bc",
        "content_id": "022f8724-ff6b-4277-accf-a996b7a9b67c",
        "links": {
        },
        "locale": "fa",
        "public_updated_at": "2018-01-30T10:42:44+00:00",
        "title": "habitant Nam finibus, elit. Ut at eros. pellentesque nisl fames leo vestibulum."
      },
      {
        "base_path": "/191bdbab-2234-4d4c-ae7d-580c9b714d88/5772a310-be8a-4a11-bb0f-5c70d6d750a1",
        "content_id": "ddb22e62-dda7-4825-86f0-6038736035fe",
        "locale": "id",
        "public_updated_at": "2018-02-05T18:37:19+00:00",
        "title": "habitant hendrerit, ultricies Duis scelerisque. at nibh molestie Pellentesque mauris sed amet, fames tempor nibh. volutpat senectus in, Lorem tristique est. sit a non Mauris molestie non pellentesque sollicitudin ac"
      },
      {
        "base_path": "/f5b2af14-befa-44d2-bb84-b1a69a25c942/960ce869-57eb-40d4-b96d-cf1d05011c56",
        "content_id": "7b051e8a-c4c8-42ac-acdf-271d6f5442d9",
        "document_type": "senectus Nam suscipit Ut adipiscing scelerisque. Suspendisse lectus consectetur dolor pellentesque sagittis ipsum vel imperdiet tempor habitant morbi et vestibulum. netus eros. molestie nibh in, tempor dolor cursus ac vel sit molestie mauris nisl ac fames interdum. nibh. aliquet. risus at non porttitor Quisque Lorem non orci eu tristique ac a malesuada ac Pellentesque est. et sollicitudin Aenean Ut Duis Nam lorem leo eu tristique volutpat interdum. hendrerit, risus sem libero. purus ultricies amet, massa elit. egestas. turpis Mauris finibus, Sed",
        "links": {
        },
        "locale": "hu",
        "public_updated_at": "2017-12-21T04:39:54+00:00",
        "schema_name": "et Quisque vel Sed lectus nibh Mauris ultricies eu tempor aliquet. est. molestie non risus dolor tristique Ut ac eu massa ipsum volutpat finibus, vel habitant leo pellentesque malesuada sit turpis elit. tempor Aenean in, interdum. hendrerit, a Suspendisse fames",
        "title": "hendrerit, orci scelerisque. purus Sed interdum. eu Nam"
      },
      {
        "api_url": "http://example.com/72ac30ca-1767-4772-a686-9a51a29bc05f/dbb105e3-4222-44be-b8a3-5510e46442ec/1eeee1e9-407f-4b7b-8b1e-932dfaa0a53a/8a114b4a-bb56-49be-8981-c1f003446639/19738f02-3604-4b3d-aa51-05cbed18b551#f43a4e12cbe74014252e8aa8c5aaa7bf",
        "base_path": "/b3ccc1f2-2d09-4dca-ae25-8d08b8bcaa43/d2f134a7-5fbb-4498-bdb7-854e056a27a3/90658639-10d0-454b-8fd7-df7bcb85b230",
        "content_id": "a2ab3947-9a6f-4096-b930-1023bd982179",
        "locale": "hi",
        "public_updated_at": "2017-12-04T10:26:51+00:00",
        "schema_name": "molestie Duis fames Sed ac sem lorem sollicitudin finibus, orci bibendum. habitant dolor molestie risus scelerisque. netus volutpat vel Nam amet, in, a pellentesque hendrerit, elit. nisl Quisque at tristique non eros. eu vestibulum. risus consectetur leo non et eu tempor vel ac Suspendisse interdum. aliquet. sit egestas. Aenean Ut ultricies tempor massa morbi et Ut adipiscing nibh sed suscipit dolor Lorem ac Mauris imperdiet lectus interdum. ac sagittis Pellentesque porttitor ipsum malesuada turpis purus mauris libero. senectus nibh. est.",
        "title": "sem sagittis ultricies in, massa cursus nibh. lectus egestas. tristique tristique eu Pellentesque scelerisque. interdum. consectetur purus est. suscipit tempor tempor adipiscing at eros. ac interdum. risus Aenean Quisque risus Suspendisse ac non habitant libero. imperdiet Nam"
      },
      {
        "api_path": "/be00c39f-a4d1-4a31-90c6-56f932ed03b9/f7e61e4c-4a80-4b47-bc45-df1146e2d5a4/a65a4170-174d-4043-a3bb-9a84bc7b2edb/e1116668-f262-4791-b3fa-ce88b3cfa69a",
        "api_url": "http://example.com/3d8f7d48-36e6-4013-9872-a2b9aec9278e#98539005da1d594ac91f613c39d524d8",
        "base_path": "/8bdbd0fd-8b2d-4b64-8cd2-498ba7e02b41/661252af-56cc-47c7-9244-0ab9304190b5/d4bf2db0-36ce-4793-b2ad-f51461ae968f/0ed8e7ae-c293-4fc4-9754-8dd850e6a0f5",
        "content_id": "5bde19fd-bffc-4a34-a75f-f8f35f86d4a6",
        "links": {
        },
        "locale": "ms",
        "public_updated_at": "2017-12-17T14:02:37+00:00",
        "title": "adipiscing interdum. vel cursus non imperdiet nibh ac suscipit pellentesque lorem scelerisque. amet, Nam Quisque Ut fames egestas. ipsum nibh. sollicitudin non eu molestie orci ac finibus, turpis sem vel porttitor purus volutpat Aenean Ut risus mauris libero. molestie sagittis elit.",
        "web_url": "http://example.com/63646bac-5a40-47fe-9f7c-854ccf8e62ba/51aef0d7-e15a-4619-bf54-668f62bf5ed4#118fd18ae54b7eedbc351f7e659e5ea8"
      },
      {
        "analytics_identifier": null,
        "api_path": "/c4520fba-c5e5-4287-8d52-506ab17a4f66/daacb150-3193-4e1e-8f2b-011c30cb1387",
        "base_path": "/ed03f48b-61b2-4e34-9f31-648368ebb771/ca278842-2632-426f-9ed6-8acbe551e598/dae0997e-cfe4-41a9-bf75-a4a123ad949e/4fa75be3-a783-4c47-bb7a-86c54865ee9d",
        "content_id": "88078106-1b33-4af8-b9ea-e90ff4ac0850",
        "links": {
        },
        "locale": "pl",
        "public_updated_at": null,
        "title": "malesuada lorem sagittis in, tristique et ac Sed ac eu Lorem mauris sit imperdiet elit. ultricies sed sem non scelerisque. interdum. vel porttitor senectus hendrerit, ac vestibulum. leo sollicitudin adipiscing turpis Suspendisse orci interdum. Nam Mauris volutpat habitant eu at est. nibh. massa cursus Quisque ac morbi purus et aliquet. tempor ipsum finibus, Pellentesque netus amet, Ut Duis eros. egestas."
      },
      {
        "analytics_identifier": "eros. et scelerisque. vestibulum. amet, Aenean purus Nam Mauris elit. imperdiet egestas. libero. sollicitudin non sit massa pellentesque orci volutpat vel vel ac eu malesuada Duis sem morbi interdum. risus ac tempor tristique Nam nisl at turpis risus ac Sed sed dolor porttitor dolor fames Ut tristique interdum. adipiscing habitant a suscipit et finibus, non aliquet. lorem Quisque",
        "api_url": "http://example.com/2377dbdd-2756-47e4-91d4-cff26c5a54a5#4e5fab078a1d726d4ed23dfa9ceb9bce",
        "base_path": "/9a67e47e-020d-45d4-aea4-ad692cd6abaf",
        "content_id": "2ee761a3-f61e-41dc-8bdf-5ebfd6197f58",
        "links": {
        },
        "locale": "fr",
        "schema_name": "turpis interdum. Suspendisse pellentesque nisl ultricies Lorem tristique interdum. Sed Nam libero. egestas. eros. consectetur habitant orci et amet, nibh. adipiscing",
        "title": "risus ac hendrerit, mauris Quisque pellentesque eu adipiscing molestie egestas. ultricies amet, finibus, interdum. porttitor consectetur Pellentesque sit orci a scelerisque. sagittis ac ac est. dolor"
      }
    ]
  },
  "locale": "ms",
  "need_ids": [
    "elit. hendrerit, morbi ac interdum. sollicitudin non malesuada volutpat nibh. Mauris suscipit at Pellentesque consectetur egestas. in, Lorem adipiscing Aenean tempor vel tristique mauris Ut et Nam et massa risus sit ac netus Nam",
    "amet, risus non orci netus Ut lectus ac mauris tempor at interdum. sagittis Pellentesque Aenean nisl fames finibus, et tristique dolor leo sit malesuada Suspendisse Ut libero. non dolor pellentesque sollicitudin vestibulum. molestie lorem massa ac",
    "et consectetur pellentesque vel ac nibh ultricies Quisque sagittis sed scelerisque. et Mauris fames sem eros. massa cursus Ut finibus, at imperdiet risus elit. habitant leo Duis senectus eu ac purus amet, ac tristique molestie turpis netus nisl Sed lectus Ut sollicitudin sit Suspendisse Nam Pellentesque suscipit nibh. eu ac tristique dolor in, egestas. lorem mauris libero. malesuada porttitor morbi risus interdum. Aenean bibendum. a Lorem orci dolor vestibulum. tempor adipiscing tempor Nam est. interdum. ipsum volutpat hendrerit, non aliquet. molestie vel non",
    "ac sit vel lectus purus imperdiet Ut sollicitudin Quisque eu dolor Sed ac hendrerit, cursus bibendum. fames egestas. nisl dolor mauris ac Duis vel non risus turpis lorem tempor vestibulum. senectus libero. sem orci sagittis et adipiscing nibh. Mauris est.",
    "sem hendrerit, mauris molestie Nam sit molestie tempor interdum. Mauris a ac dolor sollicitudin cursus elit. tristique adipiscing at Sed ultricies sed Ut porttitor risus senectus eu non Nam vestibulum. morbi lorem sagittis tristique Aenean scelerisque. et imperdiet orci",
    "vel nisl scelerisque. risus nibh Nam Pellentesque amet, cursus interdum. hendrerit, turpis orci mauris Mauris ac at Nam nibh. leo Suspendisse lorem tristique vel fames tempor sollicitudin senectus consectetur Aenean interdum. malesuada a finibus, lectus netus est. risus massa adipiscing imperdiet in, ultricies non volutpat Lorem aliquet. libero. egestas. tristique vestibulum. elit. ac porttitor et molestie eu pellentesque eros. bibendum. Ut sem non ipsum eu",
    "eros. molestie suscipit lectus interdum. Sed morbi consectetur Ut Nam et Quisque sagittis eu tristique volutpat malesuada lorem Duis non Suspendisse Pellentesque at ac dolor senectus egestas. porttitor nibh. turpis hendrerit, cursus molestie fames Lorem orci mauris Mauris massa imperdiet libero. leo elit. a risus interdum. Nam finibus, habitant amet, tristique eu vel nibh dolor sit ac tempor aliquet. sem pellentesque ac ultricies in,",
    "orci molestie ac adipiscing vel ac hendrerit, Ut nisl Nam Mauris ac in, ultricies est. lorem scelerisque. vel interdum. Suspendisse egestas. vestibulum. aliquet. et porttitor volutpat suscipit ac massa lectus nibh. eu Duis dolor leo nibh cursus at dolor Quisque purus"
  ],
  "phase": "live",
  "public_updated_at": "2017-12-05T09:35:16+00:00",
  "rendering_app": null,
  "schema_name": "gone",
  "search_user_need_document_supertype": "finibus, fames tristique molestie eros. Suspendisse turpis Pellentesque Aenean habitant hendrerit, dolor leo est. suscipit molestie Ut lorem vestibulum. senectus ac a Duis orci pellentesque at adipiscing sit",
  "title": null,
  "updated_at": "2017-12-03T05:34:43+00:00",
  "user_need_document_supertype": "molestie non amet, et massa nibh. tempor et nisl Quisque porttitor Duis tempor dolor scelerisque. egestas. eros. a aliquet. imperdiet",
  "withdrawn_notice": {
    "explanation": "nibh molestie netus finibus, mauris aliquet. cursus leo at habitant malesuada egestas. elit. morbi non suscipit fames sit sed hendrerit, eros. Ut pellentesque Duis tempor Pellentesque imperdiet a scelerisque. dolor in, ipsum tristique Mauris interdum. lectus Quisque libero. Nam Nam sem nisl ac interdum. massa sollicitudin dolor risus consectetur vestibulum. et purus sagittis orci ac Suspendisse Lorem porttitor tristique bibendum. senectus non adipiscing et molestie turpis vel vel est.",
    "withdrawn_at": "2017-11-21T00:27:23+00:00"
  }
}

Publisher content schema

This is what publisher apps should send to the publishing-api in This is what a publishing application sends to the publishing-api in a put_content call.

Attributes

access_limited
object
auth_bypass_ids
A list of ids that will allow access to this item for non-authenticated users
users
array

analytics_identifier
string or null
A short identifier we send to Google Analytics for multi-valued fields. This means we avoid the truncated values we would get if we sent the path or slug of eg organisations.
base_path
string
A path only. Query string and/or fragment are not allowed.
change_note
["null", "string"]

description
null

details
object
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, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, sw, ta, th, tk, tr, uk, ur, uz, vi, zh, zh-hk, zh-tw
need_ids
array

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

public_updated_at
string
When the content was last significantly changed (a major update). Shown to users. Automatically determined by the publishing-api, unless overridden by the publishing application.
publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, service-manual-publisher, share-sale-publisher, short-url-manager, smartanswers, specialist-publisher, static, tariff, travel-advice-publisher, whitehall
redirects
array

rendering_app
null

routes
array

schema_name
string

Allowed values: gone
title
null

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "ddbb3f9e-8a50-49de-b23d-c906fa6fbe56",
      "5382030c-fe4e-4d1d-a733-61a2fa2ac184",
      "ee07e5d1-a0ac-4e31-a8c2-29fcdb240a61",
      "41af08e9-56c6-4126-886e-6331063a7877"
    ],
    "users": [
      "ultricies sagittis Suspendisse adipiscing orci lectus est. egestas. Sed tempor libero. Ut pellentesque imperdiet sit fames ac interdum. a Mauris nibh habitant suscipit hendrerit, dolor vel risus eu et purus netus risus massa bibendum. eu Nam et scelerisque. eros. amet, Quisque morbi nibh. non consectetur dolor porttitor Pellentesque finibus, volutpat vel sollicitudin lorem leo in, tristique tempor molestie sed ac aliquet. elit. turpis Nam mauris ac malesuada non Aenean interdum. tristique sem ipsum molestie Lorem nisl senectus cursus Duis Ut",
      "Aenean ac interdum. tristique tristique vel ultricies libero. orci vestibulum. suscipit Suspendisse amet, senectus molestie ipsum ac malesuada lectus sollicitudin Quisque Duis est. bibendum. interdum. porttitor tempor dolor Pellentesque habitant et massa hendrerit, non morbi turpis egestas. sem dolor sed ac risus vel Sed lorem ac a eros. eu Ut aliquet. volutpat nisl sit Nam pellentesque Mauris sagittis eu mauris et molestie non",
      "Aenean suscipit et non elit. turpis risus lectus dolor porttitor egestas. malesuada massa orci volutpat tempor interdum. ac vel tristique vestibulum. eu in, sit libero. Suspendisse netus vel ipsum molestie est. Ut pellentesque a risus Pellentesque lorem leo ac consectetur habitant eros. hendrerit, purus sed Nam nibh. ac adipiscing bibendum. nibh cursus sagittis mauris Duis Mauris senectus imperdiet Sed",
      "senectus malesuada imperdiet tempor Sed pellentesque nisl aliquet. risus lectus Lorem ac est. eros. interdum. massa ultricies elit. et habitant adipiscing et mauris molestie libero. suscipit Pellentesque dolor Nam dolor in, sed porttitor sollicitudin finibus, sit Ut ipsum ac Suspendisse hendrerit, at Aenean tempor vestibulum. tristique egestas. Mauris eu tristique lorem nibh. morbi nibh a ac fames vel Ut purus volutpat ac interdum. sem consectetur turpis risus Quisque leo non cursus orci",
      "senectus interdum. ipsum Nam habitant tempor ultricies dolor finibus, massa ac Quisque molestie Ut nisl et amet, aliquet. non tristique fames bibendum. a Pellentesque nibh. dolor libero. eros. egestas. Aenean turpis Suspendisse eu imperdiet tristique consectetur orci pellentesque porttitor et sed elit. Duis scelerisque. netus Nam ac non ac vestibulum. Sed Ut tempor risus molestie interdum. Mauris adipiscing morbi mauris purus ac vel est. eu leo vel sollicitudin hendrerit, risus sem nibh volutpat lorem",
      "risus malesuada",
      "hendrerit, non a orci interdum. Duis habitant dolor malesuada bibendum. Nam adipiscing morbi fames Ut",
      "Pellentesque leo et a habitant tempor eu risus elit. at sit molestie ac bibendum. interdum. morbi imperdiet Nam risus finibus, sed lectus libero. lorem Aenean ipsum volutpat Suspendisse nisl mauris cursus interdum. amet, ac molestie adipiscing Duis vel fames est. sem purus vel et sagittis porttitor ac tristique pellentesque eu Mauris consectetur suscipit malesuada Sed non vestibulum. non in, Ut tristique nibh ultricies massa Quisque sollicitudin netus aliquet. turpis tempor Lorem nibh. Ut dolor Nam ac orci dolor",
      "fames et ac tristique Ut"
    ]
  },
  "analytics_identifier": "Quisque egestas. tristique interdum. Aenean nisl habitant risus nibh. malesuada nibh ultricies interdum. Nam",
  "base_path": "/0fafeac5-ebb9-4858-96a7-1ed696262154/90ea04e7-4654-4e8a-9fc8-8ab0b4af0c07/9fc57da0-0f70-4ed2-838a-2ee291800e07/37c92282-a79c-4eb5-a61f-e7682908fa94",
  "description": null,
  "details": {
    "explanation": ""
  },
  "document_type": "gone",
  "last_edited_at": "2018-01-01T00:54:44+00:00",
  "links": {
  },
  "phase": "alpha",
  "publishing_app": "frontend",
  "routes": [
    {
      "path": "habitant et ac lorem massa imperdiet egestas. nisl",
      "type": "prefix"
    }
  ],
  "schema_name": "gone",
  "title": null,
  "update_type": "republish"
}

The links for this item. This is what a publishing application sends in a patch_links call.

Attributes

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "previous_version": "orci Lorem non vel"
}