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

{
  "auth_bypass_ids": [

  ],
  "bulk_publishing": true,
  "change_note": "nibh. Pellentesque Suspendisse interdum. imperdiet malesuada tempor sem ipsum ac eu porttitor molestie est. amet, senectus eu netus Mauris sit volutpat habitant interdum. Nam in, risus et tempor turpis lectus dolor lorem Sed fames morbi sed non orci Aenean Ut leo tristique massa sagittis consectetur eros. vel",
  "description": "in, finibus, non",
  "details": {
    "url": "http://example.com/8c8e5a5f-7ca7-4357-adee-7aecdf62bdd2/338ed414-43b1-4133-a01c-80234b048089/cf1a0bf8-b2ed-4e89-82d3-e1f8831e332e/74e19d2d-4563-4aa4-a46f-d36f8cbc24b6/2c9ad911-5654-4252-8108-5c9695abf0ef#4c9d9c8818570f26ad7d304938bbdaa4"
  },
  "document_type": "external_content",
  "links": {
  },
  "locale": "ka",
  "need_ids": [
    "vestibulum. dolor ipsum tempor ac interdum. senectus tristique Sed turpis netus tristique Nam in,",
    "volutpat",
    "molestie ac nisl netus in, finibus, cursus Duis Mauris sit vestibulum. interdum. et",
    "purus ultricies vel tempor fames",
    "eu mauris interdum. nibh. sollicitudin vel bibendum. at dolor pellentesque finibus, netus Nam a lorem ac",
    "egestas. porttitor aliquet. tristique turpis Mauris Quisque malesuada elit. est. dolor leo eu dolor orci et Sed scelerisque. interdum. Aenean tempor amet, tempor finibus, sem risus nibh. pellentesque nisl Pellentesque in,",
    "mauris nisl molestie ac elit. eu risus Duis dolor Mauris Sed bibendum. nibh. eu at ipsum leo scelerisque. vestibulum. tristique dolor sollicitudin molestie eros. vel Pellentesque non tristique Nam Nam pellentesque est. ac imperdiet ultricies Ut orci Suspendisse netus egestas. malesuada ac tempor purus adipiscing massa aliquet. non vel in, consectetur et turpis lectus Lorem finibus, sagittis sed lorem Ut libero. risus senectus a volutpat fames Quisque sit morbi cursus habitant sem amet, hendrerit, porttitor Aenean suscipit et interdum. ac tempor interdum. nibh",
    "Suspendisse et elit. vestibulum. ac libero. senectus dolor dolor nibh tempor nisl non eu consectetur tempor tristique eu finibus, ac Ut Ut est. at imperdiet adipiscing Sed",
    "Ut lorem interdum. Suspendisse consectetur bibendum. ac purus molestie Pellentesque nibh. at hendrerit, non risus nisl massa turpis finibus, scelerisque. et Mauris interdum. tristique eros. sagittis egestas. Quisque cursus risus volutpat tempor ipsum mauris ac molestie vestibulum. leo ac a vel sem pellentesque lectus malesuada est. non Nam elit. morbi dolor dolor amet, habitant eu adipiscing suscipit netus sit fames Aenean sollicitudin tristique in, Nam porttitor Ut ultricies Sed sed Lorem orci vel ac et imperdiet eu senectus libero. nibh tempor Duis"
  ],
  "phase": "alpha",
  "previous_version": "morbi lectus habitant malesuada netus scelerisque. at ac nisl sit mauris ac finibus, Suspendisse est. Aenean suscipit Ut Duis imperdiet eros. sagittis dolor ac tristique cursus massa leo tempor ac et turpis Mauris lorem ultricies egestas. bibendum. non sem hendrerit, orci nibh. eu nibh dolor consectetur eu et in, Lorem sollicitudin risus ipsum fames non vel molestie",
  "public_updated_at": "2020-04-03T03:50:20+00:00",
  "publishing_app": "whitehall",
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "massa Pellentesque imperdiet lorem tempor Nam non finibus, purus",
  "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": true,
  "links": {
  }
}