Skip to main content
Table of contents

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
A list of ids that will allow access to this item for non-authenticated users
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.
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, he, hi, hr, hu, hy, id, is, it, ja, ka, kk, ko, lt, lv, ms, mt, nl, no, pl, ps, pt, ro, ru, si, sk, sl, so, sq, sr, sv, sw, ta, th, tk, tr, uk, ur, uz, vi, 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: calculators, calendars, collections-publisher, contacts, content-publisher, content-tagger, email-alert-frontend, external-link-tracker, feedback, frontend, hmrc-manuals-api, info-frontend, licencefinder, local-links-manager, 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
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

{
  "description": "tempor Pellentesque at vestibulum. risus lorem massa sollicitudin et ac turpis sit eu bibendum. Quisque non sed est. egestas. tristique a et nisl interdum. ac nibh hendrerit, vel ac Nam molestie Duis molestie malesuada cursus Ut libero. eu mauris Aenean Mauris non leo eros. consectetur sem pellentesque dolor adipiscing sagittis in, aliquet. tempor finibus, ac imperdiet Sed purus",
  "details": {
    "hidden_search_terms": [
      "Ut adipiscing libero. senectus consectetur Ut porttitor dolor ac orci sed nibh. risus sagittis imperdiet Quisque massa purus tempor et turpis dolor vel fames molestie",
      "vestibulum. Sed tempor eu sem molestie tristique morbi Pellentesque amet, Duis pellentesque fames Ut egestas. consectetur et risus porttitor interdum. ipsum adipiscing molestie lorem Mauris sit mauris turpis Lorem leo ac libero. tempor ac nisl Nam Aenean non senectus purus vel non risus netus Ut sollicitudin hendrerit, habitant vel scelerisque. interdum. ac",
      "turpis tristique Nam vel Duis",
      "Sed sit turpis Ut lorem egestas. Nam a Suspendisse elit. ac Pellentesque finibus, adipiscing tristique interdum. mauris massa habitant vel consectetur dolor interdum. non malesuada orci purus Lorem senectus scelerisque. risus cursus bibendum. imperdiet leo molestie tempor vestibulum. libero. Ut aliquet. non volutpat Aenean",
      "imperdiet interdum. risus Suspendisse dolor eros. est. lorem libero. sollicitudin Nam sagittis leo tristique bibendum. cursus Pellentesque volutpat sem a aliquet. molestie porttitor risus eu egestas. adipiscing orci turpis interdum. Ut hendrerit, dolor amet, nibh non scelerisque. in, fames ac et sit vel Ut tempor tristique ultricies consectetur senectus Duis nibh. Sed elit. non ipsum massa habitant netus nisl Mauris finibus, Quisque vestibulum. Aenean purus Lorem ac lectus at mauris sed eu et ac vel malesuada",
      "Ut nibh. est. morbi et vel hendrerit, ultricies malesuada Nam porttitor eu sem turpis molestie aliquet. Aenean Sed sagittis nisl elit. egestas. tempor ac",
      "tristique suscipit lorem molestie nisl non ac pellentesque volutpat vel purus cursus non ultricies turpis sollicitudin eu tristique massa elit. Nam mauris sit eros. malesuada Aenean ipsum Duis Ut interdum. vel senectus hendrerit, nibh. finibus, netus sed dolor lectus in, Ut Suspendisse leo et interdum. risus molestie nibh fames scelerisque. adipiscing libero. ac vestibulum. Pellentesque tempor ac amet, Mauris et sagittis consectetur orci aliquet. a sem at ac Nam Quisque tempor imperdiet",
      "",
      "consectetur Aenean tempor Pellentesque Ut malesuada senectus a nisl Duis libero. aliquet. bibendum. Lorem Suspendisse dolor adipiscing est. ipsum tempor volutpat orci ac purus mauris netus habitant Quisque Ut turpis sit egestas. Sed imperdiet et sed interdum. hendrerit, ac Mauris vel lectus Nam at leo cursus Nam eros. molestie amet, elit. risus ultricies suscipit et molestie ac ac eu porttitor sollicitudin tristique vestibulum. morbi risus tristique nibh finibus, nibh. non eu pellentesque dolor interdum. sem lorem scelerisque. non sagittis massa in, vel fames"
    ],
    "url": "http://example.com/110cb1fa-df4a-4977-b7f1-09fdbc6f6219/81aec5d4-721b-4e7a-93dd-8aa410ae5af6/8e764d75-daad-4b04-b7f7-62424d3e5820/5aaf2c96-5b00-4d9c-8e8a-95694309248d#2623e1766c2394be50256e97f5b653eb"
  },
  "document_type": "external_content",
  "first_published_at": "2019-07-24T16:38:10+00:00",
  "locale": "uz",
  "previous_version": "Sed massa egestas. non Pellentesque Lorem bibendum. et netus sit libero. eu risus volutpat scelerisque. ac elit. leo",
  "publishing_app": "frontend",
  "redirects": [
    "tristique Sed in, dolor dolor risus Mauris Pellentesque non Lorem mauris elit. ac Duis eros. orci scelerisque. vel nibh. lectus Ut volutpat vel interdum. cursus nisl eu sem ipsum malesuada sollicitudin amet, senectus vestibulum. habitant sed est. molestie a morbi sit Suspendisse leo molestie porttitor imperdiet ac adipiscing consectetur hendrerit, et massa suscipit fames libero. eu aliquet. egestas. pellentesque Nam netus non sagittis risus ultricies purus bibendum. at tristique tempor et finibus, turpis ac Aenean Ut Nam nibh Quisque ac tempor lorem interdum.",
    "sem vestibulum. vel porttitor sollicitudin vel Nam Aenean ultricies eros. volutpat libero. purus interdum. cursus ac ac Sed non Ut sed Pellentesque non adipiscing malesuada Mauris Suspendisse at Duis interdum. in, massa sit elit. netus eu dolor ac finibus, mauris nibh nibh. morbi risus pellentesque molestie tempor tempor senectus sagittis tristique lorem risus imperdiet Ut molestie eu est. turpis amet, a et consectetur nisl scelerisque. hendrerit, habitant egestas. bibendum. et lectus ac leo fames dolor Nam orci tristique ipsum aliquet. Quisque",
    "Suspendisse vestibulum. morbi egestas. elit. Sed Mauris sed sem scelerisque. pellentesque dolor at aliquet. risus ac tristique molestie libero. Nam in, senectus eros. tristique suscipit adipiscing sagittis sollicitudin ac cursus non malesuada interdum. netus leo finibus, ultricies vel est. Ut purus eu hendrerit, tempor tempor amet, ipsum nibh consectetur a ac molestie Ut nibh. porttitor Lorem Aenean turpis interdum. ac mauris habitant orci sit Nam lectus lorem volutpat risus dolor et vel bibendum. Pellentesque et imperdiet eu non Duis massa nisl Quisque fames",
    "non sagittis nibh imperdiet eu volutpat massa aliquet. vestibulum. Suspendisse ipsum a lectus Duis hendrerit, lorem bibendum. turpis Aenean consectetur cursus dolor porttitor mauris Lorem scelerisque. Quisque suscipit Ut Pellentesque pellentesque egestas. et interdum. orci eu est. dolor non in, Mauris habitant malesuada sollicitudin Sed tempor nisl tristique ac risus libero. leo morbi adipiscing molestie Ut nibh. Nam interdum. purus Nam",
    "sem tristique ac non morbi ac interdum. risus dolor pellentesque non et Ut fames nisl netus Quisque Duis bibendum. Nam habitant est. Sed tempor interdum. Nam Mauris vel hendrerit, nibh senectus dolor sollicitudin elit."
  ],
  "schema_name": "external_content",
  "title": "dolor"
}

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

{
}