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

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

{
  "base_path": null,
  "description": "mauris ac Ut in, sagittis porttitor senectus a Nam sit nisl pellentesque eu risus scelerisque. habitant hendrerit, massa non Nam nibh Quisque elit. ac interdum. Aenean tristique netus Pellentesque suscipit Sed lectus sollicitudin leo nibh. purus eu ipsum ac Mauris malesuada consectetur Ut ultricies vel morbi vel orci imperdiet fames et est. lorem Lorem dolor interdum. finibus, volutpat tempor molestie bibendum. non vestibulum.",
  "details": {
    "hidden_search_terms": [

    ],
    "url": "http://example.com/2ba11122-4126-4434-8bfa-49b00e5cb34e/0e8d590b-a8b4-403a-92dd-9986e7a3069e#5a6adfb9c6a4077f0200d696cefbc7a8"
  },
  "document_type": "external_content",
  "last_edited_at": "2018-08-19T05:39:43+00:00",
  "phase": "beta",
  "public_updated_at": "2018-08-07T10:30:34+00:00",
  "publishing_app": "calculators",
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "consectetur turpis senectus aliquet. volutpat libero. vel nisl lectus ac Nam egestas. hendrerit, dolor sed nibh imperdiet a tempor orci purus dolor Duis interdum. molestie ultricies est. non Pellentesque Ut Mauris bibendum. elit. malesuada tristique scelerisque. leo pellentesque risus Sed sem at sagittis tempor interdum. risus Nam vel sit ac adipiscing vestibulum. et fames cursus sollicitudin Lorem Aenean in, finibus, et netus massa lorem eu tristique molestie Suspendisse habitant porttitor amet, eu morbi suscipit eros. nibh. ac non ipsum mauris Quisque Ut ac"
}

The links for this item. This is what a publishing application sends in a patch_links call.

Attributes

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "links": {
  },
  "previous_version": "habitant tempor et egestas. dolor vestibulum. pellentesque interdum. fames est. imperdiet Aenean molestie Nam massa ac Ut morbi Pellentesque risus dolor non in, mauris malesuada finibus, netus tristique cursus vel sagittis senectus ac volutpat interdum. lectus orci sed adipiscing leo"
}