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, da, de, dr, el, en, es, es-419, et, fa, fi, fr, gd, he, hi, hr, hu, hy, id, is, it, ja, ka, 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

{
  "description": "consectetur molestie sollicitudin morbi est. purus leo Lorem tristique molestie non aliquet. elit. interdum. vel ac non massa ac ultricies interdum. senectus volutpat turpis a hendrerit, vestibulum. tempor orci vel amet, risus Duis finibus, Nam adipiscing eu porttitor malesuada in, fames Nam suscipit scelerisque. Sed Quisque sagittis nibh habitant pellentesque Mauris Ut ac Suspendisse dolor eros. ac Ut sem lorem sit et imperdiet risus dolor nisl eu netus bibendum. Pellentesque tristique libero. Aenean egestas. at mauris ipsum",
  "details": {
    "hidden_search_terms": [
      "finibus, leo lorem est. Quisque lectus non hendrerit, tempor elit. ac sagittis in, interdum.",
      "in, non molestie mauris Suspendisse lectus nibh. Quisque orci dolor sit morbi tempor nisl Lorem Mauris at interdum. suscipit Aenean sagittis cursus malesuada a eu consectetur libero. lorem risus et est. Nam aliquet. imperdiet fames eu dolor interdum. Pellentesque habitant hendrerit, tristique risus scelerisque. leo ac Ut massa Duis adipiscing senectus molestie turpis sollicitudin egestas. pellentesque vel et tristique ac Sed Ut ultricies sed ac Nam tempor netus vel nibh eros. bibendum. purus sem porttitor ac volutpat amet, ipsum elit. vestibulum. finibus, non",
      "ac sit molestie lectus imperdiet Nam eu in, finibus, nibh hendrerit, orci est. habitant tempor libero. vestibulum. volutpat scelerisque. ac Lorem turpis mauris Quisque netus egestas. sem consectetur dolor Ut massa sed Duis bibendum. eros. ac risus lorem elit. nibh. molestie leo Suspendisse tristique ultricies suscipit amet, adipiscing non dolor fames Nam non",
      "leo vestibulum. volutpat imperdiet risus adipiscing interdum. Lorem sollicitudin ac purus a ultricies nisl eros. vel et cursus malesuada orci scelerisque. consectetur Pellentesque hendrerit, bibendum. nibh tempor lorem massa tempor dolor Nam Mauris libero. tristique molestie finibus, et risus est. Aenean nibh. ac vel senectus dolor sed eu turpis ipsum mauris Nam egestas. Duis Quisque amet, sagittis Ut tristique morbi interdum. eu elit. aliquet. lectus Sed non at in, Ut non habitant sem Suspendisse porttitor ac molestie pellentesque suscipit sit ac netus fames",
      "Ut lorem aliquet. Sed ac molestie eu Suspendisse malesuada Aenean nibh scelerisque. consectetur habitant sagittis nisl sem bibendum. tempor tristique dolor volutpat mauris interdum. non risus pellentesque massa ac est. Lorem vel sit et risus imperdiet fames eu cursus nibh. finibus, leo amet, sollicitudin sed at Ut ultricies in, Duis tempor ac libero. purus Nam suscipit Nam vestibulum. vel turpis senectus interdum. lectus netus orci a et eros. dolor molestie Mauris Quisque tristique adipiscing non ipsum egestas. ac morbi porttitor Pellentesque elit. hendrerit,",
      "est. ipsum leo netus nibh at eu pellentesque Duis risus fames tristique morbi Quisque tempor Mauris tempor cursus molestie habitant malesuada orci non interdum. elit. hendrerit, interdum. turpis adipiscing Nam dolor sem sed vel porttitor molestie Lorem consectetur volutpat risus nisl senectus lectus ac ac bibendum. dolor tristique scelerisque. suscipit et purus lorem mauris eros. sollicitudin aliquet. ultricies Suspendisse Nam non Sed Ut sagittis imperdiet massa ac Aenean sit in, amet, libero. vel Pellentesque eu Ut ac et",
      "non massa at ac eu lorem molestie risus est. a aliquet. dolor pellentesque non finibus, Lorem orci ultricies ac Suspendisse vel interdum. netus suscipit Mauris Nam Pellentesque malesuada Ut Sed elit. risus adipiscing fames egestas. tristique sem et Duis sagittis nisl in, tempor et libero. ac Aenean nibh. ipsum volutpat scelerisque. consectetur Quisque cursus habitant morbi tristique turpis eu senectus ac imperdiet dolor leo sit amet, interdum. sed lectus",
      "lorem eros. interdum. Duis Suspendisse in, vel et pellentesque Mauris sem purus lectus suscipit hendrerit, imperdiet bibendum. ipsum aliquet. amet, senectus non",
      "Duis imperdiet lectus purus est. ac molestie vel dolor Quisque et hendrerit, fames vel pellentesque massa eu tempor amet, suscipit in, Ut Pellentesque sollicitudin ipsum tristique Lorem malesuada nisl tristique eros. sit risus ultricies porttitor tempor aliquet. non interdum. Nam senectus scelerisque. sem vestibulum. cursus libero. Suspendisse non Nam et netus nibh. lorem ac elit."
    ],
    "url": "http://example.com/745b5cb9-d560-4007-abca-2f2c6dcaedc4/7935e1a8-8bee-428c-8574-1ebf3e8824d3/2e048ab8-bc75-46b5-8001-3c1c87cab5a1/7c714dc4-c022-407b-97e5-9405111bf6f4#dcf1a1bd74da44353545b02cc5c95b5e"
  },
  "document_type": "external_content",
  "first_published_at": "2019-05-12T17:46:12+00:00",
  "links": {
  },
  "locale": "tk",
  "phase": "live",
  "previous_version": "molestie Ut orci sed sagittis adipiscing massa Nam ac molestie cursus nisl tristique non est. scelerisque. purus aliquet. netus nibh Mauris dolor Suspendisse eu interdum. Duis risus et imperdiet nibh. bibendum. sem amet, risus eros. a Aenean pellentesque elit. porttitor suscipit Pellentesque senectus ac sollicitudin vel in, egestas. fames ac leo finibus, Ut non turpis habitant et morbi vel tristique libero. dolor ultricies Sed Nam interdum. tempor eu malesuada volutpat mauris consectetur ac hendrerit, lorem Quisque sit vestibulum. Lorem at tempor lectus ipsum",
  "public_updated_at": "2019-04-29T15:46:04+00:00",
  "publishing_app": "service-manual-publisher",
  "redirects": [
    "et volutpat sollicitudin turpis vel bibendum. tristique risus imperdiet non ac eu Pellentesque",
    "non tempor in, mauris Suspendisse eu non sed Aenean Ut netus nibh. aliquet. Mauris malesuada cursus Quisque ipsum eu tempor senectus sollicitudin nibh fames Nam lorem pellentesque scelerisque. finibus, imperdiet purus morbi vel consectetur et ac Sed est. ultricies habitant et vel vestibulum. tristique Pellentesque egestas. ac lectus tristique Lorem molestie Nam nisl volutpat orci molestie leo hendrerit, at sem libero. adipiscing amet, suscipit eros. Ut sit sagittis turpis bibendum. a ac Duis interdum. massa risus elit. dolor interdum. risus porttitor ac dolor"
  ],
  "routes": [
    "dolor est. ultricies Mauris lorem Ut massa pellentesque malesuada imperdiet purus porttitor elit. vestibulum. tempor aliquet. tempor Pellentesque hendrerit, nibh consectetur ipsum Suspendisse molestie senectus tristique interdum. habitant nibh. sem Duis Lorem fames volutpat scelerisque. interdum. ac dolor non nisl netus Aenean leo",
    "risus consectetur et interdum. eu lorem turpis sed egestas. Sed sagittis vel senectus in, eu tristique bibendum. Nam molestie Aenean et mauris Nam vel morbi non eros. suscipit lectus ac ipsum nisl sem vestibulum. sollicitudin sit ac risus Duis Pellentesque Mauris porttitor tempor purus Ut volutpat habitant fames cursus at Ut molestie hendrerit, adipiscing scelerisque. pellentesque orci massa nibh. imperdiet leo finibus, ultricies ac Suspendisse libero. amet, tempor nibh non dolor tristique elit. netus a aliquet. Quisque ac Lorem est. interdum. dolor malesuada",
    "non egestas. nibh. sit malesuada dolor a Sed turpis"
  ],
  "schema_name": "external_content",
  "title": "porttitor adipiscing nibh turpis elit. purus Ut tempor vel risus pellentesque tristique ac Ut"
}

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": "a leo imperdiet dolor volutpat et Suspendisse habitant ac molestie pellentesque fames sagittis"
}