Table of contents

Schema: knowledge_alpha

Frontend schema

This schema describes the content item that is returned from the content store.

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
string
A path only. Query string and/or fragment are not allowed.
content_id
string

content_purpose_document_supertype
string
DEPRECATED. Use `content_purpose_subgroup`.
content_purpose_subgroup
string
Document subgroup grouping documents by purpose. Narrows down the purpose defined in content_purpose_supergroup.
content_purpose_supergroup
string
Document supergroup grouping documents by a purpose
description
or null

details
object
change_history
array

document_type
string

Allowed values: knowledge_alpha
email_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
first_published_at
or null

government_document_supertype
string
Document supertype grouping intended to power the Whitehall finders and email subscriptions
links
object
available_translations
Link type automatically added by Publishing API
child_taxons
Link type automatically added by Publishing API
children
Link type automatically added by Publishing API
document_collections
Link type automatically added by Publishing API
level_one_taxons
Link type automatically added by Publishing API
part_of_step_navs
Link type automatically added by Publishing API
policies
Link type automatically added by Publishing API
related_to_step_navs
Link type automatically added by Publishing API
topic_taxonomy_taxons
Link type automatically added by Publishing API
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
navigation_document_supertype
string
Document type grouping powering the new taxonomy-based navigation pages
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
public_updated_at
or null

publishing_app
string
The application that published this item.
Allowed values: calculators, calendars, collections-publisher, contacts, 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
publishing_request_id
A unique identifier used to track publishing requests to rendered content
publishing_scheduled_at
or null

rendering_app
string
The application that renders this item.
Allowed values: calculators, calendars, collections, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: knowledge_alpha
search_user_need_document_supertype
string
Document supertype grouping core and government documents
title
string

updated_at
string

user_journey_document_supertype
string
Document type grouping powering analytics of user journeys
user_need_document_supertype
string
DEPRECATED. Use `content_purpose_document_supertype`.
withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "base_path": "/855dc462-accf-41ef-ad09-74847b221885/d5e6cadc-67a6-46a0-ba40-05f6da564592/db00f8fc-7399-4c02-8fc2-f5c6fe2637a9",
  "content_id": "7281bec8-db81-48bf-b48d-4f640c6d0c87",
  "content_purpose_document_supertype": "ipsum scelerisque. in, dolor leo at ac ac Duis nisl fames risus turpis cursus lectus malesuada purus volutpat sed Lorem tempor Nam sagittis senectus eu",
  "content_purpose_subgroup": "turpis orci tempor Quisque vel et pellentesque lorem risus sem scelerisque. risus Aenean Suspendisse purus sed finibus, hendrerit, adipiscing in, ac massa Pellentesque Ut Nam netus vestibulum. porttitor Nam interdum. tristique molestie eu bibendum. et fames non ultricies senectus consectetur lectus libero. amet, leo ac nibh. sit eu nibh dolor sagittis tristique vel at dolor suscipit nisl Mauris morbi ipsum elit. imperdiet non mauris Sed Duis malesuada est. tempor habitant eros. cursus a ac molestie aliquet. Ut Lorem egestas. interdum. sollicitudin volutpat ac",
  "content_purpose_supergroup": "sed ac Sed Ut consectetur orci non Aenean Lorem tristique amet, tempor molestie risus Duis et risus Pellentesque massa eu non volutpat tristique ac ultricies Nam Suspendisse dolor pellentesque fames in, vestibulum. nisl et Ut netus hendrerit, mauris sit malesuada molestie sem Mauris lectus purus at imperdiet vel bibendum. lorem interdum. libero. nibh. leo eu finibus, vel a egestas. scelerisque. interdum. est. porttitor morbi suscipit tempor senectus eros. ipsum cursus sollicitudin nibh Nam sagittis ac habitant dolor aliquet. ac turpis elit. Quisque adipiscing",
  "description": null,
  "details": {
  },
  "document_type": "knowledge_alpha",
  "email_document_supertype": "at tristique fames et vel Aenean nisl Mauris tristique est. interdum. dolor adipiscing Nam vel orci Sed finibus, mauris eros. vestibulum. suscipit elit. sagittis habitant consectetur non morbi in, ac eu lectus imperdiet tempor netus porttitor scelerisque. leo tempor ultricies Duis libero. Lorem non ac volutpat lorem ipsum ac sit purus aliquet. risus massa bibendum. egestas. turpis interdum. nibh hendrerit, Nam et Ut malesuada a Quisque pellentesque molestie Pellentesque cursus Ut eu dolor ac sed senectus risus sollicitudin molestie sem amet, Suspendisse nibh.",
  "links": {
    "related_to_step_navs": [

    ]
  },
  "locale": "en",
  "navigation_document_supertype": "non vel molestie eros. hendrerit, Ut consectetur aliquet. malesuada molestie senectus et orci Suspendisse amet, egestas. Sed lectus ultricies interdum.",
  "phase": "alpha",
  "public_updated_at": null,
  "publishing_request_id": null,
  "rendering_app": "service-manual-frontend",
  "schema_name": "knowledge_alpha",
  "search_user_need_document_supertype": "morbi Lorem Sed vel consectetur ac mauris lectus a ac purus habitant nibh. interdum. at cursus vestibulum. nibh eu lorem massa porttitor risus Nam sollicitudin est. hendrerit, finibus, eros. tempor sagittis imperdiet dolor libero.",
  "title": "risus at tempor Aenean habitant aliquet. Ut sagittis fames bibendum. porttitor risus sit Lorem vestibulum. egestas. ac leo sed netus molestie Ut ultricies malesuada mauris non Nam Nam sem vel sollicitudin et molestie hendrerit, lorem finibus, orci imperdiet interdum. interdum. morbi lectus et eros. ac eu elit. vel a suscipit senectus ac Suspendisse amet, dolor volutpat est. eu adipiscing purus pellentesque Duis nibh. Pellentesque Mauris consectetur nisl tristique cursus ac massa nibh tristique turpis in, scelerisque.",
  "updated_at": "2018-05-10T16:29:00+00:00",
  "user_need_document_supertype": "ultricies fames vel Ut aliquet. eros. sollicitudin lectus pellentesque ac hendrerit, nibh. Nam non mauris Quisque et morbi habitant ac Sed porttitor turpis ac vestibulum. ac eu consectetur molestie dolor massa interdum. sagittis est. sed orci"
}

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
string
A path only. Query string and/or fragment are not allowed.
change_note
["null", "string"]

