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"]

content_id_alias
null

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.

instructions_to_publishers
null

last_edited_at
string Last time when the content received a major or minor update.

last_edited_by_editor_id
string The UUID of the editor who edited the content.

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, ku, ky, 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, ti, tk, tr, uk, ur, uz, vi, yi, zh, zh-hk, zh-tw

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, local-links-manager, manuals-publisher, performanceplatform-big-screen-view, publisher, publishing-api, rummager, search-admin, search-api, 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: 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"
    ]
  },
  "content_id_alias": null,
  "description": "Pellentesque Mauris Sed Nam eros. dolor eu nisl",
  "details": {
    "url": "http://example.com/edea11fb-73de-11b3-ae6f-10367a4816aa#a975c6813f"
  },
  "document_type": "external_content",
  "first_published_at": "2017-10-26T10:37:09+00:00",
  "links": {},
  "locale": "si",
  "public_updated_at": "2019-06-14T07:37:12+00:00",
  "publishing_app": "email-alert-frontend",
  "redirects": [
    "scelerisque. eu sagittis lectus egestas. interdum. et sit non sed"
  ],
  "routes": [
    "egestas. aliquet. Sed purus suscipit lectus cursus risus netus at hendrerit eu ipsum senectus ac orci sagittis consectetur sed ultricies mauris sit a non libero. dolor Ut Quisque nibh interdum. Duis Lorem ac risus finibus scelerisque. molestie nibh. Pellentesque in molestie est. tristique Suspendisse imperdiet vel Ut pellentesque tempor non fames Aenean porttitor",
    "at hendrerit Sed sem interdum. vestibulum. Quisque purus finibus et",
    "morbi in malesuada Aenean risus est. finibus nisl Mauris sagittis vestibulum. elit. interdum. non ultricies ipsum ac sed pellentesque Nam consectetur tristique ac ac at Pellentesque ac Nam Duis eu fames Ut et lorem risus imperdiet tempor mauris porttitor non Ut vel purus massa dolor Lorem scelerisque. a leo molestie sem sollicitudin aliquet. volutpat hendrerit habitant Sed eu vel nibh tempor eros. molestie bibendum. dolor sit lectus cursus turpis nibh. senectus orci adipiscing egestas. netus",
    "Duis Suspendisse sollicitudin elit. Ut non orci adipiscing sagittis dolor consectetur vel pellentesque Nam lorem cursus molestie leo Lorem egestas. purus habitant massa Sed nibh tempor scelerisque. at est. eu vestibulum. ultricies interdum. a tristique in bibendum. ac molestie turpis aliquet. sit Mauris risus",
    "ac at sagittis tempor ipsum nibh. mauris habitant ac scelerisque. Nam ac porttitor lorem"
  ],
  "schema_name": "external_content",
  "title": "at non tempor consectetur vel ipsum Lorem leo scelerisque. ultricies et mauris est. Suspendisse ac massa Quisque hendrerit nibh. finibus eu pellentesque sollicitudin amet sem sit eu interdum. netus Ut Duis sed bibendum. risus morbi a volutpat risus Mauris Sed turpis ac aliquet. adipiscing nibh cursus lorem sagittis Aenean ac dolor vestibulum. imperdiet egestas. orci senectus Pellentesque purus dolor ac Ut tristique tristique Nam molestie libero. et vel lectus elit. fames porttitor interdum. eros. suscipit tempor malesuada molestie in non habitant Nam nisl"
}

Publisher links schema

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