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

{
  "analytics_identifier": null,
  "change_note": "sollicitudin Mauris lectus sit Duis bibendum. vestibulum. finibus, Aenean Nam suscipit tristique orci risus vel a vel elit. eu est. interdum. malesuada tristique risus purus ac ultricies dolor non adipiscing eu massa ac Quisque imperdiet Nam et at ac consectetur cursus molestie in, non turpis eros. ac Sed nibh sagittis Ut Ut interdum. aliquet. nibh. tempor nisl mauris lorem egestas. amet, libero. sed morbi netus scelerisque. fames hendrerit, senectus volutpat et Lorem molestie leo Suspendisse Pellentesque ipsum pellentesque sem habitant dolor porttitor tempor",
  "description": "risus ac interdum. sem purus nibh Mauris et non ultricies at nibh. senectus vel amet, nisl aliquet. a Ut finibus, vestibulum. adipiscing eu Suspendisse ac tristique risus tempor dolor consectetur egestas. pellentesque malesuada Aenean tempor sollicitudin ipsum orci eros. in, Nam lectus non fames massa molestie ac Sed ac Quisque libero. eu Ut molestie et elit. habitant Lorem bibendum. netus scelerisque. tristique sagittis Pellentesque est. sed sit turpis porttitor volutpat Nam lorem interdum. imperdiet cursus Duis dolor vel mauris hendrerit, morbi suscipit leo",
  "details": {
    "url": "http://example.com/4023f1bb-dcba-46b1-bec3-47c56b36d8af/e17e42b2-5865-419c-9385-ac650e986bf7/b8b64358-3f87-4554-8309-9cbd16a8ead7/58735ca0-0edb-4e15-9e72-4094cfe10aa0/bf4717b5-3367-4f1a-8148-ffd8416ab0e5#de205b577fe87c2e5785a20820ac03e3"
  },
  "document_type": "external_content",
  "links": {
  },
  "need_ids": [
    "",
    "eros. at ac et vel nibh. fames vel ac Ut Aenean est. dolor vestibulum. Ut molestie ac Nam lectus consectetur tempor Lorem aliquet. risus nibh suscipit habitant libero. hendrerit, ac porttitor leo molestie senectus malesuada Suspendisse Duis non",
    "Suspendisse amet, tristique molestie Quisque non vestibulum. cursus purus finibus, Nam interdum. habitant sit est. sem in, vel malesuada netus aliquet. nisl massa Duis volutpat Ut morbi sagittis elit. suscipit vel tempor dolor imperdiet leo eu sed ac orci non ipsum lectus pellentesque bibendum. tempor risus adipiscing a dolor ultricies risus Pellentesque nibh. molestie nibh sollicitudin tristique hendrerit, scelerisque. consectetur ac",
    "finibus, eros. Nam ac tempor turpis molestie eu vel tristique non suscipit netus molestie senectus volutpat sem",
    "Nam Quisque Ut netus non purus turpis est. malesuada non aliquet. habitant leo massa Pellentesque fames dolor libero. Aenean nisl amet, mauris molestie Suspendisse dolor in, ac tristique finibus, et hendrerit, eros. et suscipit porttitor adipiscing egestas. cursus imperdiet bibendum. at eu orci Duis sit risus ac tristique eu consectetur tempor tempor sollicitudin senectus vel ultricies volutpat vel molestie ac ac interdum. lectus pellentesque sagittis nibh sed morbi vestibulum. ipsum",
    "nibh. molestie interdum. eu Lorem scelerisque. bibendum. in, cursus ac eros. lectus habitant nibh Ut",
    "ac suscipit sit libero. ac non est. nisl turpis imperdiet mauris interdum. pellentesque sed porttitor nibh. cursus habitant interdum. fames ipsum ultricies Ut adipiscing tristique massa hendrerit, elit. finibus, tempor bibendum. Nam risus morbi dolor sollicitudin vel vestibulum. orci tempor Lorem netus egestas. eu tristique Quisque leo molestie malesuada Suspendisse Aenean Mauris purus at et risus a dolor non Sed vel Pellentesque Nam molestie eros. Duis consectetur scelerisque.",
    "Sed ac tristique ipsum ac non risus habitant lorem bibendum. eros. Ut fames interdum. Ut suscipit purus adipiscing orci pellentesque sed mauris non molestie morbi malesuada tempor hendrerit, et tristique est. cursus a Nam sagittis amet, scelerisque. Suspendisse ac ultricies vel turpis elit. Nam leo Aenean ac vestibulum. nibh. Duis in, vel risus molestie massa sem libero. finibus, nibh dolor imperdiet eu Mauris senectus egestas. et aliquet. Pellentesque",
    "non leo suscipit elit. aliquet. at sollicitudin Sed tempor habitant Suspendisse vel ac pellentesque porttitor et massa amet, vestibulum. ac finibus, molestie senectus interdum. Aenean nibh. lorem netus morbi Ut Nam ultricies fames Duis Mauris adipiscing nibh lectus Quisque eros. egestas. nisl Pellentesque tristique orci consectetur"
  ],
  "public_updated_at": "2018-11-07T20:18:53+00:00",
  "publishing_app": "info-frontend",
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "est. nibh porttitor ipsum molestie senectus sem habitant ac non aliquet. leo a Pellentesque non sagittis Nam morbi Ut Mauris orci Aenean et elit. eu eu Suspendisse nisl molestie scelerisque. lectus nibh. consectetur amet, netus sit tempor Nam risus purus sed vel cursus libero. dolor lorem",
  "update_type": "republish"
}

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
}