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
organisations
array

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, 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": null,
  "base_path": null,
  "description": "cursus molestie",
  "details": {
    "hidden_search_terms": [
      "Suspendisse ac Pellentesque libero. lectus fames dolor adipiscing Aenean molestie sit sagittis turpis nibh bibendum. vestibulum. senectus tempor malesuada sed Ut molestie lorem risus et suscipit sem aliquet. ac Quisque sollicitudin vel tristique a finibus, nibh. dolor leo Lorem porttitor amet, purus Nam Sed est. volutpat Ut eu in, risus non Mauris morbi ac consectetur netus mauris massa vel eu elit. orci ipsum pellentesque scelerisque. egestas. habitant ac et hendrerit, tempor tristique ultricies nisl at imperdiet eros. interdum. Nam non Duis interdum. cursus",
      "Nam lectus at dolor orci volutpat pellentesque mauris molestie tristique vel sollicitudin interdum. non porttitor interdum. nibh. lorem sed eu tristique",
      "dolor ultricies bibendum. Sed tempor suscipit sed elit. senectus scelerisque. nisl vel adipiscing interdum. ac at sit mauris sollicitudin non sem Pellentesque a risus consectetur purus Duis porttitor malesuada volutpat morbi imperdiet dolor amet, turpis in, est. risus vestibulum. et eu ipsum fames tristique Mauris vel Aenean massa ac Nam et molestie molestie"
    ],
    "url": "http://example.com/5e97ce0d-4834-40ad-9438-c83a85c86a1c/36e132f9-2701-437a-9637-717808d6d17a/730b2c3a-c31b-49cb-92d5-929dae361dc1#73e2028b562cc818113a29ae9633ff30"
  },
  "document_type": "external_content",
  "need_ids": [
    "Nam nisl tristique sem vestibulum. Nam vel risus suscipit at non et eu turpis netus Mauris fames volutpat habitant bibendum. adipiscing dolor interdum. consectetur nibh. amet, Ut ultricies lectus egestas. scelerisque. leo eu Ut interdum. morbi tristique Aenean mauris cursus molestie",
    "Suspendisse a molestie tristique Aenean fames nisl tristique netus Nam sem pellentesque imperdiet hendrerit, nibh. risus molestie et volutpat habitant Quisque et est. lectus egestas. orci sagittis eros. Pellentesque non in, adipiscing ac lorem ipsum sollicitudin scelerisque.",
    "vel et Sed morbi consectetur ac Quisque tristique tristique non Ut adipiscing ultricies pellentesque Nam ipsum vestibulum. hendrerit, sagittis Suspendisse porttitor Lorem ac lectus Aenean netus dolor amet, non orci Ut Duis habitant purus et nisl dolor",
    "nisl sagittis vel eros. imperdiet vel amet, senectus suscipit morbi nibh. est. Nam et vestibulum. Mauris interdum. tristique finibus, ipsum elit. porttitor sit scelerisque. fames habitant risus dolor eu ac non hendrerit, Duis Lorem mauris Ut leo tempor purus Nam malesuada Pellentesque lectus bibendum. volutpat sem sollicitudin eu orci adipiscing libero. in, ac interdum. ac massa turpis ac",
    "at Sed bibendum. non nisl",
    "at sit Ut Sed vel amet, netus Mauris molestie consectetur elit. morbi dolor leo Ut eu",
    "suscipit a nisl Nam Ut consectetur ac netus orci ultricies cursus risus ac",
    "volutpat risus tristique purus porttitor ultricies libero. adipiscing Suspendisse eu Mauris in, vel amet, interdum. Lorem dolor sagittis fames sed turpis sit scelerisque. Ut finibus, mauris",
    "Ut Quisque molestie Aenean sollicitudin adipiscing ipsum interdum. dolor ultricies turpis ac risus egestas. risus massa ac imperdiet senectus nibh. morbi non est. vestibulum. eu tristique finibus, elit. et lorem aliquet. sed orci habitant scelerisque. consectetur libero. porttitor Lorem eros. in, a",
    "sollicitudin scelerisque. nibh vel bibendum. elit. finibus, Mauris purus Suspendisse sem eros. massa senectus ac Ut eu non netus tristique interdum. sit vel non orci ac risus pellentesque mauris Quisque vestibulum. sagittis nibh. est. sed a dolor imperdiet Lorem interdum. in, suscipit lorem libero. Ut habitant ultricies volutpat turpis Aenean ipsum Nam egestas. leo amet, et consectetur Sed porttitor lectus dolor eu ac nisl tempor Duis risus cursus molestie adipiscing Pellentesque molestie tristique hendrerit, morbi et tempor"
  ],
  "public_updated_at": "2019-08-01T07:44:01+00:00",
  "publishing_app": "performanceplatform-big-screen-view",
  "rendering_app": null,
  "routes": [

  ],
  "schema_name": "external_content",
  "title": "ac eros. interdum. tristique Lorem elit. Duis sed mauris bibendum. eu vel habitant Nam tempor eu Nam lectus vestibulum. imperdiet cursus Suspendisse Sed hendrerit, a aliquet. Mauris ultricies et orci turpis consectetur molestie dolor porttitor tristique adipiscing sit Pellentesque sem risus ac nisl libero. lorem Ut",
  "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

{
}