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

{
  "access_limited": {
    "auth_bypass_ids": [
      "9bb5b14b-d59c-47b9-b606-f9dbf9b8b961",
      "a4f3b765-b5fd-4328-8c5f-1ff6fac7715e",
      "8dbaaa52-7a36-4026-9ff1-38c05e4fa787",
      "6970a1a4-3143-4218-9ca3-c0e00b7fba73",
      "5bd83a56-475d-472a-8fe8-ace1eaea713f",
      "9780fb10-67a1-4bcc-af07-ff544e8b85a8",
      "3e6f2794-2d9a-4ce6-9bf5-821ee24de7cc",
      "469934e3-0f24-4714-bdd1-71bbe042db70"
    ],
    "users": [
      "Quisque suscipit amet, Ut libero. lectus ultricies molestie et nisl ac dolor ipsum ac risus Sed ac leo volutpat tristique sed netus a Nam consectetur mauris sagittis tempor Ut orci molestie sollicitudin eu malesuada in, Mauris interdum. ac tempor porttitor Nam aliquet. risus fames non vel Pellentesque habitant dolor sit senectus vestibulum. et Suspendisse Aenean eu",
      "vel malesuada ac purus ultricies morbi lorem interdum. est. molestie Suspendisse Ut ac pellentesque dolor non amet, eros. risus orci et aliquet. Lorem bibendum. libero. sem senectus ipsum Aenean eu habitant Sed adipiscing vestibulum. hendrerit, Quisque egestas. nibh tempor tempor nibh. tristique fames non mauris volutpat turpis cursus finibus, Pellentesque Nam ac sit interdum. suscipit vel in, sagittis molestie et Mauris Nam sed ac Ut netus elit. risus dolor at nisl lectus eu tristique sollicitudin porttitor",
      "Nam netus massa ipsum tempor lectus molestie vel eu suscipit sem aliquet. tristique tristique eros. amet, interdum. nibh. turpis ac Mauris mauris sollicitudin eu risus interdum. risus et habitant Lorem et Ut Aenean imperdiet sit scelerisque. egestas. sagittis tempor consectetur ac ac vel hendrerit, Pellentesque dolor pellentesque porttitor nibh a ultricies Nam lorem dolor non non nisl Duis vestibulum. volutpat elit. molestie bibendum. Suspendisse est. ac fames senectus malesuada",
      "a Ut risus vestibulum. pellentesque ultricies Suspendisse Duis",
      "molestie risus eros. Ut amet, turpis morbi netus malesuada tempor pellentesque elit. nisl sed orci aliquet. suscipit vel dolor finibus, Mauris mauris bibendum. ipsum in, sit nibh. ac non eu a tristique scelerisque. porttitor risus Nam non libero. et interdum. egestas. ultricies Sed tristique Lorem Nam purus massa",
      "Nam molestie netus vestibulum. aliquet. amet, sem adipiscing risus dolor Lorem orci in, sagittis non sit tempor suscipit Mauris a dolor lorem consectetur porttitor Nam finibus, Sed volutpat habitant cursus fames morbi tristique",
      "Lorem ac pellentesque ac non nibh at ac volutpat Sed bibendum. hendrerit, senectus Ut sagittis libero. vestibulum. aliquet. imperdiet est. nisl sollicitudin molestie tempor risus a habitant massa interdum. orci sed eros. tristique ultricies Suspendisse et mauris lectus tristique Duis risus Pellentesque amet, Nam Ut vel fames dolor scelerisque. vel netus"
    ]
  },
  "description": "volutpat Nam sit Pellentesque risus interdum. eu Quisque purus in, senectus tempor netus sagittis vel massa Lorem Mauris sed vestibulum. mauris nibh. scelerisque. Sed leo amet, turpis lorem et ac lectus molestie libero. morbi Suspendisse elit. consectetur non nisl sollicitudin et malesuada non Duis Nam",
  "details": {
    "hidden_search_terms": [
      "hendrerit, lorem fames eu aliquet. vel vel non tristique nisl Sed amet, lectus ultricies leo at sed libero. molestie dolor ac consectetur tempor senectus cursus risus interdum. Nam sit turpis morbi eros. dolor Quisque ac sem non molestie sollicitudin bibendum. scelerisque. a eu nibh. ipsum Duis Ut suscipit porttitor tempor",
      "bibendum. eros. mauris Mauris tempor Aenean non massa habitant vel Sed consectetur ultricies ipsum lorem aliquet. Lorem Ut dolor lectus dolor finibus, in, vel ac tristique ac eu Nam amet, et nibh",
      "purus interdum. pellentesque eu consectetur cursus Sed Suspendisse aliquet. adipiscing dolor massa suscipit ultricies leo Pellentesque Nam ac vel molestie Duis sit imperdiet malesuada elit. nibh. morbi nisl Ut sed non libero. tristique habitant sem Mauris non sollicitudin tristique risus senectus ac est. Aenean eu tempor vestibulum. et ac bibendum. orci et volutpat in, mauris netus ac sagittis amet, dolor Ut nibh egestas. tempor Lorem ipsum vel interdum. lorem porttitor a turpis hendrerit, Nam at scelerisque. eros. risus fames molestie finibus,"
    ],
    "url": "http://example.com/017ba894-6d1d-4baa-8d5e-4cfd7eab1556/95c21605-ccf6-47e6-b4f1-67eea89a434c#489bc1d09ab00c13edb96ec7741ef005"
  },
  "document_type": "external_content",
  "last_edited_at": "2019-01-01T15:30:40+00:00",
  "locale": "hy",
  "phase": "beta",
  "previous_version": "Duis ac at elit. ac interdum. sollicitudin sem vel orci suscipit habitant Mauris leo Suspendisse tristique fames aliquet. sit vestibulum. ipsum cursus nisl a risus purus turpis ac et molestie Nam Ut porttitor eu est. Aenean dolor pellentesque finibus, Nam senectus adipiscing risus volutpat Pellentesque interdum.",
  "publishing_app": "hmrc-manuals-api",
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "Quisque sit mauris fames Pellentesque cursus ac non tempor tempor vel Lorem netus nibh porttitor sem bibendum. sed malesuada orci a interdum. tristique turpis imperdiet suscipit morbi nisl purus sollicitudin finibus, molestie amet, tristique ipsum vel in, nibh. consectetur lorem eros. vestibulum. elit. senectus Suspendisse libero. risus est. Ut dolor ac eu dolor et sagittis Sed Duis Mauris volutpat molestie ac adipiscing leo massa at ac non lectus Ut egestas. ultricies interdum. aliquet. Nam scelerisque. risus Aenean et eu hendrerit,"
}

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": "bibendum. tempor risus Aenean interdum. netus Lorem nibh. aliquet. libero. porttitor tristique ac nisl eu sem tristique eu vestibulum. Mauris a in, molestie Sed orci pellentesque hendrerit, tempor egestas. consectetur scelerisque. elit. suscipit Pellentesque sollicitudin finibus, imperdiet Nam senectus cursus eros. Ut Nam ac dolor Suspendisse non Duis ac purus lorem et interdum. dolor ultricies amet, volutpat est. ipsum sed habitant massa turpis lectus ac fames malesuada Ut mauris leo sit at Quisque vel"
}