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": [
      "non cursus lectus molestie tristique habitant Ut scelerisque. sit suscipit ac massa ultricies dolor purus elit. finibus, netus nisl fames nibh. risus interdum. aliquet. libero. mauris orci",
      "purus adipiscing massa dolor sem tristique Sed elit. interdum. amet, Suspendisse non consectetur ac malesuada senectus Ut sit cursus at ac Pellentesque vestibulum. bibendum. dolor Mauris Aenean netus a finibus, nibh imperdiet non Lorem eros. eu in, porttitor tempor",
      "vestibulum. elit. malesuada Quisque suscipit sagittis egestas. morbi sem",
      "sem Ut amet, eu sit Nam libero. senectus eu sed non purus dolor orci lectus et netus non dolor hendrerit, risus habitant vestibulum. est. scelerisque. leo volutpat nibh nisl turpis in, molestie ac interdum. sagittis lorem a imperdiet Suspendisse Aenean Quisque adipiscing tristique aliquet. Lorem vel massa tempor egestas. eros. elit.",
      "dolor morbi netus pellentesque a interdum. dolor Lorem scelerisque. Ut vel interdum. leo tempor libero. Duis mauris amet, nibh. et Nam eros. lorem molestie Suspendisse at bibendum. ac Aenean consectetur risus molestie Pellentesque fames elit. purus tempor finibus, Mauris porttitor ac sit aliquet. vestibulum. tristique ipsum risus in, ac Quisque sem eu egestas. non et sed hendrerit, suscipit turpis Nam nibh Sed",
      "Nam malesuada ultricies dolor lectus tristique Lorem sed purus egestas. hendrerit, imperdiet nibh. porttitor non senectus orci molestie Quisque scelerisque. ac a ac netus volutpat aliquet. pellentesque interdum. molestie amet, mauris massa adipiscing habitant est. at nibh Ut ipsum dolor eros. vestibulum. libero. nisl morbi eu elit. sem Nam bibendum. Mauris ac in, turpis Aenean et tempor",
      "cursus est. scelerisque. non mauris volutpat turpis risus finibus, vestibulum. elit. non senectus lorem pellentesque sollicitudin tristique Aenean Nam nibh. molestie tempor vel ac ac egestas. dolor Sed consectetur bibendum. at malesuada Nam eu interdum. eu eros. nisl ipsum a tempor aliquet. tristique sed orci Mauris imperdiet ac lectus interdum. sem Suspendisse habitant amet, suscipit libero. vel hendrerit, ultricies nibh molestie netus in, ac Lorem et Ut massa porttitor",
      "sem et Quisque tristique in, ac tristique consectetur molestie massa malesuada adipiscing tempor sed eu et lorem Nam bibendum. scelerisque. vestibulum. eu Nam dolor orci nibh. sagittis Sed risus Aenean risus volutpat nibh purus cursus dolor netus tempor finibus, morbi Duis fames sollicitudin aliquet. amet, sit nisl ac interdum. Suspendisse pellentesque habitant lectus ac interdum. mauris imperdiet ac turpis leo non eros. a non Lorem senectus suscipit at vel",
      "molestie netus egestas. sagittis fames in, bibendum. aliquet. tristique interdum. ipsum massa ac libero."
    ]
  },
  "analytics_identifier": "sollicitudin tristique malesuada et Ut Sed consectetur et mauris nibh ultricies risus ac Lorem lorem amet, dolor morbi nibh. hendrerit, leo sit pellentesque Nam turpis finibus, interdum. molestie imperdiet at fames Ut sagittis Pellentesque adipiscing vestibulum. tristique",
  "auth_bypass_ids": [
    "db10a33e-902d-4f4e-bfb4-fc9dd4c5a288",
    "f1c00a2a-fc6d-48b6-8c5f-bd8662bac2b6",
    "fe60d44c-aa58-42e2-8e00-6ed3e7af33b4",
    "c86a7418-b32c-4113-b823-6f5b7aba0799"
  ],
  "base_path": null,
  "description": "at libero. a interdum. ipsum est. vel ac sit orci Lorem sem risus elit. hendrerit, porttitor lectus vestibulum. molestie Aenean sed massa lorem cursus sagittis ultricies morbi bibendum. eros. imperdiet non ac nibh pellentesque risus purus dolor Mauris sollicitudin leo consectetur Nam non nibh. molestie Ut Duis ac fames nisl vel eu et adipiscing aliquet. eu habitant in, senectus volutpat",
  "details": {
    "url": "http://example.com/06934a40-e25d-4a0e-9db5-0aebf71d3533/5dfaa40a-2d69-4c84-99d0-6b494c628d90/6a408b7f-a4bb-4f4a-acb1-d6c1181b1199/b43d09a7-377d-4881-8599-cc501380f530/250c01f2-2a4d-485b-9d70-2a8e720beaeb#2d8aa1391ed6eafea363893961f93ff2"
  },
  "document_type": "external_content",
  "first_published_at": "2020-03-11T12:01:42+00:00",
  "locale": "gd",
  "phase": "alpha",
  "previous_version": "Nam tristique finibus, molestie tristique Ut eros. morbi vel in, aliquet. tempor tempor pellentesque volutpat sagittis Duis sollicitudin bibendum. sit habitant risus leo Aenean Nam porttitor ac non adipiscing vel ipsum Pellentesque egestas. sed dolor eu Quisque cursus mauris suscipit elit. ac fames eu massa est. hendrerit, ac a nibh. dolor et",
  "publishing_app": "share-sale-publisher",
  "schema_name": "external_content",
  "title": "tristique in, ipsum ultricies tristique Ut et netus sem non imperdiet ac lectus ac Aenean cursus Pellentesque tempor pellentesque at sed molestie Nam purus nisl orci non Nam eu Suspendisse dolor dolor vel et aliquet. mauris consectetur sagittis sit",
  "update_type": "major"
}

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,
  "previous_version": "eros. ac et bibendum. porttitor orci tempor cursus suscipit nibh elit. non a finibus, egestas. ultricies morbi pellentesque et at amet, Ut Lorem tristique Quisque mauris sagittis libero. dolor ac vestibulum."
}