Schema: external_content
Frontend schema
This schema doesn’t have a frontend schema. This means that it should not be used by rendering applications.
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_limitedobject |
| ||||
analytics_identifierstring 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_pathnull | |||||
bulk_publishingboolean | |||||
change_note["null", "string"] | |||||
descriptionstring | |||||
detailsobject |
| ||||
document_typestring | Allowed values: external_content | ||||
first_published_atstring | The date the content was first published. Automatically determined by the publishing-api, unless overridden by the publishing application. | ||||
last_edited_atstring | Last time when the content received a major or minor update. | ||||
linksobject | |||||
localestring | 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_idsarray | |||||
phasestring | The service design phase of this content item - https://www.gov.uk/service-manual/phases Allowed values: alpha , beta , live | ||||
previous_versionstring | |||||
public_updated_atstring | 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_appstring | 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 | ||||
redirectsarray | |||||
rendering_appnull | |||||
routesarray | |||||
schema_namestring | Allowed values: external_content | ||||
titlestring | |||||
update_type | Allowed values: major , minor , republish |
Random example
{
"access_limited": {
"auth_bypass_ids": [
"e6f04531-eaeb-4d8d-a9eb-3bdb227c1a70",
"c0db5542-064e-42c6-ab62-9a63f31b1798",
"186b5cf9-f004-4e3a-b2b3-87b6bf14295d",
"3b3665cd-a7c0-4473-b66f-986662e1fc48",
"2176b7dd-fe33-44b1-9974-dc5766100b74",
"d1681e9a-c2e7-41e5-96ad-09ce9cb584d5",
"74215ed7-f7a3-4a31-a468-2efe5ae496ca",
"d30b5dfd-eeff-4ae9-9938-4b440a8e639f"
]
},
"change_note": null,
"description": "egestas. vel Suspendisse volutpat orci eros. ac tempor Sed dolor tempor in, morbi ac tristique lorem habitant sem non cursus nibh pellentesque",
"details": {
"hidden_search_terms": [
"",
"sit suscipit turpis ipsum Quisque aliquet. tristique a hendrerit, libero. malesuada Ut bibendum. Suspendisse interdum. ultricies elit. non nibh tristique eu habitant Nam lectus et Nam molestie pellentesque scelerisque. et dolor risus finibus, sollicitudin Mauris sed netus amet, massa imperdiet non senectus Sed Duis tempor est. risus eu orci vel ac Lorem leo cursus interdum. vestibulum. morbi in, adipiscing molestie sagittis egestas. mauris ac tempor consectetur Pellentesque nisl purus nibh. eros. porttitor volutpat lorem ac fames ac at dolor Ut vel sem Aenean",
"senectus Aenean sed nibh libero. netus et ac Quisque molestie tempor lorem est. pellentesque et nisl eu lectus turpis non adipiscing aliquet. finibus, porttitor habitant a Nam Suspendisse purus Duis consectetur malesuada molestie Ut mauris amet, ipsum vestibulum. egestas. Sed Lorem risus risus ultricies hendrerit, leo Ut fames sit tristique dolor tempor massa scelerisque. dolor imperdiet at nibh. ac orci non ac sem morbi vel",
"turpis ac et vel Lorem lorem eu cursus Pellentesque dolor porttitor dolor at orci sed senectus Ut sollicitudin ac amet, non tristique vestibulum. interdum. nibh. tempor ultricies netus sit lectus habitant Sed volutpat purus suscipit pellentesque molestie egestas. a libero. tristique Ut massa Duis non molestie eu morbi ac Quisque mauris scelerisque. est. malesuada et Nam imperdiet adipiscing leo eros. Aenean sagittis elit. consectetur ac bibendum. fames hendrerit, tempor sem nibh Suspendisse finibus, in, Mauris vel aliquet.",
"Pellentesque in, Aenean morbi Suspendisse ac ac Nam Nam pellentesque sem Mauris vestibulum. Ut eu habitant",
"Ut ac tristique netus Nam orci aliquet. ipsum lectus leo volutpat ac fames massa sit purus egestas. Duis cursus Ut interdum. tempor lorem risus turpis est. tempor Sed eu Lorem pellentesque imperdiet Aenean Mauris molestie elit. sagittis porttitor vel"
],
"url": "http://example.com/333ed578-06f0-4dba-839e-5de943794f47/300bec45-3f63-4246-a715-d8a3e2b840b6#29d08a21d2dc9c0008332ce454f23607"
},
"document_type": "external_content",
"links": {
},
"phase": "alpha",
"publishing_app": "contacts",
"rendering_app": null,
"schema_name": "external_content",
"title": "ac consectetur massa vel mauris volutpat netus vestibulum. ac Quisque Lorem imperdiet leo sed Suspendisse Sed lectus sit sollicitudin risus nisl Pellentesque at interdum. eros. Duis sem ultricies lorem bibendum. nibh hendrerit, ac sagittis libero. scelerisque. turpis purus ipsum non pellentesque Aenean a finibus, adipiscing in, suscipit eu interdum. vel elit. Ut egestas. risus non amet, malesuada ac tristique senectus fames nibh. orci morbi tempor porttitor dolor aliquet. Nam et tristique tempor dolor Nam habitant Ut eu"
}
Publisher links schema
The links for this item. This is what a publishing application sends in a
patch_links
call.
Attributes
bulk_publishingboolean | |
linksobject | |
previous_versionstring |
Random example
{
"bulk_publishing": true
}