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

{
  "change_note": "Quisque ac eros. morbi non Lorem tristique Sed ultricies tempor pellentesque nibh. aliquet. eu suscipit ipsum molestie vestibulum. Ut lorem Nam et non mauris consectetur porttitor interdum. habitant netus imperdiet sit eu Pellentesque tempor scelerisque. a Duis finibus, dolor nisl Mauris nibh Nam massa risus",
  "description": "libero. sed egestas. massa sagittis turpis scelerisque. et habitant nibh. Duis elit. ultricies Ut finibus, netus hendrerit, molestie leo ac tempor dolor risus bibendum. at volutpat est. sem tristique dolor non eros. lorem ipsum morbi ac nibh lectus in, purus tempor eu Aenean adipiscing Pellentesque Mauris Suspendisse amet, cursus Ut risus eu aliquet. suscipit malesuada Sed ac",
  "details": {
    "url": "http://example.com/799c59da-0ce2-41ad-97a9-277aaec16ec3/453c7719-b54f-46c5-b54b-35e6555b7ee0/d8d694c1-e1db-4620-a88a-e26dd95d3ab4#a2372b4084103f59c49121637cff07b7"
  },
  "document_type": "external_content",
  "first_published_at": "2018-03-03T10:35:56+00:00",
  "need_ids": [
    "turpis interdum. hendrerit, bibendum. Pellentesque sagittis et libero. Nam ac sem Ut suscipit netus eu vel ultricies mauris scelerisque. ac sollicitudin eu consectetur Ut tempor Mauris",
    "morbi dolor bibendum. nibh risus scelerisque. massa Sed dolor libero. Nam et amet, fames mauris risus",
    "fames Lorem Ut molestie Nam interdum. ipsum ac adipiscing vestibulum. aliquet. vel hendrerit, Ut sollicitudin et nisl suscipit est. tempor ac scelerisque. Mauris vel habitant massa dolor netus bibendum. senectus libero. turpis amet, Suspendisse non non sed tempor volutpat Duis nibh dolor Quisque in, et malesuada ac Sed pellentesque finibus, sit egestas. Nam tristique consectetur imperdiet porttitor elit. molestie ac ultricies sem risus purus morbi",
    "eu ac dolor purus est. molestie nibh. sem Suspendisse porttitor leo suscipit volutpat ac vel amet, tristique netus habitant et scelerisque. egestas. sed in, risus a Mauris tempor non at vel et orci Duis consectetur finibus, massa libero. elit.",
    "egestas. interdum. massa nisl consectetur nibh amet, ac risus vel Mauris Quisque ipsum molestie Nam volutpat eros. tristique suscipit hendrerit, non eu a at ac eu non imperdiet Nam molestie lorem Pellentesque ac nibh. netus in, libero. risus sagittis Sed dolor malesuada mauris porttitor Duis finibus, Aenean elit. vel vestibulum. et tempor sit leo dolor ac sed purus bibendum. et Suspendisse",
    "risus fames nibh leo tempor tempor Aenean est. lorem Sed Mauris at elit. sem libero. sed risus eu ipsum tristique molestie Pellentesque nibh. scelerisque. dolor eros. Ut molestie interdum. purus et ac massa vel finibus, vestibulum. ultricies ac sagittis a Ut imperdiet nisl volutpat eu ac dolor hendrerit, et suscipit lectus Lorem pellentesque habitant Suspendisse ac orci bibendum.",
    "Nam turpis egestas. ac non Aenean et sit Suspendisse sem eros. sed tempor interdum. Quisque eu nibh Nam at in, Ut mauris aliquet. orci interdum. imperdiet vel suscipit nisl adipiscing vel a Sed fames finibus, porttitor vestibulum. Ut Lorem ac ac amet, senectus risus lorem pellentesque Pellentesque volutpat elit. ultricies est. tempor libero. molestie cursus tristique Mauris ac eu molestie hendrerit, morbi leo dolor et sagittis dolor habitant sollicitudin purus tristique nibh. ipsum massa consectetur malesuada non Duis scelerisque. netus risus lectus bibendum.",
    "finibus, Suspendisse at suscipit porttitor vel morbi sem Nam ipsum malesuada elit. Ut a dolor ultricies libero. risus tristique mauris molestie vestibulum. molestie Ut eros. leo tempor nisl scelerisque. ac purus egestas. et in, ac fames non imperdiet risus eu turpis Duis Sed massa habitant dolor vel nibh. cursus tristique lectus sagittis interdum. volutpat bibendum. senectus est. orci sollicitudin et Aenean tempor ac eu aliquet. hendrerit, amet,"
  ],
  "phase": "alpha",
  "previous_version": "non eu imperdiet turpis leo mauris habitant Mauris Sed cursus tempor lectus morbi tristique Ut scelerisque. et Duis molestie et ultricies ac egestas. lorem Suspendisse vel in, Pellentesque risus aliquet. nibh. finibus, volutpat Aenean adipiscing Nam nibh Ut suscipit interdum. Nam molestie bibendum. a senectus",
  "public_updated_at": "2018-06-16T09:06:41+00:00",
  "publishing_app": "service-manual-publisher",
  "routes": [
    "malesuada morbi Quisque molestie risus habitant eu eros. ipsum",
    "fames Nam interdum. dolor molestie imperdiet Sed porttitor ac ac turpis vestibulum. a ac est. aliquet. orci lectus sit purus nibh",
    ""
  ],
  "schema_name": "external_content",
  "title": "pellentesque cursus leo vel interdum. Pellentesque Ut massa habitant aliquet. molestie tempor morbi eu amet, eros. Ut sagittis sed tristique a ac consectetur"
}

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

{
}