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-block-manager, 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": "https://turpis.com/dea11fb7-3de1-1b3e-a6f1-0367a4816aaa/975c6813-f59a-16a7-ab3d-cdb4f55fb35e/fc31bece-ab9b-1f06-aff1-cbe91fa7fb2e/45e8c0c0-7ba4-17b7-aeee-e2cfb5fe9d0a/6be2a4b9-1adf-15c7-aa88-a5fef1cebe9f#9ce25e8feb"
  },
  "document_type": "external_content",
  "first_published_at": "2018-09-07T14:14:20+00:00",
  "instructions_to_publishers": null,
  "last_edited_by_editor_id": "ac orci morbi nibh ac molestie Nam malesuada tempor Ut imperdiet lectus dolor adipiscing ultricies libero sagittis Sed risus massa vel turpis pellentesque fames scelerisque in hendrerit est interdum leo Ut amet interdum cursus Pellentesque ac tristique bibendum vel eu mauris netus at ipsum sed vestibulum purus elit sollicitudin volutpat eu Mauris lorem eros suscipit non aliquet Quisque Duis molestie egestas senectus habitant a nisl finibus Suspendisse non tempor sit Lorem Nam et et porttitor consectetur ac sem tristique risus Aenean dolor nibh",
  "locale": "si",
  "phase": "beta",
  "public_updated_at": "2014-07-20T12:02:32+00:00",
  "publishing_app": "service-manual-publisher",
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "cursus Quisque vestibulum turpis ac porttitor sed tristique Pellentesque eros adipiscing interdum volutpat Nam ac eu in leo tempor suscipit egestas at ac consectetur amet morbi eu risus Mauris a Lorem Ut molestie lectus orci risus dolor aliquet et senectus malesuada Sed Ut libero hendrerit"
}

Publisher links schema

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