description
or null

details
object
document_type
string

Allowed values: knowledge_alpha
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-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
string
The application that renders this item.
Allowed values: calculators, calendars, collections, email-alert-frontend, email-campaign-frontend, feedback, finder-frontend, frontend, government-frontend, info-frontend, licencefinder, manuals-frontend, performanceplatform-big-screen-view, publicapi, rummager, service-manual-frontend, smartanswers, spotlight, static, tariff, whitehall-admin, whitehall-frontend
routes
array

schema_name
string

Allowed values: knowledge_alpha
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "access_limited": {
    "auth_bypass_ids": [
      "02f83620-dfd5-46a8-aced-6055d6b9d0db",
      "a9cffb62-92a5-4348-b95f-cec809667c89",
      "3653637b-f4da-4bf4-bac7-b654ad3e95c3",
      "20629bc4-42b4-4719-a24b-c2590adc4a6a",
      "ec8de044-744d-47e5-98c3-9a10b1a82225",
      "ac9c0a75-eb9e-46ca-845f-89f7f522466d",
      "e1fd9bd2-e671-474f-9eea-c9de09b299c8",
      "a9148b66-f49c-4d53-ace1-a22b6446a799",
      "429f8226-85ad-4371-8eb4-aed8e1e562bc"
    ],
    "users": [
      "",
      "Aenean Lorem lectus Pellentesque lorem Ut morbi a elit.",
      "lorem eros. vestibulum. cursus finibus, volutpat sagittis Nam amet, tristique porttitor ac turpis in, molestie habitant non Pellentesque interdum. risus Aenean at nibh senectus elit. fames Ut ipsum vel morbi nibh. ac consectetur tristique sit Mauris est. sem sollicitudin dolor non nisl tempor scelerisque. netus pellentesque eu ultricies ac tempor Lorem orci Quisque Sed dolor mauris adipiscing interdum. imperdiet massa sed purus molestie bibendum. vel leo et a aliquet. eu ac",
      "fames Sed dolor risus in, dolor Lorem Nam egestas. a morbi suscipit non nibh non interdum. ac ipsum mauris nisl sollicitudin molestie ac turpis orci eu habitant Nam leo interdum. tristique nibh. risus ac Pellentesque lectus pellentesque consectetur tristique",
      "purus non molestie at nisl lorem massa et Aenean mauris adipiscing porttitor libero. sagittis tristique bibendum. tristique vel tempor vestibulum. Lorem risus Duis ultricies interdum. consectetur molestie"
    ]
  },
  "base_path": "/f297181a-a5a1-4627-8338-733c4d92528e/e187cb2f-e77b-4d56-b883-fdfeb14a3e25",
  "change_note": "risus Quisque fames non vestibulum. Ut egestas. tempor mauris ac sagittis finibus, cursus libero. habitant Duis et at eu Aenean adipiscing risus tristique dolor lorem ac orci interdum. hendrerit, aliquet. bibendum. et Lorem interdum. vel sit Sed porttitor vel lectus tempor eros. in, pellentesque sem Mauris ac massa malesuada a Nam eu senectus ultricies sollicitudin netus molestie ac amet, purus molestie scelerisque. consectetur Pellentesque turpis suscipit Suspendisse dolor nibh. leo imperdiet",
  "description": "nisl sed consectetur mauris ac dolor eu turpis ultricies Quisque eros. vel tempor interdum. finibus, amet, molestie Aenean leo nibh. et eu adipiscing netus Mauris hendrerit, sit Nam molestie Sed non vestibulum. habitant Ut tristique est. sagittis risus tristique purus volutpat Ut Nam non massa ipsum ac interdum. tempor at elit. senectus Pellentesque a et aliquet. nibh ac in, Duis dolor Suspendisse egestas. orci morbi risus scelerisque. vel imperdiet cursus Lorem sem sollicitudin malesuada bibendum. libero. suscipit lorem pellentesque lectus ac",
  "details": {
  },
  "document_type": "knowledge_alpha",
  "first_published_at": "2018-07-02T22:23:20+00:00",
  "last_edited_at": "2018-06-01T19:57:28+00:00",
  "locale": "tk",
  "phase": "live",
  "previous_version": "sed Duis vestibulum. hendrerit, est. Ut vel tristique pellentesque non Quisque sagittis netus ipsum interdum. Lorem egestas. Sed eu scelerisque. Pellentesque Suspendisse fames dolor in, volutpat ac suscipit lorem eros. imperdiet Nam Nam sit a senectus adipiscing orci turpis molestie interdum. habitant amet, dolor ac tempor eu risus nisl malesuada ac morbi aliquet. bibendum. porttitor et purus elit. finibus, lectus et nibh. massa tempor consectetur cursus nibh sollicitudin molestie Mauris ultricies ac leo at mauris sem non vel Aenean tristique risus libero. Ut",
  "public_updated_at": "2018-06-07T14:44:57+00:00",
  "publishing_app": "static",
  "rendering_app": "feedback",
  "routes": [
    {
      "path": "a Nam lorem morbi bibendum. dolor Pellentesque Lorem Quisque nibh mauris finibus, risus pellentesque Aenean cursus tempor leo purus risus interdum. at sollicitudin vel scelerisque. lectus orci nisl molestie ipsum eu Mauris Duis aliquet. senectus adipiscing suscipit Sed massa in, tempor non non nibh. hendrerit, ultricies Nam consectetur et sit turpis porttitor tristique eros. et molestie amet, sagittis Suspendisse ac dolor vestibulum. imperdiet elit. est. Ut sem volutpat interdum. malesuada fames egestas. libero. eu vel ac tristique habitant Ut ac sed ac netus",
      "type": "prefix"
    },
    {
      "path": "Nam Nam et hendrerit, sagittis scelerisque. at fames vestibulum. molestie morbi a pellentesque interdum. Mauris tristique nibh. senectus malesuada Lorem adipiscing lectus Duis in, massa leo elit. finibus, tempor dolor et vel porttitor tempor imperdiet cursus ac ac Aenean ipsum purus ac Ut risus lorem molestie nisl volutpat Ut amet, eu libero. bibendum. ultricies eu aliquet. ac suscipit",
      "type": "prefix"
    },
    {
      "path": "aliquet. elit. sed eu Mauris vestibulum.",
      "type": "exact"
    },
    {
      "path": "suscipit Ut hendrerit, Pellentesque massa Lorem Sed pellentesque dolor netus finibus, porttitor tristique vel elit. scelerisque. turpis nibh. risus vestibulum. Duis nibh ac senectus ultricies sollicitudin Nam Ut at eu lectus et fames imperdiet in, Quisque mauris aliquet. Aenean a Mauris amet, tempor leo est. consectetur",
      "type": "prefix"
    }
  ],
  "schema_name": "knowledge_alpha",
  "title": "vel finibus, risus interdum. molestie elit. orci fames a ultricies pellentesque ac eros. turpis nisl tempor non Lorem purus lectus est. interdum. nibh. Duis egestas. adipiscing aliquet. at sit ipsum porttitor molestie scelerisque. et Mauris tempor morbi dolor ac non Nam risus ac tristique netus ac habitant amet, tristique dolor cursus massa vestibulum. sem imperdiet Ut volutpat leo sollicitudin Quisque vel libero. nibh Sed sed senectus Ut eu Aenean bibendum. et suscipit hendrerit, Pellentesque in, sagittis malesuada lorem Nam mauris eu consectetur Suspendisse",
  "update_type": "minor"
}

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

{
  "links": {
  },
  "previous_version": "molestie ipsum morbi sagittis non in, est. tristique ac nisl suscipit sed libero. et"
}