Skip to main content
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
Deprecated: auth_bypass_ids should be sent as a separate field
organisations
A list of organisation content ids permitted access to this item
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.
auth_bypass_ids
array

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, kk, 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, government-frontend, hmrc-manuals-api, info-frontend, licencefinder, local-links-manager, 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

{
  "analytics_identifier": null,
  "bulk_publishing": true,
  "change_note": "non vestibulum. Pellentesque habitant orci a sed ipsum vel suscipit Quisque molestie tempor et hendrerit, Mauris eu",
  "description": "nibh. interdum. et elit. eu purus malesuada Duis Ut Lorem consectetur risus molestie sagittis in, Mauris Aenean tristique turpis est. ac sollicitudin volutpat",
  "details": {
    "hidden_search_terms": [
      "sem ac orci Pellentesque ultricies sagittis Mauris risus netus vel in, finibus, interdum. consectetur tristique vel massa Duis non Nam tempor Ut nibh. volutpat Aenean leo Ut interdum. ipsum nisl purus tempor dolor est. imperdiet dolor nibh egestas. elit. habitant lectus suscipit pellentesque Quisque libero. porttitor aliquet. bibendum. tristique turpis at lorem a hendrerit, molestie sit fames et et ac vestibulum. malesuada sollicitudin Nam senectus Sed ac adipiscing amet, molestie Lorem mauris risus sed morbi eu non Suspendisse",
      "lectus tristique elit. et eros. porttitor interdum. Duis lorem scelerisque. ultricies Ut at aliquet. volutpat nibh. sem malesuada ac dolor senectus a sollicitudin ac sagittis risus turpis ac Nam ac Lorem imperdiet vestibulum. bibendum.",
      "vel molestie molestie purus non",
      "Sed dolor turpis scelerisque. Mauris morbi sit elit. interdum. ac risus molestie Nam aliquet. sem ac at non cursus lorem eu a dolor lectus eros. et ultricies risus Quisque Aenean vel Lorem ipsum egestas. sagittis non habitant netus pellentesque bibendum. sollicitudin",
      "consectetur eros. amet, risus at senectus Lorem massa Suspendisse lorem molestie aliquet. Duis scelerisque. Aenean sed dolor eu suscipit interdum. cursus a tristique orci libero. purus sem nisl non ac bibendum. mauris",
      "hendrerit, ipsum leo senectus interdum. Pellentesque netus Suspendisse vel habitant in, Quisque lectus malesuada interdum. finibus, tristique tristique Ut sagittis molestie lorem vel mauris non consectetur dolor sit suscipit pellentesque libero. sed purus nibh tempor aliquet. molestie eu eu volutpat Aenean egestas. eros. tempor turpis a Lorem ac orci ac Ut fames adipiscing dolor ultricies nisl et risus porttitor scelerisque. non massa Nam et at nibh. risus est. ac ac morbi vestibulum. Sed sem imperdiet sollicitudin Duis bibendum. cursus Mauris amet, Nam elit."
    ],
    "url": "http://example.com/e1ef083f-ba4c-46fb-b9c8-c79700a8f9ca/b1f33c52-a19c-41e7-8a86-65c4dfe1878c/5b1ffaac-86be-4cf2-aad2-11a360f9be89/c0acfafa-261e-4257-9323-32435f1c0d93#295a1d268df91ebc32ff4e2c46c2a1f6"
  },
  "document_type": "external_content",
  "first_published_at": "2020-08-05T01:32:49+00:00",
  "locale": "ur",
  "publishing_app": "publisher",
  "redirects": [
    "consectetur tempor adipiscing a nibh. tristique non dolor porttitor netus dolor libero. malesuada interdum. Aenean eu vestibulum. Nam aliquet. risus et molestie pellentesque in, est.",
    "risus non orci in, interdum. sollicitudin aliquet. malesuada imperdiet ac Sed interdum. elit. nisl dolor massa tristique dolor senectus finibus, risus Pellentesque volutpat netus vel mauris non sagittis ipsum Ut Quisque Suspendisse hendrerit, vestibulum. suscipit Lorem est. libero. ac ac lectus sem adipiscing cursus a turpis egestas. Aenean",
    "eros. ac sagittis Mauris molestie ipsum Ut tempor vestibulum. morbi dolor risus suscipit ac tristique non sit Pellentesque Lorem Suspendisse Nam sed cursus vel ac malesuada Aenean tempor Sed orci imperdiet eu lorem Duis at ultricies purus finibus, Ut Quisque lectus risus nibh et sollicitudin vel massa et senectus ac consectetur amet, fames turpis habitant interdum. sem elit. pellentesque in, libero. volutpat aliquet. hendrerit, porttitor mauris interdum. Nam molestie scelerisque. tristique bibendum. a non netus egestas. eu adipiscing nisl est. leo nibh. dolor"
  ],
  "rendering_app": null,
  "schema_name": "external_content",
  "title": "elit. tristique ac turpis ipsum Nam lectus bibendum. a Ut nibh. molestie orci leo dolor morbi volutpat libero. in, porttitor sollicitudin suscipit nibh ac tempor at purus malesuada Aenean sem amet, eu Sed Pellentesque eros. sagittis est. imperdiet risus tristique netus sed Suspendisse aliquet. dolor Ut senectus habitant"
}

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": "scelerisque. dolor sem orci interdum. ac consectetur hendrerit,"
}