Skip to main content

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_limited
object
auth_bypass_ids
 Deprecated: auth_bypass_ids should be sent as a separate field
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.
auth_bypass_ids
array
base_path
null
bulk_publishing
boolean
change_note
["null", "string"]
description
string
details
object
hidden_search_terms
array		 List of words/phrases the user can search for that aren’t present on the page.
url
string		 A URL for the external resource
document_type
string
Allowed values: external_content
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, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, ne, nl, no, pa, pa-pk, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, yi, 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: account-api, calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, government-frontend, hmrc-manuals-api, info-frontend, licencefinder, local-links-manager, 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: external_content
title
string
update_type
Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "bfeb8cab-4bdc-127e-a67a-8c0fea6ef517",
      "4495505b-4b90-1cdf-a5a4-b3adeae7bad5",
      "ed3cd8e6-cbd3-11c3-a450-e6dda3ce6e5d",
      "3daf01af-d8dd-1045-aefb-2ef9f0c41d94",
      "2c3c7a3a-aec3-1f6a-a54b-4aad1d71e255",
      "db6904a8-fcd3-1d49-ac28-c22a92cfeaed"
    ]
  },
  "description": "Ut habitant eu ac ultricies dolor molestie orci molestie et volutpat vestibulum. eros. Pellentesque risus Ut tristique fames hendrerit netus morbi cursus sagittis Quisque dolor non sit libero. scelerisque. a ac non adipiscing nibh. turpis mauris Suspendisse senectus Lorem eu Sed interdum. sem massa sollicitudin vel Duis suscipit interdum. pellentesque malesuada lorem consectetur bibendum. et risus lectus finibus egestas. ac nibh Nam at Nam elit. Aenean Mauris aliquet. est. vel tristique in nisl imperdiet tempor leo ipsum porttitor ac sed purus amet tempor",
  "details": {
    "hidden_search_terms": [
      "finibus cursus sed turpis interdum. et suscipit Suspendisse molestie amet ac in purus ac malesuada imperdiet Pellentesque sollicitudin ac Ut risus vestibulum. hendrerit Aenean habitant ipsum Ut elit. nisl",
      "dolor purus netus non scelerisque. ultricies Duis volutpat Aenean turpis Lorem vel tristique Ut nibh. Quisque malesuada Suspendisse morbi Nam leo sit tempor sollicitudin Nam vestibulum. senectus",
      "interdum. libero. netus fames ac Suspendisse orci dolor ultricies malesuada Ut molestie vel interdum. Pellentesque sed dolor egestas. Lorem et est. ipsum eros. morbi sit tristique a nisl aliquet. Nam consectetur Aenean scelerisque. non lorem Nam imperdiet tempor",
      "massa ac scelerisque. sollicitudin sit tempor non habitant nibh vel sed aliquet. egestas. in mauris senectus lorem non interdum. malesuada Aenean sem suscipit Nam est. Pellentesque orci ac fames volutpat nisl ac pellentesque Ut dolor et cursus Mauris imperdiet Quisque vel ipsum ac consectetur hendrerit purus amet eros. eu leo at netus dolor Duis a finibus sagittis ultricies porttitor eu molestie vestibulum.",
      "ipsum orci molestie nibh. non eu consectetur adipiscing at volutpat",
      "nibh. Aenean Quisque consectetur cursus lectus Sed tempor tempor nisl Ut orci et interdum. volutpat mauris Duis Mauris egestas. fames malesuada lorem vel vel risus purus sagittis non tristique ac turpis molestie ac sit senectus tristique vestibulum. ac risus Lorem non a Nam ultricies libero. sed dolor adipiscing Ut elit. sem nibh interdum. hendrerit dolor Suspendisse Pellentesque netus in at eu ipsum amet molestie scelerisque.",
      "leo imperdiet purus sit suscipit et ac Ut vel egestas. volutpat sem elit. massa orci et Nam Suspendisse vestibulum. ipsum sed est. ac lorem hendrerit Nam morbi netus scelerisque. Pellentesque Aenean ultricies a molestie libero. Ut nibh ac non amet interdum. Sed risus sagittis tempor risus consectetur eu tristique Mauris habitant Lorem finibus vel Quisque adipiscing eros. porttitor dolor nisl mauris eu tristique cursus pellentesque senectus Duis ac aliquet. interdum. lectus malesuada at nibh. turpis tempor bibendum. in dolor sollicitudin fames molestie non",
      "libero. Duis dolor finibus amet elit.",
      "interdum. volutpat risus tempor dolor lectus eu Pellentesque aliquet. vel nibh scelerisque. lorem a ipsum non eros. massa elit. libero. Nam ac non Lorem ac finibus habitant et senectus Nam sagittis orci suscipit ultricies sed est. adipiscing mauris consectetur dolor vestibulum. Mauris interdum. Suspendisse Aenean pellentesque imperdiet et molestie risus vel morbi at leo bibendum. sem sollicitudin purus cursus tempor netus Duis porttitor sit ac nisl in malesuada hendrerit eu tristique nibh. turpis amet fames molestie Sed",
      "sem Duis adipiscing Suspendisse et scelerisque. Nam cursus Quisque ipsum eros. molestie molestie Nam netus interdum. Mauris lectus finibus sagittis a hendrerit consectetur vel turpis Sed suscipit non ac nisl libero. imperdiet Ut ac sed purus at tempor malesuada Aenean volutpat elit. ac bibendum. morbi senectus Ut pellentesque porttitor risus interdum. vel leo tempor sollicitudin dolor egestas. tristique ultricies Pellentesque habitant nibh. aliquet. sit eu Lorem dolor et amet massa eu lorem nibh vestibulum. ac in tristique mauris orci est. non fames risus"
    ],
    "url": "http://example.com/a98d9668-d0f5-19fe-abaf-fb57d62fabc4/97bfff6d-046c-101c-a698-aecdd725fd5a#d895fffef4"
  },
  "document_type": "external_content",
  "locale": "az",
  "previous_version": "malesuada vestibulum. sit volutpat cursus massa mauris",
  "public_updated_at": "2023-10-04T15:56:48+00:00",
  "publishing_app": "specialist-publisher",
  "schema_name": "external_content",
  "title": "Sed morbi consectetur purus Quisque eros. ultricies sed est. Pellentesque nibh. hendrerit egestas. molestie massa scelerisque. sagittis imperdiet dolor malesuada adipiscing interdum. orci non Nam aliquet. nisl in Mauris vestibulum. turpis tempor molestie ac lectus"
}

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,
  "links": {
  }
}