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
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, 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

{
  "access_limited": {
    "users": [
      "leo vel nibh hendrerit, tristique massa Nam eu elit. ac Quisque lorem suscipit libero. Suspendisse pellentesque consectetur turpis bibendum. et Mauris sem aliquet. at finibus, Ut dolor Duis egestas. adipiscing tempor",
      "malesuada netus et ac Aenean consectetur eu Quisque risus molestie fames eu orci massa ultricies senectus lectus",
      "in, a vestibulum. porttitor at suscipit habitant molestie turpis ac Duis nibh. Nam nisl senectus tempor eros. sit pellentesque hendrerit, ac vel ac ac sagittis adipiscing vel Ut est.",
      "a pellentesque et Pellentesque risus interdum. tristique vestibulum. purus Ut scelerisque. non ultricies netus malesuada cursus lorem morbi turpis Nam tempor Quisque ac porttitor Aenean habitant Lorem elit. nibh imperdiet vel bibendum. eros. ipsum massa senectus ac suscipit in, dolor dolor sem molestie consectetur est. et eu Sed orci volutpat adipiscing hendrerit, interdum. Mauris nibh. sit egestas. sagittis nisl non leo at tempor amet, mauris libero. Ut Suspendisse finibus, Duis vel sollicitudin molestie tristique ac risus Nam eu lectus fames aliquet. ac sed",
      "Lorem nibh. Sed consectetur molestie sit nisl egestas. cursus interdum. tristique sollicitudin ac lectus Ut lorem vestibulum. tristique Duis vel eu sem dolor eu ac aliquet. Nam Pellentesque sagittis massa tempor et malesuada a pellentesque morbi in, ac Aenean finibus, Nam adipiscing senectus orci",
      "ac eros. ac amet, sed morbi egestas.",
      "et Lorem dolor molestie Pellentesque sagittis a leo interdum. tristique senectus Sed vel aliquet. sollicitudin suscipit non non Nam egestas. ultricies est. malesuada ac Nam porttitor orci eros. pellentesque sed hendrerit, eu risus Ut lectus nisl nibh. finibus, libero. Quisque Mauris fames",
      "imperdiet pellentesque risus molestie non ac sem risus senectus ultricies lectus nisl bibendum. tristique sit Pellentesque in, vel ac eros. a at malesuada porttitor tempor Ut scelerisque. non vestibulum. cursus egestas. eu amet, volutpat fames et massa et interdum. netus Mauris dolor ac molestie vel hendrerit, morbi Nam mauris consectetur est. adipiscing habitant dolor purus tristique Sed Quisque aliquet. tempor ac suscipit leo elit. Aenean eu libero. Duis nibh. interdum. sagittis sollicitudin"
    ]
  },
  "analytics_identifier": "nibh. bibendum. turpis eros. Pellentesque imperdiet non tristique molestie Suspendisse tristique malesuada nisl Ut interdum. suscipit tempor pellentesque Sed eu a netus cursus scelerisque. habitant lectus leo Ut aliquet. egestas. eu non Nam sollicitudin at et risus dolor risus ac",
  "auth_bypass_ids": [
    "b2b1e7fc-8f32-4e19-9cf0-08c1eaf289c5",
    "0e20730d-1e23-4647-beba-baff4213a38b"
  ],
  "base_path": null,
  "bulk_publishing": false,
  "change_note": "aliquet. tristique Ut cursus at vestibulum. interdum. suscipit ac",
  "description": "eu et libero. volutpat eu at suscipit orci Quisque sollicitudin interdum. ac lorem nibh aliquet. habitant Ut sagittis amet, vestibulum. ipsum nisl Nam Mauris finibus, interdum. Aenean eros. consectetur massa Pellentesque non lectus imperdiet non hendrerit, adipiscing scelerisque. mauris bibendum. netus sit tristique molestie Sed egestas. Suspendisse a morbi ac est. molestie tristique sem dolor nibh. fames Lorem ultricies elit. sed risus risus Duis cursus Ut senectus Nam ac ac porttitor et purus",
  "details": {
    "url": "http://example.com/69af7c0b-1b6a-445e-9ce0-9f468228af5c#a0fd896a4d9b14969582c2e33dad7283"
  },
  "document_type": "external_content",
  "need_ids": [
    "porttitor",
    "et interdum. non Aenean orci elit. scelerisque. fames Lorem adipiscing a cursus libero. lectus eros. morbi massa hendrerit, ipsum finibus, molestie senectus Nam risus netus leo at sem Mauris non dolor porttitor Sed suscipit mauris eu aliquet. sollicitudin consectetur sit sagittis tristique amet, dolor purus Duis ac nibh. sed vestibulum. in, volutpat tempor ac malesuada Suspendisse ac pellentesque imperdiet nisl bibendum. egestas. habitant vel tempor ac nibh lorem"
  ],
  "previous_version": "ultricies non nibh. massa consectetur dolor imperdiet non eu turpis sollicitudin est. molestie bibendum. interdum. Pellentesque vel sed hendrerit, vel Mauris egestas. lorem in, Duis eros. ipsum Suspendisse interdum. elit. Nam vestibulum. Lorem molestie libero. fames pellentesque dolor",
  "public_updated_at": "2019-11-26T07:27:28+00:00",
  "publishing_app": "manuals-publisher",
  "rendering_app": null,
  "routes": [
    "in, purus aliquet. ac lectus bibendum. ac pellentesque nibh tempor Mauris adipiscing leo Aenean ac lorem et tristique Lorem porttitor massa Quisque malesuada nisl nibh. non hendrerit, libero. turpis eu habitant morbi Nam Ut interdum. ultricies sit imperdiet ipsum Suspendisse tempor volutpat Ut molestie mauris netus sollicitudin finibus, a sem risus cursus amet, scelerisque. eu suscipit eros. est. non ac Pellentesque Nam vel consectetur interdum. vel fames senectus egestas. elit. risus molestie orci sed vestibulum. et at tristique dolor dolor Sed Duis sagittis",
    "cursus ultricies orci consectetur turpis fames leo vel ac sollicitudin pellentesque molestie Mauris imperdiet Suspendisse nibh. Nam vel nisl tempor Pellentesque purus egestas. molestie interdum. netus in, sed ipsum sem risus mauris tempor Ut a dolor ac est. Lorem amet, ac malesuada volutpat aliquet. tristique eu Aenean Duis porttitor scelerisque. eu libero. dolor sagittis Sed hendrerit, risus et elit. senectus Quisque non bibendum. tristique at vestibulum.",
    "risus non molestie tristique et lorem Sed tempor non netus sit sagittis Quisque bibendum. ac leo Ut dolor ultricies egestas. Suspendisse eu Duis sollicitudin cursus sem eu elit. vestibulum. tempor turpis sed et est. lectus consectetur ac Aenean interdum. eros. tristique dolor molestie at amet, fames Ut ac hendrerit, morbi",
    "malesuada ac eros. Pellentesque lectus netus nibh mauris sed ac Nam vestibulum. habitant cursus ac a egestas. at et Duis ipsum ultricies senectus eu ac morbi dolor Quisque hendrerit, nisl non interdum. libero. sit imperdiet Lorem turpis risus adipiscing orci tristique leo fames finibus, nibh. Ut",
    "in, vel",
    "hendrerit, ac Mauris interdum. interdum. risus cursus Quisque sagittis vel molestie",
    "at Sed hendrerit, et Quisque lorem sem nisl orci molestie bibendum. in, vel ultricies sollicitudin sagittis eu dolor non elit. ac purus tempor habitant Nam lectus dolor risus Lorem tristique finibus, vestibulum. a fames Pellentesque libero. porttitor molestie pellentesque adipiscing aliquet. eu Ut mauris suscipit ipsum netus tristique senectus volutpat risus consectetur Ut leo est. vel interdum. cursus ac Suspendisse massa sed Duis nibh imperdiet et scelerisque. ac amet, turpis egestas. interdum. morbi tempor malesuada ac Aenean sit",
    "sem massa non a molestie tristique Pellentesque Nam lectus pellentesque Suspendisse Duis mauris bibendum. Lorem at dolor sed scelerisque. egestas. sit ipsum"
  ],
  "schema_name": "external_content",
  "title": "ac tristique morbi orci Aenean et Nam purus finibus, est. senectus sem adipiscing Pellentesque cursus ac Duis egestas. tristique turpis interdum. Sed nibh. nisl sollicitudin mauris tempor pellentesque habitant Nam malesuada non molestie Ut hendrerit, ac ipsum sit at eu suscipit risus imperdiet amet, lorem Mauris vestibulum. libero. elit. sed risus bibendum. non eu a eros. Lorem vel nibh leo massa interdum. ac volutpat porttitor scelerisque. dolor ultricies",
  "update_type": "minor"
}

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,
  "previous_version": "est. molestie fames tempor sagittis finibus, dolor eu at Ut consectetur libero. elit. malesuada vestibulum. morbi pellentesque habitant suscipit senectus tempor risus orci molestie sollicitudin Ut sem turpis leo amet, Sed eu nibh Pellentesque et ipsum bibendum. in, massa scelerisque. non vel Suspendisse interdum. sed lectus a Duis hendrerit, risus tristique mauris imperdiet et interdum. Lorem Nam lorem netus non volutpat vel ac dolor Nam porttitor aliquet. ultricies Quisque ac Mauris eros. purus nisl cursus tristique sit adipiscing"
}