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

{
  "access_limited": {
  },
  "base_path": null,
  "change_note": null,
  "description": "molestie ac et netus Aenean Ut hendrerit, est. non tristique sem dolor Nam massa leo imperdiet at ultricies in, vestibulum. vel purus interdum. ac cursus molestie sed ac et fames eu orci lorem sagittis amet, aliquet. adipiscing elit. risus a volutpat turpis tempor consectetur nibh. malesuada Pellentesque tristique mauris scelerisque. habitant Nam bibendum. eu porttitor Sed tempor finibus, senectus dolor eros. risus Ut nibh non sollicitudin Quisque ac morbi ipsum lectus egestas. Lorem Duis Mauris nisl vel libero. sit Suspendisse pellentesque interdum. suscipit",
  "details": {
    "url": "http://example.com/ff4bb55a-b3c3-4c3a-b1a2-e56969555704/08989213-6de6-4078-8187-f98dd6c8eebf/b2fd5532-3bff-46fc-be6c-620e87d230dc#c491f3035d5715228551a1ac5caa4b02"
  },
  "document_type": "external_content",
  "first_published_at": "2019-06-12T06:47:42+00:00",
  "locale": "en",
  "phase": "beta",
  "previous_version": "dolor at sollicitudin turpis est. vel scelerisque. orci Aenean amet, adipiscing Ut ipsum purus consectetur et sed imperdiet Sed malesuada vestibulum. et cursus ac lorem eros. ac dolor libero. interdum. tristique porttitor tempor Mauris elit. Duis hendrerit, risus sem volutpat nibh. non pellentesque tristique habitant nibh interdum. vel finibus, Suspendisse Nam Quisque lectus egestas. non sagittis nisl massa sit tempor senectus ac in, Lorem bibendum. morbi netus eu Ut eu aliquet. ac fames suscipit Nam mauris molestie Pellentesque risus ultricies a molestie leo",
  "publishing_app": "search-admin",
  "rendering_app": null,
  "routes": [
    "molestie Pellentesque leo adipiscing et Ut ac netus risus ac lorem bibendum. finibus, ac sollicitudin interdum. morbi nisl vel suscipit Suspendisse Lorem in, sagittis molestie risus ac libero. pellentesque nibh sem senectus vestibulum. a non Nam dolor tempor ultricies consectetur et Ut nibh. eu interdum. ipsum eros. porttitor purus massa at sed amet, Aenean sit fames Nam Sed vel tristique imperdiet mauris elit. turpis hendrerit, volutpat orci habitant tempor lectus eu Duis Mauris non est. malesuada dolor tristique",
    "a fames senectus non est. sit molestie ac ipsum eu sagittis vel bibendum. turpis at lorem Ut nisl mauris Suspendisse purus non ac eu suscipit cursus morbi Sed sollicitudin malesuada amet, dolor pellentesque orci in, interdum. finibus, Aenean Pellentesque Nam et ac Duis sed egestas. nibh vel libero. ultricies consectetur elit. nibh. tristique hendrerit, netus porttitor imperdiet et tempor habitant lectus massa risus ac eros. molestie dolor Nam sem Ut volutpat leo vestibulum. Quisque scelerisque. aliquet. tempor Mauris adipiscing Lorem risus tristique interdum.",
    "Aenean ultricies mauris netus vel massa lorem nibh morbi a amet, libero. sed Sed finibus, sollicitudin elit. eros. interdum. sagittis nisl ac Ut imperdiet Nam Nam eu non ac Ut senectus tempor ipsum leo suscipit pellentesque Lorem risus risus malesuada tristique",
    "habitant Ut ac scelerisque. molestie molestie ultricies egestas. tristique et porttitor turpis elit. Lorem lectus Mauris tristique interdum. dolor suscipit bibendum. adipiscing nibh non Nam netus non Aenean a Suspendisse nibh. et est. massa eu risus imperdiet",
    "turpis molestie leo dolor bibendum. molestie eros. Mauris Sed tristique interdum. tempor nibh senectus non fames ultricies malesuada porttitor nibh. aliquet. Pellentesque purus orci lectus vel et dolor Ut hendrerit, ac ipsum sagittis Quisque Duis morbi netus sem elit. ac mauris risus adipiscing tristique imperdiet Nam massa pellentesque vel est. lorem Nam finibus, habitant volutpat nisl interdum. consectetur a at Lorem cursus sit ac et amet, sed sollicitudin eu suscipit risus in, eu tempor libero."
  ],
  "schema_name": "external_content",
  "title": "vestibulum. leo at ipsum volutpat ac sagittis Mauris tristique est. mauris Pellentesque vel in, tempor"
}

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,
  "links": {
  },
  "previous_version": "interdum. nibh risus aliquet. imperdiet Duis et ac vestibulum."
}