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, 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, local-links-manager, manuals-publisher, maslow, 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": "sl",
  "previous_version": "aliquet. risus non bibendum. vel Sed porttitor interdum. eros. ac ac Ut eu purus suscipit tempor nibh morbi tristique Suspendisse sagittis et lectus libero. sollicitudin sit vestibulum. Lorem netus a imperdiet malesuada amet ac hendrerit molestie at massa ipsum eu",
  "public_updated_at": "2022-08-01T23:37:29+00:00",
  "publishing_app": "feedback",
  "redirects": [
    "a Lorem eros. bibendum. netus aliquet. est. orci suscipit tristique sagittis tristique malesuada purus tempor massa Quisque dolor pellentesque senectus Suspendisse et finibus ipsum nibh eu Mauris elit. sem porttitor non ac in scelerisque. interdum. ultricies Nam Nam molestie sollicitudin Duis Ut tempor at risus mauris Ut interdum. ac Sed fames consectetur vel hendrerit cursus egestas. volutpat amet risus Pellentesque lorem habitant morbi nibh. molestie sit nisl Aenean libero. ac adipiscing imperdiet et",
    "orci ac turpis interdum. leo Pellentesque massa risus dolor eu nibh. at Ut et egestas. vel fames interdum. lectus sed Ut scelerisque. adipiscing risus dolor Nam vestibulum. Nam",
    "in risus non amet lorem pellentesque eu lectus dolor bibendum. est. tristique mauris Quisque elit. at nisl habitant vestibulum. a et risus ac Sed ultricies adipiscing tristique imperdiet vel interdum. Mauris ipsum ac netus sed senectus vel Nam nibh tempor sollicitudin interdum. Aenean tempor ac Lorem volutpat massa fames dolor eu scelerisque. molestie eros. sem",
    "consectetur molestie Duis nisl Nam tempor interdum. cursus a eu hendrerit leo interdum. Quisque massa dolor non mauris risus Aenean et adipiscing ac lectus morbi Ut volutpat pellentesque orci scelerisque. finibus malesuada ipsum Mauris bibendum. sem Pellentesque Nam tristique aliquet. tristique senectus vel et habitant Lorem vestibulum. libero. Ut netus ac ultricies egestas. risus elit. purus amet sed eu nibh nibh. sit porttitor lorem eros. sollicitudin turpis Suspendisse at molestie in Sed est. ac non ac vel",
    "et consectetur vestibulum. molestie Nam habitant libero. sollicitudin nibh. a massa eu leo ac tristique lorem ac tempor at sed nisl lectus non egestas. finibus Lorem morbi hendrerit risus sem purus Duis interdum. Nam adipiscing malesuada tempor orci vel suscipit risus ipsum in dolor imperdiet amet Ut Ut scelerisque. aliquet. ac dolor netus et elit. Pellentesque",
    "vestibulum. tristique morbi dolor aliquet. turpis at sollicitudin nibh. elit. sed scelerisque. nibh in senectus Duis bibendum. sem vel leo risus volutpat ac est. Nam risus non porttitor Ut pellentesque tempor dolor vel netus adipiscing amet egestas. finibus consectetur lectus interdum. sagittis nisl Lorem ac hendrerit eros. purus mauris ipsum eu Mauris ac et malesuada Pellentesque tristique a orci Sed",
    "nibh. turpis tristique sem vel Nam ultricies tristique non ac interdum. molestie senectus leo tempor Sed vel elit. Mauris cursus Quisque malesuada sollicitudin in ipsum molestie finibus lorem est. sit ac nisl Nam Suspendisse amet et risus eu a adipiscing sed mauris Pellentesque morbi non eu libero. interdum. dolor eros. purus et orci Lorem nibh tempor egestas. risus Duis dolor ac massa consectetur lectus Ut vestibulum. porttitor habitant pellentesque Aenean volutpat bibendum. netus Ut scelerisque. hendrerit imperdiet sagittis ac aliquet. fames suscipit at"
  ],
  "rendering_app": null,
  "routes": [
    "sagittis morbi non dolor volutpat scelerisque. dolor tempor ac senectus ac Sed lectus Aenean Quisque mauris sem nisl netus fames in eu et leo lorem libero. sed adipiscing tempor orci",
    "turpis Ut hendrerit ipsum Sed risus sollicitudin interdum. netus morbi Ut porttitor habitant massa et in sagittis volutpat elit. dolor libero. sem mauris purus consectetur aliquet. cursus adipiscing Nam vel tempor est. nibh. tempor imperdiet leo at Duis tristique senectus egestas. finibus ultricies ac suscipit pellentesque ac Aenean eu sed sit vel non eu risus Nam non fames tristique nibh scelerisque. ac molestie molestie Pellentesque nisl lorem amet dolor orci Suspendisse malesuada et vestibulum. bibendum. a eros. interdum. Quisque ac lectus Lorem Mauris",
    "finibus dolor orci ultricies mauris Suspendisse et at Duis risus sagittis leo in non massa elit. et vestibulum. adipiscing sollicitudin volutpat Nam Pellentesque lorem eu ac cursus imperdiet tristique ac turpis Sed non sed senectus bibendum. sit aliquet. est. molestie ac Lorem purus tempor dolor netus Aenean Mauris nibh. egestas. eros. lectus Ut molestie Quisque suscipit libero. ipsum porttitor morbi malesuada scelerisque. Nam amet eu vel tempor interdum. Ut a fames hendrerit ac pellentesque sem habitant vel nibh interdum. risus consectetur nisl tristique",
    "volutpat a Aenean suscipit senectus ac lorem",
    "egestas. libero. Pellentesque mauris est. interdum. Nam risus ac cursus Mauris finibus habitant interdum. ac a senectus ipsum dolor Ut purus Sed porttitor molestie amet Nam orci elit. tristique turpis nibh sagittis dolor malesuada molestie volutpat vel vel at Suspendisse sollicitudin ultricies",
    "aliquet. volutpat bibendum. risus tempor tempor ipsum eu imperdiet ac senectus morbi tristique dolor nibh a finibus et vestibulum. ac elit. interdum. hendrerit molestie leo vel vel sem Nam sit consectetur habitant",
    "purus risus amet Nam Aenean a non Lorem cursus bibendum. ac at lectus Duis morbi Ut mauris consectetur elit. molestie vestibulum. hendrerit ac finibus eu pellentesque libero. Ut sollicitudin eu volutpat et habitant vel Sed ac suscipit imperdiet nisl massa dolor sit adipiscing Mauris turpis nibh. malesuada ultricies interdum. tempor non netus sagittis sed egestas. ipsum interdum. aliquet. Nam dolor nibh Pellentesque sem orci et tristique tristique lorem molestie senectus fames in risus tempor vel ac eros. scelerisque. est. Quisque leo porttitor Suspendisse",
    "ipsum risus est. risus sagittis tristique aliquet. in sit senectus fames netus interdum. leo Nam ac habitant consectetur Suspendisse vel non sollicitudin tempor sed Quisque morbi Ut molestie Duis pellentesque hendrerit turpis dolor a ultricies volutpat egestas. mauris elit. amet lorem dolor ac Sed tempor nibh. nisl adipiscing libero. sem purus Ut non Pellentesque vestibulum. nibh eu suscipit lectus et ac cursus interdum. et eu vel Nam at finibus tristique ac bibendum. porttitor Aenean orci eros."
  ],
  "schema_name": "external_content",
  "title": "nibh molestie",
  "update_type": "major"
}

Publisher links schema

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