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

{
  "base_path": null,
  "bulk_publishing": false,
  "description": "purus finibus, eros. massa Suspendisse dolor libero. suscipit fames Ut leo et scelerisque. morbi malesuada egestas. bibendum. interdum. non risus aliquet. vel tempor orci senectus Duis ipsum risus Pellentesque Nam volutpat consectetur sed sit imperdiet nisl amet, tristique lectus Lorem tristique Quisque ac dolor a vestibulum. interdum. vel non Ut sollicitudin eu sagittis at adipiscing lorem tempor est. elit. molestie netus Aenean Nam habitant nibh. molestie ac ac mauris ultricies in, nibh eu sem turpis ac",
  "details": {
    "hidden_search_terms": [

    ],
    "url": "http://example.com/e9cb41ad-d96f-4cc2-a435-16d418d70233/43ae204d-e8b5-4749-baa9-f97190b16133/7e7829cf-6786-4619-bd77-d96f303e7bf7#7e1ae00dbe4f9d0002407e020fdc6151"
  },
  "document_type": "external_content",
  "first_published_at": "2019-03-04T06:21:30+00:00",
  "locale": "et",
  "need_ids": [
    "ipsum ac nibh. ac suscipit sollicitudin finibus, molestie Quisque et tristique vestibulum. morbi Lorem at ac porttitor in, non elit. vel tempor lorem risus eu tristique eu purus sit imperdiet Sed fames mauris Nam est. nisl massa sed sagittis hendrerit, ultricies interdum. habitant Nam interdum. dolor netus pellentesque risus lectus leo nibh aliquet. amet, consectetur Aenean molestie non Ut cursus egestas. vel Pellentesque Suspendisse volutpat scelerisque. adipiscing et dolor senectus turpis sem bibendum.",
    "risus dolor Ut nibh sit fames adipiscing egestas. molestie sem Suspendisse porttitor Mauris consectetur Ut lectus et finibus, amet, tristique eu sagittis tempor risus Sed molestie ac aliquet. vel imperdiet nibh. eros. bibendum. vel netus Nam Nam Lorem habitant",
    "libero. dolor leo sagittis volutpat vestibulum. dolor fames nibh non interdum. et suscipit morbi lorem vel Nam Ut eu senectus ac molestie ultricies tristique Quisque Nam ipsum egestas.",
    "Sed dolor risus habitant leo Ut sit in, aliquet. porttitor Pellentesque interdum. malesuada scelerisque. sem ultricies molestie non Mauris Nam est. amet, a ac nibh. bibendum. Lorem tristique et consectetur finibus,",
    "Duis imperdiet Nam scelerisque. Sed ac consectetur sollicitudin in, Suspendisse est.",
    "Nam at consectetur lectus libero. turpis leo non ac a aliquet. eu cursus risus nisl risus lorem Suspendisse porttitor vestibulum. molestie adipiscing Pellentesque scelerisque. massa imperdiet Ut hendrerit, in, egestas. vel ac Aenean morbi"
  ],
  "previous_version": "Sed lorem orci Ut ac vestibulum. leo molestie lectus eu at risus Nam Mauris scelerisque. risus ac egestas. tempor Ut interdum. hendrerit, sem aliquet. tristique netus nisl nibh porttitor senectus pellentesque a nibh. mauris elit. dolor sit ac interdum. purus eros. sed tristique ac Duis dolor malesuada imperdiet Pellentesque consectetur vel tempor finibus, suscipit habitant turpis et ipsum",
  "publishing_app": "specialist-publisher",
  "schema_name": "external_content",
  "title": "egestas. purus morbi volutpat sit sem non risus ipsum Ut Duis eu sed tristique dolor a Lorem Pellentesque Nam molestie eros. ac consectetur ac hendrerit, lorem massa netus ac cursus tempor risus Sed imperdiet scelerisque. eu libero. adipiscing amet, sagittis vel sollicitudin lectus Aenean Suspendisse elit. habitant nibh non fames Mauris orci et porttitor malesuada finibus, est. at Ut et mauris interdum. nibh. pellentesque tristique ac tempor bibendum. turpis ultricies Quisque suscipit leo interdum. Nam dolor senectus in, nisl aliquet. vestibulum. molestie vel",
  "update_type": "minor"
}

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

{
  "previous_version": "mauris lectus at malesuada adipiscing bibendum. est. ultricies ac cursus risus nibh. Pellentesque non nibh amet, hendrerit, Nam tempor vestibulum. aliquet. nisl Nam in, Aenean vel ac eu ac massa Lorem Ut libero. habitant eros. scelerisque."
}