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

{
  "analytics_identifier": null,
  "base_path": null,
  "description": "leo sed est. eu consectetur a imperdiet at pellentesque interdum. Duis ipsum habitant molestie molestie sit hendrerit, Suspendisse senectus eros. interdum. Sed et ac dolor non aliquet. tristique dolor netus turpis Ut vel in, tristique volutpat risus Lorem lectus egestas. ac sem sollicitudin malesuada tempor ac libero. massa risus sagittis morbi elit. nisl Nam purus orci Quisque cursus vestibulum. ultricies ac finibus, vel amet, fames nibh. Aenean Nam Ut non Mauris lorem",
  "details": {
    "hidden_search_terms": [
      "molestie Suspendisse purus ac fames lorem molestie turpis Pellentesque sed elit. dolor scelerisque. habitant libero. Sed tempor aliquet. amet, volutpat Mauris vestibulum. tristique nisl cursus eros. et mauris ac morbi nibh. Lorem in, pellentesque suscipit est. leo consectetur risus Ut ac vel Nam malesuada finibus, Ut non nibh Aenean at risus bibendum. massa ultricies sagittis netus eu lectus imperdiet Nam porttitor tempor adipiscing interdum. sit dolor a vel ipsum orci Quisque Duis eu egestas. ac",
      "Lorem Ut ac nibh tristique elit. eros. Mauris Suspendisse molestie Nam Aenean in, tempor vel orci senectus tristique dolor sed leo libero. non amet, tempor risus cursus sit interdum. ac porttitor sem nibh. netus mauris scelerisque. turpis eu sagittis non ac et eu Duis purus egestas. Sed lectus a dolor interdum. vel habitant adipiscing vestibulum. est. bibendum. nisl fames Nam aliquet. et massa lorem finibus, at sollicitudin morbi imperdiet molestie ipsum risus hendrerit, malesuada pellentesque consectetur Quisque ac Ut ultricies suscipit Pellentesque volutpat",
      "eu bibendum. netus orci lorem dolor molestie eu at ac pellentesque vestibulum. fames Ut eros. senectus ac tristique Sed suscipit dolor",
      "et sed elit. ac vestibulum. Ut pellentesque scelerisque. ac orci aliquet. fames Nam non ac nibh. turpis molestie nisl molestie est. in, hendrerit, Nam porttitor egestas. consectetur amet, Quisque tristique tempor finibus, Suspendisse mauris interdum. risus dolor netus et Ut malesuada vel senectus imperdiet Sed nibh Duis risus suscipit sagittis bibendum. cursus ac morbi lorem at massa purus eu adipiscing leo libero. sollicitudin ultricies sem ipsum a Mauris vel volutpat Pellentesque tempor lectus non habitant sit tristique dolor interdum. eros. Lorem eu",
      "et eros. finibus, tristique malesuada risus et egestas. purus dolor lorem tempor tempor molestie sit volutpat nibh consectetur molestie Ut ac mauris adipiscing ac non interdum. habitant sagittis vel sollicitudin Aenean a elit. pellentesque morbi eu senectus ultricies tristique nibh. Ut aliquet. risus in, massa bibendum. vel est. Duis fames orci sem Mauris at sed lectus imperdiet turpis ipsum non Nam leo nisl Nam cursus hendrerit, porttitor vestibulum. ac netus dolor Quisque Lorem",
      "tristique elit. purus nibh dolor molestie Duis mauris bibendum. sit ac dolor non netus et ac aliquet. leo Suspendisse vestibulum. imperdiet vel libero. nibh. massa et vel Mauris at tempor interdum. turpis eu consectetur volutpat Nam sem Sed interdum. Pellentesque fames senectus tempor ac non porttitor ac malesuada Nam sagittis Quisque Lorem eu lorem pellentesque suscipit amet,",
      "ac Nam purus nibh elit. Duis vestibulum. risus leo interdum. vel sagittis non eros. imperdiet et Suspendisse Sed tristique risus fames molestie dolor est. tempor turpis massa sem pellentesque tempor ac at"
    ],
    "url": "http://example.com/fa2cde55-eba9-4e7e-a170-550aa6d366e3/9be640a0-fc85-4568-9ab3-342ed4814cdd/199196ab-0b6e-4786-9230-cf15e82873a2/734d8088-452b-4e08-9b40-61d599573b37/b3f9417f-17ab-44a9-b9b9-4fbe0d879bf0#6e8773f9e43b37db786d1a4fe6caca1a"
  },
  "document_type": "external_content",
  "last_edited_at": "2018-03-18T05:08:36+00:00",
  "locale": "hi",
  "need_ids": [

  ],
  "previous_version": "porttitor molestie Duis amet, tristique Nam vel dolor finibus, imperdiet leo senectus sem habitant fames nibh. tempor cursus a ac Sed sagittis turpis netus Lorem malesuada Ut sollicitudin et interdum. Suspendisse orci at adipiscing ac nibh sed dolor Quisque purus lectus suscipit non pellentesque eu Mauris volutpat in, morbi mauris massa eu vel libero. consectetur ipsum scelerisque. sit aliquet. risus et tempor eros. ultricies nisl Ut Pellentesque hendrerit, risus lorem Aenean ac ac est. elit. vestibulum. Nam egestas. interdum. molestie bibendum. tristique non",
  "public_updated_at": "2017-12-27T00:47:40+00:00",
  "publishing_app": "feedback",
  "redirects": [
    "sed at leo interdum. nibh dolor aliquet. eu Ut non egestas. imperdiet consectetur risus turpis Duis lorem bibendum. Nam hendrerit, non tempor volutpat molestie scelerisque. Aenean sollicitudin Pellentesque habitant purus molestie risus tristique et eu netus Sed suscipit pellentesque tempor mauris adipiscing sem Nam Ut sagittis in, senectus porttitor vel eros. ac malesuada ipsum ultricies Quisque dolor sit Lorem lectus vestibulum. ac morbi amet, massa interdum. nisl tristique elit. ac a est. cursus vel",
    ""
  ],
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "tempor Quisque mauris et ultricies eu Sed Nam nibh libero. nibh. malesuada in, eu risus tristique interdum. netus sed vestibulum. dolor purus hendrerit, adipiscing pellentesque molestie vel sagittis non Mauris egestas. eros. aliquet. morbi molestie ac massa Lorem Suspendisse tempor consectetur senectus suscipit turpis finibus, imperdiet Aenean cursus ac interdum. sem Pellentesque a ac porttitor bibendum. et elit. non scelerisque. leo orci tristique Ut lectus ipsum vel fames risus Ut sollicitudin habitant est. Nam volutpat nisl dolor amet, at",
  "update_type": "republish"
}

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

{
  "previous_version": "scelerisque. malesuada lectus risus habitant netus eu tristique suscipit Quisque molestie senectus interdum. cursus ipsum orci nisl elit. risus dolor nibh morbi sit ultricies ac consectetur Nam hendrerit, est. Pellentesque vel imperdiet et vestibulum. interdum. in, tristique tempor at amet, turpis porttitor volutpat leo Sed Duis Nam finibus, sem pellentesque lorem ac"
}