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, 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

{
  "access_limited": {
    "auth_bypass_ids": [
      "8718b8a4-0f01-47b1-a701-5a9c1a0c6e66",
      "535f77d3-0f86-4f23-a902-cb3eea817be7",
      "ee9f6a9a-12b7-4d83-b946-0a178e27a8f7",
      "723dfdfa-5e6a-427a-b365-aee21c8d214e",
      "4c99cf0f-751a-457c-bdb9-6c892a4e0e75",
      "f1a81452-bcf5-4dce-a14e-da1cc8fa03f2",
      "f0b0760d-e4a0-4e2c-ad59-a8a47a99a71f",
      "ed5417e4-ba32-466c-bec1-f412d722046f",
      "9cba3588-dee4-4b98-badd-b4628b53a7d7",
      "50b14e0f-f133-40af-bae3-641f9339bc4d"
    ]
  },
  "bulk_publishing": true,
  "change_note": null,
  "description": "nibh interdum. Quisque egestas. bibendum. non Nam tristique sollicitudin vel Pellentesque tempor vestibulum. volutpat finibus, massa Suspendisse porttitor imperdiet risus netus tristique et non dolor morbi malesuada nisl habitant purus sit fames elit. sagittis at tempor eros. adipiscing",
  "details": {
    "hidden_search_terms": [
      "egestas. pellentesque sed ac senectus Sed suscipit ac ac tempor sit malesuada Mauris cursus dolor elit. scelerisque. adipiscing vel molestie habitant netus in, eu sagittis nibh. non volutpat ac eu sollicitudin Duis risus lorem Pellentesque dolor bibendum. mauris Suspendisse tempor Lorem imperdiet finibus, amet, a risus lectus leo consectetur Nam sem at fames Aenean interdum. nisl interdum. molestie turpis vestibulum. eros. Quisque nibh non Ut massa Ut tristique et morbi",
      "eros. molestie lectus vel pellentesque Sed adipiscing in, a et orci non purus volutpat at et turpis scelerisque. ac Duis ultricies vestibulum. sem Nam ac massa molestie Quisque Ut bibendum. nisl Ut Aenean interdum. risus tempor finibus, tristique consectetur imperdiet non Nam netus eu",
      "malesuada Pellentesque massa sem tristique Sed ipsum finibus, sed habitant lorem bibendum. adipiscing Aenean porttitor nisl mauris dolor nibh. et nibh non tristique libero. ultricies Mauris in, ac imperdiet ac egestas. sagittis elit. aliquet. scelerisque. morbi risus molestie vel Quisque Ut ac tempor",
      "mauris ipsum vel aliquet. suscipit fames eros. nibh sagittis pellentesque ac et cursus sem netus tristique amet, morbi risus malesuada sit Quisque molestie turpis Mauris leo libero. hendrerit, et nibh. Ut Pellentesque bibendum. volutpat tristique lorem dolor non tempor ultricies orci scelerisque. vel purus non lectus Duis consectetur eu nisl eu Nam at porttitor Sed a sollicitudin tempor ac massa Lorem elit. risus adipiscing Suspendisse sed vestibulum.",
      "morbi Nam ipsum orci Lorem vestibulum. lectus vel Aenean egestas. Nam risus molestie consectetur a est. eros. suscipit imperdiet Suspendisse risus porttitor bibendum. netus massa",
      "Mauris vel habitant porttitor molestie dolor suscipit ac senectus risus lorem Lorem mauris pellentesque amet, ac in, purus dolor malesuada sit consectetur ac tempor risus egestas. et Duis fames non Aenean netus hendrerit, orci Suspendisse tristique cursus ipsum sollicitudin interdum. ac finibus, Nam Ut interdum. imperdiet scelerisque. non massa et Sed adipiscing eu sagittis leo Ut tristique nibh. nisl ultricies lectus Quisque turpis vel",
      "lorem et elit. eu est. Aenean vestibulum. Pellentesque vel vel consectetur morbi ultricies molestie ipsum Mauris risus purus tristique scelerisque. amet, massa habitant Sed senectus ac fames eu adipiscing porttitor sollicitudin sagittis eros. malesuada leo Ut Nam suscipit egestas. Ut nisl hendrerit, netus pellentesque at cursus et interdum. finibus, Nam in, nibh. turpis libero. non ac Suspendisse bibendum. imperdiet Duis non risus interdum. Lorem nibh molestie ac Quisque tempor volutpat mauris sem aliquet. ac dolor tempor sed orci a tristique sit lectus dolor",
      "Nam nibh. ac molestie libero. consectetur habitant sem Mauris vestibulum. bibendum. tempor imperdiet aliquet. ac fames interdum. amet, cursus tristique scelerisque. senectus eu Ut orci et malesuada Pellentesque egestas. Quisque molestie Duis lectus pellentesque morbi at risus Sed sollicitudin leo lorem non massa porttitor mauris tristique ipsum ultricies est. dolor dolor netus suscipit eu sed",
      "elit. ac sit ac suscipit purus tristique sagittis lectus eu Ut lorem amet, hendrerit, pellentesque ac interdum. Duis ac risus malesuada tempor ipsum bibendum. egestas. nibh. et non nisl tempor sollicitudin imperdiet turpis finibus, sed non porttitor morbi risus leo Suspendisse adipiscing Nam Quisque a vel Sed libero. cursus molestie dolor est. senectus nibh molestie scelerisque. volutpat aliquet. Mauris consectetur in, vel ultricies Ut tristique sem Pellentesque at netus habitant Lorem Nam orci Aenean eros. interdum. eu vestibulum. et mauris massa dolor fames"
    ],
    "url": "http://example.com/c40500e1-f966-46bf-a107-36052693201d/608c55f8-8892-47bd-ae89-f062357525bb#27ce8198e5acad16c52490da9d16885d"
  },
  "document_type": "external_content",
  "last_edited_at": "2019-02-05T05:39:37+00:00",
  "links": {
  },
  "locale": "ja",
  "public_updated_at": "2018-12-05T08:36:16+00:00",
  "publishing_app": "info-frontend",
  "redirects": [
    "orci lectus tristique eros. sit Ut Nam adipiscing leo vel sem purus at et dolor Ut Duis tempor ac Aenean eu Mauris bibendum. dolor malesuada lorem risus massa tristique sagittis consectetur vestibulum. vel risus et imperdiet molestie non Sed ac scelerisque. hendrerit,",
    "in, lectus Lorem malesuada orci volutpat at consectetur massa amet, ac Suspendisse Ut sagittis et sed adipiscing elit. turpis Duis sit Ut sem Nam ultricies tempor tristique vel risus Pellentesque mauris finibus, morbi tempor dolor Quisque dolor bibendum. senectus scelerisque. Aenean molestie est.",
    "scelerisque. porttitor sit suscipit tristique aliquet. egestas. Nam ac hendrerit, vel elit. netus ultricies bibendum. consectetur malesuada turpis interdum. imperdiet non ac est. Quisque habitant eros. sem ac orci Aenean Mauris Ut non mauris et at molestie molestie amet, pellentesque Nam et Duis in, eu sagittis risus nibh. volutpat ac ipsum leo nisl senectus finibus, adipiscing tempor massa lorem interdum. morbi dolor Sed a Ut Pellentesque vestibulum. sed lectus cursus eu purus tempor risus Lorem Suspendisse tristique fames nibh libero. vel sollicitudin dolor"
  ],
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "netus pellentesque Pellentesque Sed amet, fames interdum. ac dolor nibh. risus ipsum sit finibus, cursus turpis eu Aenean Mauris ultricies elit. ac adipiscing senectus volutpat dolor leo hendrerit, Ut ac sollicitudin morbi Nam tempor non mauris vel tristique lorem sem consectetur sed porttitor egestas. malesuada non vestibulum. suscipit lectus libero. 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

{
}