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, 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": {
    "users": [
      "imperdiet sed pellentesque ac Ut molestie Suspendisse ac Ut eros. morbi massa elit. purus et malesuada eu fames in, lorem Aenean tristique libero. Mauris non tempor Nam Nam nibh dolor interdum. molestie et interdum. lectus Quisque Sed cursus hendrerit,",
      "tempor sem sit orci Duis sagittis molestie Aenean finibus, ultricies ac non tristique leo eros. cursus",
      "sagittis egestas. fames et eu mauris in, leo Ut est. ipsum tristique imperdiet Mauris nisl lectus vel cursus nibh dolor non molestie lorem malesuada tempor molestie Aenean nibh. Ut Duis non Lorem volutpat risus senectus elit. vestibulum. ac Suspendisse suscipit vel consectetur amet, Sed tristique a dolor Nam pellentesque Nam Quisque at eros. adipiscing ac sollicitudin ac orci Pellentesque porttitor interdum. tempor hendrerit, scelerisque. ac et bibendum. habitant interdum.",
      "molestie risus Mauris leo ultricies libero. vestibulum. adipiscing volutpat Aenean tempor eu et non Nam cursus Nam interdum. habitant amet, et consectetur interdum. morbi Pellentesque suscipit ac tristique lectus finibus, a ac Quisque nibh risus sem bibendum. non massa netus elit. Ut",
      "adipiscing Ut ac Lorem Suspendisse pellentesque Sed ipsum ultricies non malesuada ac vel porttitor morbi volutpat habitant netus Nam Aenean",
      "Quisque Suspendisse purus",
      "tristique amet, porttitor senectus Pellentesque risus turpis Nam",
      "habitant imperdiet amet, tristique nisl nibh. ac a netus massa tristique et ultricies dolor non egestas. leo lectus risus sagittis",
      "nisl orci tempor eros. aliquet. nibh Nam volutpat at ipsum turpis Ut lectus tempor vel eu molestie Nam massa cursus leo malesuada interdum. adipiscing Quisque Aenean vestibulum. scelerisque.",
      "sem tempor finibus, Quisque sagittis sollicitudin volutpat suscipit sed turpis Nam Mauris Aenean Nam aliquet. leo porttitor ultricies ac at Suspendisse tempor ac cursus massa fames eu purus ac non nibh habitant eros. malesuada lorem netus morbi sit nibh. orci et Lorem lectus Sed eu Ut vel libero. pellentesque risus vel"
    ]
  },
  "base_path": null,
  "change_note": "tristique malesuada sollicitudin elit. dolor adipiscing a non vestibulum. sem suscipit sed morbi fames Duis dolor est. hendrerit, Quisque et eu ipsum tristique aliquet. lorem eros. vel libero. vel Sed volutpat Nam tempor lectus Lorem purus et scelerisque. risus Ut ultricies nisl ac risus Pellentesque leo imperdiet sagittis ac molestie at turpis eu non mauris pellentesque ac nibh. senectus sit porttitor Suspendisse massa in, netus bibendum. finibus, ac egestas. habitant consectetur Ut orci nibh Aenean Mauris molestie interdum. cursus interdum. Nam tempor amet,",
  "description": "Quisque ac elit. tristique sed purus sem eu egestas. imperdiet malesuada adipiscing interdum. Lorem at vestibulum. scelerisque. risus est. et cursus Pellentesque ac sollicitudin in, lectus porttitor aliquet. interdum. a netus tempor hendrerit, leo risus habitant ac Suspendisse Ut Ut orci nibh. nisl non Sed vel amet, morbi senectus dolor ac tempor ultricies non vel Duis sagittis Nam pellentesque bibendum. ipsum Nam molestie mauris sit volutpat consectetur Aenean molestie lorem massa dolor nibh eros. suscipit tristique eu libero. turpis Mauris finibus, fames et",
  "details": {
    "url": "http://example.com/f3cf12e6-3d9a-40f1-abe2-24b3c59423bc/058ab15f-9661-4c3a-ab6b-476ce392204c/81447190-b2ef-4fd8-8dee-c8ea620fb1f3/65658934-7d47-4cf9-8ebd-5fc7c8313bff#854258b805cc8103253f864e9847c7e3"
  },
  "document_type": "external_content",
  "first_published_at": "2019-01-31T02:42:16+00:00",
  "links": {
  },
  "locale": "sk",
  "phase": "beta",
  "previous_version": "ac aliquet. Suspendisse",
  "publishing_app": "publisher",
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "Quisque Sed aliquet. sagittis Suspendisse suscipit malesuada eu et sem ultricies netus lorem purus dolor a molestie Nam sit est. Pellentesque Ut ac risus nibh volutpat nisl habitant interdum. sed Duis adipiscing eu ac morbi"
}

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

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