Developer docs
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
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": [

    ]
  },
  "description": "molestie Suspendisse tempor porttitor morbi ac eu nisl ultricies tristique nibh adipiscing ipsum Duis scelerisque. sollicitudin bibendum. Mauris",
  "details": {
    "hidden_search_terms": [
      "habitant tristique massa vestibulum. elit. at porttitor netus sagittis malesuada dolor cursus suscipit tristique et mauris sed ac ac Aenean molestie imperdiet vel nisl Lorem",
      "tempor lectus est. interdum. hendrerit, consectetur vestibulum. senectus molestie morbi non mauris a nisl aliquet. sit sem malesuada ac Suspendisse ultricies ac in, Mauris",
      "at nibh sed ipsum sem Ut amet, adipiscing",
      "hendrerit, non orci turpis interdum. lectus elit. at tristique amet, massa ac molestie ultricies mauris Duis risus risus Ut dolor Nam sem a aliquet. imperdiet eros. tempor Pellentesque eu porttitor ipsum suscipit libero. in, finibus, volutpat nisl ac Quisque vel ac nibh purus leo nibh. est. sagittis habitant Ut Mauris interdum. Lorem et Nam dolor cursus molestie ac malesuada eu morbi pellentesque non",
      "consectetur leo Quisque amet, imperdiet vestibulum. suscipit Mauris nibh. est. dolor risus in, bibendum. ac eu turpis sem Nam purus molestie ultricies habitant porttitor lorem libero. Pellentesque hendrerit, interdum. senectus eu Sed ac vel mauris tristique orci sit egestas. nisl ac non at et sagittis Suspendisse sed a morbi",
      "morbi fames tempor a nisl vel et ultricies Mauris Sed lorem non sed eu malesuada turpis porttitor eu Nam sagittis ipsum bibendum. eros. ac leo Quisque est. elit. molestie massa vel cursus tristique sem pellentesque"
    ],
    "url": "http://example.com/55f5667d-3e54-490d-85a2-bcc70e0058ad/665c07ce-f28e-4448-a05c-3d307fe539aa/74e4fde4-78a9-4449-9fe2-4a699e25e59c/fe284328-8d4e-44da-a163-6c01708121f5#e62a72b8d1a37363ee2514b4af01905f"
  },
  "document_type": "external_content",
  "first_published_at": "2018-09-09T21:24:07+00:00",
  "links": {
  },
  "phase": "beta",
  "previous_version": "Mauris at finibus, massa tempor vel malesuada ac amet, elit. eros. senectus tempor interdum. risus nibh habitant scelerisque. vel eu molestie nibh. ac Nam netus",
  "publishing_app": "search-admin",
  "redirects": [

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

The links for this item. This is what a publishing application sends in a patch_links call.

Attributes

links
object
previous_version
string

View this schema on GitHub

Random example

{
  "previous_version": "ipsum"
}
View source Report problem GitHub Repo