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, 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": {
  },
  "analytics_identifier": null,
  "base_path": null,
  "bulk_publishing": true,
  "description": "lectus ac Quisque senectus nisl non netus sed sollicitudin ac molestie mauris habitant tempor et eu et consectetur fames Nam nibh. in, pellentesque ac sit at ac Mauris Ut adipiscing imperdiet morbi interdum. eu molestie volutpat nibh est. sagittis Pellentesque vel risus elit. a non Nam eros. suscipit vel massa aliquet. bibendum. turpis Suspendisse cursus purus porttitor lorem orci finibus, libero. dolor Duis malesuada tristique hendrerit, sem ultricies ipsum interdum. amet, egestas. Sed tempor dolor scelerisque. leo Lorem tristique risus Ut Aenean vestibulum.",
  "details": {
    "hidden_search_terms": [
      "habitant bibendum. et ac massa eu sem Mauris morbi molestie hendrerit, Lorem libero. imperdiet"
    ],
    "url": "http://example.com/646045d9-55f9-43ce-bf7d-b05f649e7b45/81fc8e17-c16e-4fdc-9c2b-7a0bc34d2531#6ff9284887fa209f76d454f64a0a5fb1"
  },
  "document_type": "external_content",
  "links": {
  },
  "need_ids": [
    "senectus orci Nam vestibulum. ultricies a tristique molestie Suspendisse fames molestie egestas. habitant turpis vel sollicitudin est. volutpat interdum."
  ],
  "public_updated_at": "2019-02-25T08:08:24+00:00",
  "publishing_app": "frontend",
  "rendering_app": null,
  "routes": [
    "libero. tristique Aenean ultricies et eros. tristique vel Duis malesuada molestie bibendum. ac orci Mauris ac leo lorem mauris consectetur aliquet. in, a interdum. non purus Ut dolor morbi tempor Quisque vestibulum. est. senectus ac Suspendisse Lorem sed interdum. nisl finibus, sem molestie risus Ut eu nibh turpis netus ac hendrerit, dolor Sed porttitor suscipit volutpat vel elit. adipiscing cursus fames sagittis massa amet, at Nam risus non sollicitudin egestas. eu sit tempor lectus",
    "cursus ultricies nibh sed Ut fames Aenean ac finibus, sem mauris purus elit. adipiscing Nam eros. sit in, hendrerit, et Pellentesque Nam bibendum. ac turpis tempor dolor suscipit Sed molestie habitant et orci tristique Suspendisse dolor scelerisque. pellentesque nibh. Quisque tempor vestibulum. molestie ipsum ac senectus nisl eu morbi aliquet. tristique consectetur Mauris lectus libero. risus non netus Lorem sollicitudin non ac vel Ut imperdiet amet, risus malesuada sagittis interdum. leo volutpat at lorem massa est. vel eu porttitor interdum. Duis egestas. a",
    "interdum. hendrerit, lectus purus netus eu et vestibulum. Suspendisse sagittis in, est. amet, a non vel tristique dolor bibendum. et tempor sit vel egestas. at ac eu Sed Lorem Nam aliquet. mauris dolor nibh orci Duis tempor ac interdum. ipsum elit. sollicitudin massa fames molestie ultricies eros. Pellentesque sed Mauris finibus, senectus ac habitant porttitor volutpat nisl suscipit cursus ac turpis Quisque pellentesque risus morbi sem non Ut Nam tristique nibh. imperdiet risus libero. Aenean malesuada lorem scelerisque. molestie consectetur adipiscing Ut leo",
    "ac sagittis interdum. amet, porttitor Aenean bibendum. lectus eu malesuada senectus Quisque nibh. risus interdum. suscipit et purus netus Nam Lorem vel elit. non morbi ultricies orci sem lorem tristique non Pellentesque dolor tempor sollicitudin vel Mauris habitant mauris et ac nisl Ut Suspendisse sit ac tempor finibus, tristique eu molestie aliquet. Sed cursus nibh scelerisque. dolor consectetur volutpat molestie Duis egestas. sed fames risus hendrerit, Ut libero. eros. pellentesque ipsum massa a Nam in, imperdiet turpis leo est. adipiscing vestibulum. at ac",
    "at sollicitudin ac a massa molestie ac malesuada egestas. tristique interdum. vestibulum. lectus finibus, vel risus suscipit fames consectetur volutpat vel",
    "nibh sem risus sagittis Pellentesque lectus Lorem tempor purus leo Quisque tristique non adipiscing nisl hendrerit, in, a at amet, dolor Sed bibendum. ac scelerisque. senectus Nam non malesuada Nam tempor risus lorem vel netus sed eros. ac ipsum tristique porttitor Ut et ac molestie finibus, elit. habitant imperdiet interdum. fames vestibulum. Duis Aenean volutpat massa molestie suscipit Ut egestas. eu Mauris consectetur",
    "finibus, vestibulum. consectetur lectus tristique malesuada molestie adipiscing fames est. Nam sem sit volutpat et interdum. Pellentesque dolor hendrerit, bibendum. ac"
  ],
  "schema_name": "external_content",
  "title": "libero. netus orci turpis Duis risus egestas. Ut interdum. Lorem nibh adipiscing non sed massa hendrerit, elit. nisl dolor imperdiet amet, volutpat Nam a Quisque eu molestie sagittis tempor Ut eros. interdum. ac bibendum. ultricies mauris consectetur risus sem habitant suscipit et tempor aliquet. ac leo sit dolor fames morbi non at malesuada senectus ac ipsum Nam scelerisque. vestibulum. vel nibh. in, et est. Suspendisse finibus, Sed ac molestie Pellentesque pellentesque tristique tristique lorem porttitor lectus purus eu cursus vel sollicitudin Aenean Mauris",
  "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

{
  "bulk_publishing": false
}