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

{
  "analytics_identifier": "senectus pellentesque tristique Nam sed aliquet. Duis Aenean volutpat eu Mauris Suspendisse dolor est. leo cursus vel adipiscing non suscipit ac tristique a sit turpis Ut fames ipsum non finibus, scelerisque. dolor mauris consectetur Pellentesque nisl ac amet, habitant Sed netus morbi sollicitudin Ut egestas. vestibulum. tempor molestie Nam ultricies risus eu bibendum. porttitor nibh. at interdum. lorem Quisque eros. imperdiet sagittis purus malesuada lectus sem risus massa Lorem et et ac ac hendrerit, in, libero. molestie tempor vel elit. interdum. nibh orci",
  "bulk_publishing": false,
  "change_note": "eu massa in, vestibulum. Aenean vel volutpat eu Lorem imperdiet ipsum scelerisque. Ut consectetur interdum. hendrerit, ac leo bibendum. malesuada ac Sed at vel molestie egestas. sit interdum. Quisque libero. ac suscipit porttitor nibh amet, risus morbi eros. dolor et Pellentesque sollicitudin et nibh. fames a non turpis sed aliquet. molestie Nam tristique tempor",
  "description": "imperdiet morbi nibh. non",
  "details": {
    "hidden_search_terms": [
      "Mauris dolor molestie Ut volutpat leo orci malesuada finibus, pellentesque Suspendisse mauris interdum. imperdiet Pellentesque eros. Nam Aenean dolor nisl libero. morbi lectus aliquet. et in, adipiscing ultricies Ut ac tristique nibh egestas. elit. sagittis et massa",
      "libero. non risus Mauris eu risus finibus, interdum. lorem molestie bibendum. et vestibulum. eu tristique suscipit in, Nam pellentesque est. Aenean ac Quisque mauris egestas. eros. purus et consectetur porttitor netus cursus sit amet, Ut ac massa hendrerit, lectus Ut adipiscing at sed dolor tempor Nam sagittis senectus orci nisl habitant vel ac turpis Duis Sed morbi tempor elit. ac ultricies leo aliquet. a Pellentesque vel Suspendisse nibh.",
      "bibendum. libero. ac Suspendisse Ut molestie Nam Quisque suscipit sem pellentesque malesuada Mauris scelerisque. risus purus sed tempor eros. ac tempor Duis vestibulum. a massa orci amet, mauris dolor imperdiet non elit.",
      "porttitor tristique eros. ac cursus risus elit. est. egestas. vel eu nisl consectetur Sed dolor ac Lorem a interdum. dolor mauris adipiscing aliquet. Mauris interdum. nibh. sollicitudin habitant pellentesque ultricies turpis nibh Pellentesque lectus ipsum eu at leo non tempor non hendrerit, Nam libero. bibendum. molestie amet, imperdiet vel netus sagittis ac malesuada molestie in, Duis suscipit massa purus vestibulum. volutpat sem Suspendisse fames finibus, et Nam risus et morbi sed tempor sit Aenean Ut scelerisque. Quisque Ut tristique",
      "non ac massa lectus eros. turpis egestas. libero. Ut cursus eu ac adipiscing scelerisque. consectetur vestibulum. et tristique Nam eu est. volutpat nibh ac aliquet. Nam sagittis porttitor ipsum tempor",
      "ac et tristique elit. Nam tristique a et tempor Quisque dolor Ut massa lorem Ut leo cursus sem scelerisque. Aenean mauris at turpis bibendum. porttitor fames egestas. in, vestibulum. suscipit nisl nibh. senectus vel interdum. ac sagittis consectetur orci Duis Pellentesque ipsum vel hendrerit, volutpat non eu ac habitant libero. finibus, eros. sed molestie interdum. adipiscing dolor Lorem est. imperdiet Suspendisse nibh risus amet, pellentesque malesuada aliquet. lectus risus tempor non ac Sed sit eu ultricies Nam morbi molestie sollicitudin purus Mauris",
      "cursus fames mauris morbi Mauris bibendum. vel risus interdum. netus Ut sit sagittis sed scelerisque. habitant lectus senectus turpis nibh. dolor amet, porttitor pellentesque nibh Nam Suspendisse eu ac",
      "eu scelerisque. leo Ut senectus ac molestie risus habitant dolor turpis tempor finibus, nibh. a et purus lorem sit nisl in, fames vestibulum. vel elit. adipiscing tempor tristique risus cursus massa malesuada volutpat Quisque interdum. Lorem ultricies bibendum. Nam consectetur aliquet. egestas. Sed sagittis ipsum non imperdiet dolor netus ac at Ut Nam morbi interdum. sem eros. mauris lectus et eu Pellentesque Duis Suspendisse amet, molestie libero. hendrerit, vel ac tristique ac non orci nibh Aenean sed porttitor pellentesque suscipit est. Mauris",
      "consectetur Aenean vel vestibulum. habitant",
      "sem dolor interdum. molestie vel leo eros. senectus et dolor Lorem Aenean Duis habitant ac Nam molestie sagittis volutpat consectetur a lectus Pellentesque sollicitudin scelerisque. Mauris lorem tempor tempor cursus orci tristique hendrerit, in, Nam turpis risus massa ac est. libero. ultricies elit. Suspendisse vel et fames interdum. eu ac imperdiet bibendum. malesuada sit porttitor eu nibh risus morbi Ut egestas. nisl at tristique amet, Ut mauris Sed ipsum vestibulum. pellentesque adipiscing aliquet. nibh. sed Quisque finibus, ac"
    ],
    "url": "http://example.com/bd1126c6-1376-4898-abad-52a1ba8ab3c8/a057a61e-3fa4-48e3-8bba-40621a84c048#573adf6333c6b4f26f43389e2d86e8e4"
  },
  "document_type": "external_content",
  "first_published_at": "2019-09-28T18:32:48+00:00",
  "last_edited_at": "2019-09-07T06:11:34+00:00",
  "links": {
  },
  "need_ids": [
    "est. scelerisque. elit. Quisque pellentesque tristique eu eu bibendum. sollicitudin amet, Pellentesque morbi Ut netus Lorem nibh purus a volutpat sem cursus lorem mauris sed at interdum. nisl fames ac hendrerit, senectus risus porttitor consectetur eros. in, leo vestibulum. Mauris molestie egestas. ac habitant dolor Duis risus Aenean tempor non ultricies Ut imperdiet sit malesuada orci",
    "Sed lectus tristique ac morbi sollicitudin hendrerit, eros. porttitor orci et senectus in, Nam egestas. a consectetur"
  ],
  "previous_version": "non suscipit imperdiet turpis orci hendrerit, dolor morbi scelerisque. egestas. aliquet. eu finibus, habitant Pellentesque vel sed a",
  "publishing_app": "content-publisher",
  "redirects": [
    "malesuada est. Duis nibh. Aenean Lorem fames vel Quisque sed Suspendisse lectus sem vel non et imperdiet tempor tempor a bibendum. eros. purus Nam consectetur et volutpat Ut nibh Ut sollicitudin adipiscing egestas. risus sagittis amet, eu finibus, nisl ac massa Sed netus suscipit risus non ipsum Mauris dolor elit. sit libero. turpis molestie molestie hendrerit, porttitor Pellentesque dolor mauris vestibulum. at"
  ],
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "molestie interdum. interdum. orci amet, eros. nibh. et porttitor mauris Aenean vel scelerisque. tempor elit. massa"
}

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": false
}