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
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, de, dr, el, en, es, es-419, et, fa, fr, he, hi, hu, hy, id, it, ja, ka, ko, lt, lv, ms, pl, ps, pt, ro, ru, si, sk, so, sq, sr, 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, manuals-frontend, manuals-publisher, maslow, performanceplatform-big-screen-view, policy-publisher, publisher, rummager, search-admin, 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": {
  },
  "analytics_identifier": "eros. risus Duis sem volutpat malesuada Nam Quisque sit pellentesque eu Suspendisse ipsum morbi risus",
  "base_path": null,
  "bulk_publishing": false,
  "change_note": "egestas. Pellentesque finibus, interdum. scelerisque. non imperdiet",
  "description": "tempor Lorem purus morbi in, sollicitudin interdum. sem sed ipsum suscipit ac nibh egestas. nibh. risus risus Pellentesque orci Quisque Sed imperdiet non bibendum. finibus, libero. massa vel eros. turpis elit. non malesuada molestie fames adipiscing mauris vel ac Aenean tristique porttitor amet, habitant leo sagittis netus Suspendisse Duis aliquet. tempor et hendrerit, eu Nam tristique et vestibulum. a Ut scelerisque. cursus molestie interdum. lorem ac ultricies Ut Nam ac lectus pellentesque volutpat",
  "details": {
    "hidden_search_terms": [
      "sed cursus finibus, dolor molestie est. Ut hendrerit, massa nisl ac suscipit elit. tempor eros. in, Nam vel Ut mauris sit fames ac libero. habitant at Pellentesque ipsum tristique consectetur risus Sed sagittis bibendum. volutpat nibh. molestie tristique eu Duis porttitor senectus interdum. eu"
    ],
    "url": "http://example.com/4db8b98a-23db-465c-ad39-426965a53926#b11d54ed442e750a1c358e4867c696f8"
  },
  "document_type": "external_content",
  "first_published_at": "2018-09-02T15:20:48+00:00",
  "last_edited_at": "2018-08-14T01:02:42+00:00",
  "links": {
  },
  "locale": "uk",
  "previous_version": "ultricies eu netus sagittis libero. nisl risus nibh. volutpat Quisque et eros. vel ac at tristique orci tristique et elit. ipsum porttitor sed purus est. non Duis sem Ut senectus consectetur ac bibendum. ac amet, Nam hendrerit, habitant morbi Sed malesuada interdum. imperdiet",
  "publishing_app": "static",
  "schema_name": "external_content",
  "title": "a et eu Ut vel ac interdum. sit porttitor scelerisque. lorem risus aliquet. interdum. tempor finibus, Nam tristique consectetur et ac adipiscing dolor Duis est. dolor purus non fames senectus malesuada amet, bibendum. hendrerit, pellentesque eu at sem morbi orci sollicitudin turpis nibh. libero. Aenean volutpat Quisque cursus sed nisl massa Mauris Sed in, ac ac non"
}

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