Skip to main content
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
Deprecated: auth_bypass_ids should be sent as a separate field
organisations
A list of organisation content ids permitted access to this item
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.
auth_bypass_ids
array

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": "sollicitudin scelerisque. risus purus",
  "base_path": null,
  "bulk_publishing": false,
  "description": "Lorem nibh. molestie a",
  "details": {
    "hidden_search_terms": [
      "vel interdum. eu scelerisque. volutpat Duis consectetur Nam ac Sed bibendum. mauris tristique sit malesuada nisl sem sagittis dolor egestas. Mauris risus cursus eros. ipsum sollicitudin vel massa hendrerit, molestie orci leo tempor imperdiet non Ut turpis lectus netus Ut ac sed et pellentesque risus tempor Nam suscipit finibus, Lorem elit. libero.",
      "libero. eu Nam nisl tristique ac et leo Pellentesque purus amet, ipsum tempor interdum. eu mauris a ac vestibulum. sollicitudin Lorem cursus ultricies volutpat ac eros. in, lectus tristique vel massa Ut turpis molestie Suspendisse senectus nibh. morbi Mauris orci interdum. risus bibendum. est. sit fames dolor risus ac consectetur sem at malesuada",
      ""
    ],
    "url": "http://example.com/cb68d209-d14d-458c-b435-24d464d90c3f/4c675baf-c726-4572-97e3-99f4735a0794#ef48075491006e5eea703f43b7ad487c"
  },
  "document_type": "external_content",
  "last_edited_at": "2019-11-25T05:13:40+00:00",
  "previous_version": "dolor Lorem sagittis elit. libero. egestas. Nam morbi suscipit tristique lorem vestibulum. Nam vel Mauris dolor malesuada eu massa bibendum. Aenean eros. volutpat lectus sit adipiscing hendrerit, orci purus non ac Quisque pellentesque tempor nisl non cursus mauris habitant Sed fames interdum. ac ipsum sem nibh sollicitudin scelerisque. molestie Pellentesque eu ac vel Ut molestie porttitor ultricies in, interdum. consectetur est. nibh. finibus, turpis risus netus et Ut tempor leo",
  "publishing_app": "contacts",
  "redirects": [
    "sem in, lorem hendrerit, Suspendisse morbi elit. sollicitudin Lorem dolor habitant non scelerisque. sit dolor tristique Nam cursus pellentesque non tempor eros. vel senectus Pellentesque turpis molestie adipiscing risus libero. Ut Nam ac et amet, leo eu fames ac massa Duis vel consectetur ultricies nibh orci egestas. eu mauris aliquet. Mauris vestibulum. nibh. lectus sagittis Sed suscipit volutpat ac finibus, Quisque Ut tristique et purus sed interdum. bibendum. risus molestie netus ac a porttitor est. at ipsum"
  ],
  "rendering_app": null,
  "routes": [

  ],
  "schema_name": "external_content",
  "title": "porttitor scelerisque. morbi tristique at libero. in, sollicitudin leo dolor nisl eu tristique hendrerit, tempor est. eros. senectus risus sed imperdiet Ut non molestie adipiscing dolor malesuada Pellentesque Aenean ac Nam tempor Sed Quisque sem bibendum. lectus suscipit aliquet. nibh. lorem consectetur interdum. habitant sagittis mauris fames nibh Suspendisse Mauris et Duis a pellentesque elit. Lorem vel et volutpat vel ac ultricies",
  "update_type": "major"
}

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": true,
  "links": {
  },
  "previous_version": "imperdiet Duis Aenean lorem ac eu eu habitant amet, morbi tristique molestie ipsum interdum. non Quisque sed non netus tempor mauris suscipit risus interdum. dolor pellentesque tristique volutpat sit elit. bibendum. vel Pellentesque sagittis nibh. vel adipiscing cursus senectus Nam aliquet. nibh lectus massa nisl"
}