Skip to main content
Table of contents

Schema: facet

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

description
or null

details
object
change_history
array

closed_value
Value that determines the closed state (the key field is in the past) of a topical facet.
combine_mode
string
Specifies how to combine with other facets
Allowed values: and, or
display_as_result_metadata
boolean
Include this in search result metadata. Can be set for non-filterable facets.
filter_key
string
The exact rummager field name for this facet. Allows ‘key’ to be aliased to a rummager filter field
filter_value
string
A preset filter value that is applied when a checkbox is selected
filterable
boolean
This must be true to show the facet to users.
key
string
The rummager field name used for this facet.
keys
array
Field names used for the taxon drop down.
name
string
Label for the facet.
open_value
Value that determines the open state (the key field is in the future) of a topical facet.
preposition
string
Text used to augment the description of the search when the facet is used.
short_name
string

type
string
Defines the UI component and how the facet is queried from the search API
Allowed values: autocomplete, checkbox, content_id, date, hidden, taxon, text, topical
document_type
string

Allowed values: facet
first_published_at
or null

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
facet_values
Possible facet_values to show for non-dynamic select facets. All values are shown regardless of the search.
level_one_taxons
Link type automatically added by Publishing API
parent
The facet_group this facet belongs to.
part_of_step_navs
Link type automatically added by Publishing API
policies
Link type automatically added by Publishing API
policy_areas
A largely deprecated tag currently only used to power email alerts.
related_to_step_navs
Link type automatically added by Publishing API
secondary_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, 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
public_updated_at
or null

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, 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
publishing_request_id
A unique identifier used to track publishing requests to rendered content
publishing_scheduled_at
or null

rendering_app
or null

scheduled_publishing_delay_seconds
or null

schema_name
string

Allowed values: facet
title
string

updated_at
string

withdrawn_notice
object
explanation
string

withdrawn_at

View this schema on GitHub

Random example

{
  "base_path": "/64fd1074-efb1-4a2a-9c9f-e9f763441e09/b1c74224-f4d1-4113-9d86-a74b05a86f87/ee7d91ad-e2dc-46ea-8d72-1e11811828c7",
  "content_id": "52cd4ce6-dc82-46c6-953b-88ce11f05bb0",
  "description": "in, amet, malesuada Lorem cursus Duis imperdiet nisl orci nibh. senectus lectus at Nam netus dolor nibh ac a sem risus turpis scelerisque. volutpat sit tristique finibus, porttitor eros. sollicitudin dolor Mauris ac interdum. morbi sed non consectetur ac est. libero. aliquet. Suspendisse hendrerit, Ut purus molestie leo sagittis vestibulum. Quisque elit. tristique Ut ipsum fames Pellentesque Nam bibendum. suscipit vel mauris risus tempor ac Sed egestas. interdum. molestie vel et eu et lorem eu habitant Aenean tempor pellentesque",
  "details": {
    "change_history": [
      {
        "note": "Aenean Pellentesque vel cursus eros. tristique egestas. volutpat malesuada porttitor ac fames Nam leo turpis libero. tempor Duis finibus, molestie lorem nibh vestibulum. pellentesque non ac dolor Sed risus sem hendrerit, bibendum. tristique sagittis non molestie ipsum purus ultricies scelerisque. Ut eu Nam et ac amet, lectus elit. interdum. est. mauris morbi Mauris habitant sit a senectus netus dolor consectetur nibh. eu imperdiet et adipiscing massa suscipit",
        "public_timestamp": "2019-09-20T16:35:57+00:00"
      },
      {
        "note": "non leo habitant purus consectetur imperdiet bibendum. vel risus a Nam hendrerit, adipiscing",
        "public_timestamp": "2019-10-18T18:50:13+00:00"
      },
      {
        "note": "sed dolor nibh. Ut Sed elit. Suspendisse suscipit tristique adipiscing libero.",
        "public_timestamp": "2019-08-13T06:33:25+00:00"
      }
    ],
    "closed_value": "dolor ac molestie sit a tempor habitant Duis eu massa amet, non dolor eu adipiscing vel leo ac bibendum. Ut molestie Nam consectetur ultricies et netus tempor fames finibus, hendrerit, ipsum turpis morbi risus malesuada purus elit. et sollicitudin orci mauris risus imperdiet aliquet. tristique sed suscipit sagittis nibh Quisque pellentesque nisl lectus Lorem tristique interdum. libero.",
    "display_as_result_metadata": true,
    "filterable": false,
    "key": "Quisque libero. ac risus morbi lorem ac Nam Aenean finibus, sagittis sed egestas. lectus elit. interdum. eu Sed scelerisque. Nam Ut malesuada tristique consectetur bibendum. Lorem dolor non habitant",
    "name": "molestie Duis vel malesuada egestas. habitant ac sem dolor Nam ac netus Suspendisse mauris sed orci hendrerit, tristique imperdiet pellentesque interdum. morbi tristique Sed lectus lorem massa at sit libero. non non eu est. ipsum nibh senectus elit. adipiscing et ac purus ultricies Ut aliquet. a volutpat consectetur et eros. turpis Aenean sagittis leo Nam eu fames Pellentesque tempor vel finibus, risus",
    "open_value": "elit. et tempor suscipit nibh. at amet, tempor Ut vel eu a nisl volutpat aliquet. mauris et libero. ultricies leo morbi turpis purus molestie cursus consectetur lorem fames lectus bibendum. Nam Aenean interdum. nibh malesuada vestibulum. non ipsum non vel Quisque ac Ut adipiscing habitant eu Pellentesque ac orci sagittis sollicitudin interdum. massa scelerisque. in, tristique porttitor Lorem sem ac hendrerit, tristique eros. egestas. netus imperdiet sed Suspendisse sit pellentesque est. finibus, dolor Nam Mauris senectus Sed risus Duis ac dolor risus molestie",
    "preposition": "Quisque sollicitudin massa hendrerit, bibendum. adipiscing",
    "short_name": "orci turpis Ut libero. ac Sed non fames malesuada eu eros. vel Pellentesque Nam ac lectus lorem leo ultricies elit. et volutpat habitant ac sed sit sem Quisque Lorem bibendum. porttitor tempor purus vestibulum. finibus, est. nibh pellentesque senectus tristique adipiscing mauris Mauris risus amet, sollicitudin non Ut nisl Duis et egestas. Aenean ipsum interdum. aliquet. ac scelerisque. eu dolor risus suscipit sagittis Suspendisse nibh. massa molestie in, at vel hendrerit, molestie tempor interdum. tristique imperdiet cursus netus a consectetur morbi dolor Nam",
    "type": "text"
  },
  "document_type": "facet",
  "first_published_at": "2019-09-17T18:13:35+00:00",
  "links": {
    "children": [
      {
        "api_path": "/f222fef3-fc65-48fd-b914-a3e795c0c060",
        "api_url": "http://example.com/e2502446-3807-4c38-9567-de1369cf0a59#523533d55d2a0ff2b78e217e5c33dd31",
        "base_path": "/7b5496f9-7489-481d-8ee1-6ba295ab971f/58a9a758-4573-4d86-9f7b-a790daa41532/171789a7-b342-40ba-9cbb-79b57e727225/b6e5de6a-9b60-4d90-b649-303624ec32e1/90adb75f-f6a1-461a-a9b0-eaa75b064489",
        "content_id": "729bb7e4-a365-48cd-be84-d3d2b0978ea9",
        "locale": "zh-tw",
        "schema_name": "tempor turpis molestie risus",
        "title": "tempor sem Nam hendrerit, a eu leo adipiscing Sed Ut volutpat interdum. tristique turpis fames ac Pellentesque Nam interdum. pellentesque bibendum. vel et amet, risus consectetur suscipit aliquet. Suspendisse cursus porttitor in, orci vel lorem ac elit. Quisque Aenean netus dolor massa Lorem lectus Duis Mauris nisl tempor finibus, ac egestas. mauris risus dolor sollicitudin et morbi at non eu est. non ipsum senectus sagittis scelerisque. imperdiet molestie ac ultricies vestibulum. habitant molestie Ut"
      },
      {
        "base_path": "/ce87220f-51fa-4241-a6a6-31f12a1f74bb/0eea1349-341b-48d0-a11c-768c399caabc",
        "content_id": "9b1ff8da-4a04-4d5d-a59c-bec8114814f9",
        "links": {
        },
        "locale": "el",
        "public_updated_at": "2019-11-07T06:44:55+00:00",
        "schema_name": "Duis ipsum volutpat in, consectetur imperdiet sed egestas. dolor senectus risus tristique lorem amet, fames nibh purus dolor finibus, bibendum. massa interdum. hendrerit, vel ultricies libero. Suspendisse nisl Lorem et non sem morbi ac molestie ac vel nibh. Pellentesque ac Sed habitant porttitor Mauris vestibulum. suscipit tempor tempor netus turpis Aenean et aliquet. Nam cursus molestie est. sollicitudin elit. pellentesque tristique leo mauris non eu sit at eu Quisque sagittis malesuada lectus eros. risus orci Ut scelerisque. ac a interdum. Nam Ut adipiscing",
        "title": "non consectetur ac sit tristique porttitor Mauris interdum. netus est. amet, lorem dolor Aenean Quisque ac bibendum. molestie habitant libero. fames vestibulum. ipsum Lorem eu molestie dolor volutpat egestas. cursus tempor purus lectus eros. nisl elit. interdum. massa adipiscing pellentesque et in, Ut risus sagittis Ut Nam Sed vel sollicitudin imperdiet et mauris ac orci hendrerit, scelerisque. sem Duis a finibus, turpis nibh nibh. ac senectus non Nam Pellentesque aliquet. ultricies suscipit leo tristique tempor sed eu at morbi malesuada vel Suspendisse risus"
      },
      {
        "analytics_identifier": "bibendum. dolor vel lectus Aenean suscipit orci in, risus et tempor elit. sollicitudin tristique nibh mauris interdum. cursus vestibulum. massa malesuada ac amet, nisl scelerisque. aliquet. pellentesque risus ac est. interdum. dolor Nam ultricies Suspendisse ipsum porttitor molestie Sed ac sem libero. egestas. tempor sit eu netus senectus Mauris morbi eros. Ut Ut fames Quisque lorem Pellentesque purus consectetur non volutpat nibh. ac habitant non sagittis",
        "base_path": "/5dfdbff0-ec31-4f7d-9289-2555bd08fd6c/a60be0bc-e3f8-4b2f-a5c3-25a9a1c65407/b9d17810-5acd-4b6e-8a0b-f9b8fbb2019f/763e5db4-cb55-4c40-a9c6-4a41592b7064/7f010e3a-50b7-472b-badf-0f66d0c8e007",
        "content_id": "56954918-6951-4396-9e5c-166ac354195a",
        "locale": "fi",
        "public_updated_at": "2019-08-04T02:03:03+00:00",
        "title": "a",
        "web_url": "http://example.com/14fb68fa-4308-4750-bcfb-a9aecff45e6f/e6635029-7518-4dc3-8f68-6cf15e17e6fa#38acd05dbbbda70f5701d6804c5a4eaa"
      },
      {
        "base_path": "/8a51d472-8bcf-4895-b2fa-71541c8251ea/e40247bb-411b-4676-a82c-b475bbdd34a3/bda7eb59-1d34-499a-8399-3d3a82d294b4/fbd8ad49-e2af-469b-a950-e15bcc2a921d/a949ee18-b65d-4cf0-8b5c-eb44463ebd8c",
        "content_id": "333e64a5-b26a-434d-965a-7776a5502cab",
        "links": {
        },
        "locale": "is",
        "schema_name": "tristique at Sed adipiscing ac cursus leo Ut ac eu habitant non ac non Ut finibus, Suspendisse Aenean lectus in, turpis morbi ultricies Nam massa vel ac",
        "title": "interdum. sed et ipsum senectus morbi adipiscing purus sagittis massa ac volutpat cursus suscipit pellentesque nibh. molestie elit. est. non lorem non leo libero. risus finibus, hendrerit, Nam dolor vel ac egestas. consectetur at scelerisque. netus Ut et lectus tristique dolor ac imperdiet habitant porttitor Nam Sed tempor ac nisl molestie"
      },
      {
        "analytics_identifier": null,
        "api_path": "/08d3b29d-8a69-41a8-9f25-554e7345510a/014fabd1-8c1a-4e49-8b47-e23aa843ed55/c26e60d6-612f-4c34-8726-d9693c203b4b",
        "api_url": "http://example.com/28e6c44b-c774-4ba6-9bdc-d057bc2574bf/8ae50009-166b-437d-94a6-888714a0b4e6/f91dd625-b874-4d05-9f3c-c5edec854b2a#b4748f014e930aabe925959f77bb59e3",
        "base_path": "/7a3022a6-363c-45a4-8d89-99c1df556308/4e32fc75-cf17-44ce-868d-c6a4faa5cb1d",
        "content_id": "30c2c95e-8232-4b58-ad6a-690f89b6f2d4",
        "document_type": "mauris vestibulum. Nam netus sit Suspendisse interdum. consectetur imperdiet Quisque ac molestie morbi ultricies Duis habitant sed dolor leo non eu ac scelerisque. purus aliquet. tempor suscipit tristique Nam malesuada eu risus dolor nibh interdum. cursus Ut Sed ac eros. in, a risus pellentesque adipiscing Aenean amet, nibh. orci non hendrerit, sem ac et volutpat Lorem senectus ipsum sagittis tempor bibendum. vel sollicitudin Pellentesque porttitor nisl lectus Ut et egestas. finibus, tristique fames est. elit. molestie lorem turpis massa Mauris vel libero. at",
        "locale": "vi",
        "title": "tempor scelerisque. hendrerit, adipiscing suscipit netus dolor sed ac Ut sollicitudin at purus massa Aenean molestie morbi Nam in, amet, non imperdiet Suspendisse molestie Sed et eu Duis Pellentesque non ac finibus, vel habitant a libero. interdum. sem consectetur eros. risus egestas. volutpat nisl senectus tempor orci ac Mauris malesuada fames elit. ultricies",
        "web_url": "http://example.com/2341b251-af17-4eca-97c9-6d5eb6bd52b0/226690b8-11cc-47b3-a3cf-89799f6445e9/679e5a6b-fc18-4f8d-97dc-4f3fd6f8fc61#b1ea92ec9703cb3d18832b840e845a21"
      },
      {
        "api_path": "/f38bce93-f59a-4253-9eab-7395373505da",
        "api_url": "http://example.com/dc9de8fa-5ef1-4a24-a58a-859beaaedfa8/9db65084-5fbc-4e6b-a9a5-44522c4d2ba2/63a47ab6-a4fe-4870-80f1-c7b4a3f69a4d#d1005b619037ec7d7a4aad054677bee6",
        "base_path": "/41d03e05-638f-40d7-a59f-d0a40d99c6c3/cf6d56dd-c218-484b-8d22-145b4babd0d5/1cd9f65c-7562-4e7b-acb7-2f5bd29a97eb/3aaa78f3-e74f-4320-b568-e8eeceed2c76",
        "content_id": "36351b2d-a078-43a0-87ae-dbb67c99df70",
        "document_type": "lorem aliquet. ac at vel Suspendisse nibh Quisque Nam ac egestas. adipiscing nibh. non malesuada fames leo bibendum. molestie non eu nisl et Aenean libero. consectetur sed risus hendrerit, ipsum porttitor Sed ultricies interdum. ac risus tristique sagittis volutpat netus et eu finibus, tempor tristique a Ut tempor dolor morbi vestibulum.",
        "locale": "en",
        "public_updated_at": null,
        "title": "aliquet.",
        "web_url": "http://example.com/44107f03-058a-422f-a168-8e7189b861e0/30e1cb04-c935-490f-ac68-efc36d795252#56caa9fb21b4187ac93340646dfa1082"
      },
      {
        "api_url": "http://example.com/97aa3cfb-0f43-41bb-9f2a-b15bfd1ba3bd/2eddf32c-cd19-41ee-91d4-caa9e13df0f9/f05ac687-8907-4442-a74e-3e9abb691902#355c167ff961e76e87a3a2af8751685a",
        "base_path": "/690a08fc-7a8b-425e-ac14-2113b7ef0a11/05fa5fe8-4555-4440-b8b3-91b470ca8c72/c598f095-e601-46af-8e65-3dec3b20dc66/ffd6eab6-dfb1-4beb-8f22-dbd54e198c95",
        "content_id": "bdf78965-82ad-4225-af82-8206dd973f0a",
        "links": {
        },
        "locale": "ka",
        "title": "nibh massa morbi vel at ac in, ac amet, cursus adipiscing molestie Duis lectus senectus ac nibh. consectetur a malesuada turpis tempor porttitor elit. tristique vestibulum. eu sem fames tristique ipsum mauris sagittis et ac finibus, bibendum. Quisque nisl habitant leo purus Nam Ut interdum. vel Mauris sit dolor non aliquet. Pellentesque Sed suscipit eros. dolor Ut et imperdiet egestas. scelerisque. Suspendisse est. sed molestie Aenean sollicitudin Lorem tempor libero. interdum. netus",
        "web_url": "http://example.com/08921b92-a58d-45a2-ae88-ee2bf9624b0a#67e4409597cb9f73c44b8c80e169536a"
      },
      {
        "base_path": "/6b9da2b6-466b-44b4-961d-e79b23aab3a9/073bc1e2-f737-43ef-b509-fa593e2138c2/8b092da2-6127-415e-820c-aa2c09c77049/2f881f5d-1df5-4a97-bc4a-8136a759d08e/6957e5a1-7e8c-4fae-9880-516397004e0f",
        "content_id": "43751cba-352f-408c-83c2-c0df2033220a",
        "document_type": "vel Lorem risus Aenean non eu in, turpis eu malesuada interdum. scelerisque. bibendum. Ut fames netus Suspendisse Ut vestibulum. ac et nibh molestie volutpat adipiscing Quisque ipsum orci Mauris hendrerit, amet, senectus cursus Nam ac lorem habitant suscipit ultricies mauris ac vel sit ac sollicitudin tristique molestie Pellentesque Duis leo morbi tristique",
        "locale": "gd",
        "public_updated_at": "2019-08-24T01:49:02+00:00",
        "schema_name": "Sed adipiscing ipsum massa senectus Ut dolor aliquet. molestie non Mauris Nam ac turpis Lorem eu et hendrerit, bibendum. non tristique elit. molestie risus morbi risus Ut cursus Pellentesque tempor at est. orci finibus, in, sed imperdiet fames Nam Suspendisse porttitor Aenean vestibulum. vel et amet, libero. tempor sollicitudin eros. a sit malesuada Duis volutpat interdum. ultricies leo mauris ac nibh. ac scelerisque. habitant consectetur nibh egestas. lectus lorem purus eu pellentesque dolor nisl ac netus tristique sagittis vel suscipit interdum. Quisque sem",
        "title": "sit et sollicitudin lorem interdum. pellentesque interdum. sem et ultricies ac est. elit. molestie Mauris Pellentesque libero. imperdiet Sed non suscipit orci ac Ut dolor ac leo eu malesuada habitant risus senectus finibus, hendrerit, molestie amet, Lorem scelerisque. egestas. cursus adipiscing Duis at tempor a eu ac Aenean tristique Ut vestibulum. tempor Nam ipsum vel volutpat porttitor Suspendisse"
      }
    ],
    "policies": [
      {
        "api_url": "http://example.com/b84f1a09-1a95-44ad-9ce2-754744478742/3a4b52ac-a670-46be-b14d-71d72050594d/f526c9d3-5548-4400-ae36-dad6617a21a2/d58d7c3d-808d-4f38-b7a3-cb7b3380823f/6b5998ce-4790-4368-8106-85254db86dbb#bfb933e57010dcc79f25ced252ac518b",
        "base_path": "/56b46448-5e91-42d4-9567-cd534c5d382a/513beb62-c6c8-4f74-afca-45a5e9d1344e/cc8a29ab-0978-49ab-abcd-26f12c90eaa6/bf334625-1cc4-4a57-a5a4-fb7f3a907856/0c18ea84-6d94-4447-83f2-ebe1271266fd",
        "content_id": "966acad6-4443-4d88-ba55-1a4f65016dbe",
        "document_type": "dolor risus Aenean nibh. molestie leo Ut imperdiet non tempor non purus mauris ac porttitor Nam elit. Mauris fames nisl in, netus Ut risus bibendum. senectus Nam sit ac est. massa scelerisque. nibh tristique Quisque orci egestas. ultricies Suspendisse cursus sed hendrerit, et vel sollicitudin eros. lorem interdum. Duis",
        "locale": "sw",
        "schema_name": "Sed Nam lectus ipsum a Quisque nisl Pellentesque amet, interdum. non aliquet. dolor eros. ac ac tempor suscipit risus cursus vel pellentesque molestie vel non massa eu Suspendisse sem ac at bibendum. tempor morbi turpis libero. finibus, Nam Lorem hendrerit, sollicitudin nibh et netus nibh. molestie mauris elit. Ut sed in, Aenean porttitor interdum. purus",
        "title": "tristique volutpat ac Aenean Ut nibh molestie Quisque amet, vel interdum. molestie sit sagittis dolor ipsum lorem libero. Pellentesque massa vestibulum. egestas. porttitor tempor leo purus Mauris consectetur turpis ultricies orci morbi mauris habitant tristique elit. risus sed interdum. senectus bibendum. sollicitudin Suspendisse Ut non ac non in, nibh. nisl risus ac malesuada ac eu at Nam vel et cursus eu Lorem sem a scelerisque. eros. finibus, dolor est. Nam Duis suscipit aliquet. et fames hendrerit, adipiscing lectus tempor netus pellentesque Sed imperdiet",
        "web_url": "http://example.com/148c99da-eba1-4d26-b5d4-d830889b6ce4/6289f7ef-5588-4084-9bec-71825c61a740/7e209ba1-c94c-4463-bab1-e0a7bb98801a/a02d8c97-f9e4-4481-ae31-27c1f36a46e3#7ae5f6f11d84c0dfec02a1066fc7c4b9"
      }
    ],
    "secondary_to_step_navs": [
      {
        "api_path": "/987c8428-6648-4d12-b88b-034a542549b6/171b6728-5c30-453f-a192-9c8f4fe8665b/53c69334-7c97-4659-ae3f-dbddf61ed699/098c9038-be2e-472c-82d5-cae090003029/628958f3-2caf-422d-8297-1d665942a73b",
        "api_url": "http://example.com/5a126cc0-e292-434c-8697-64c4da69cdcc#4b5a42f440f8e52960532e8292f339c9",
        "base_path": "/4d2dc465-0cbb-43e9-b1e4-f99bc8813f7a",
        "content_id": "a8550c1a-64aa-4a61-9666-9579fe2c7b67",
        "locale": "kk",
        "schema_name": "ac senectus Ut dolor Ut ac",
        "title": "sit risus nibh sem dolor volutpat et nisl non Nam ipsum porttitor suscipit adipiscing pellentesque non Ut consectetur in, purus nibh. eu eros. senectus Ut ultricies ac est. finibus, cursus orci Aenean Mauris molestie leo ac sagittis imperdiet interdum. Lorem Suspendisse massa malesuada vestibulum. dolor hendrerit, scelerisque. elit.",
        "web_url": "http://example.com/65472ff2-a4b0-4826-b958-a356a8c5dc6c/b95e60b0-1f5f-491f-9fcf-9f44e310bc12/877f817c-b6e9-4e9a-962f-db05b3aa9305/07e6cacc-3b11-4c09-9702-0a2b3834cc37/cd2ad274-544f-468b-9e3f-7355d3d5b335#719c9321b407c013ab364b33661738ef"
      }
    ]
  },
  "locale": "az",
  "phase": "beta",
  "public_updated_at": null,
  "schema_name": "facet",
  "title": "mauris suscipit eros. ac Quisque amet, Nam fames vel Aenean eu sit dolor scelerisque. Sed ipsum interdum. egestas. ac purus risus Ut porttitor netus sem elit. ac turpis dolor massa bibendum. et sagittis tempor libero. Nam leo morbi cursus Ut sed Mauris ultricies molestie senectus malesuada lorem hendrerit, Pellentesque tristique adipiscing habitant Suspendisse non",
  "updated_at": "2019-07-26T21:38:31+00:00"
}

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
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.
base_path
or null

bulk_publishing
boolean

change_note
["null", "string"]

description
or null

details
object
closed_value
Value that determines the closed state (the key field is in the past) of a topical facet.
combine_mode
string
Specifies how to combine with other facets
Allowed values: and, or
display_as_result_metadata
boolean
Include this in search result metadata. Can be set for non-filterable facets.
filter_key
string
The exact rummager field name for this facet. Allows 'key’ to be aliased to a rummager filter field
filter_value
string
A preset filter value that is applied when a checkbox is selected
filterable
boolean
This must be true to show the facet to users.
key
string
The rummager field name used for this facet.
keys
array
Field names used for the taxon drop down.
name
string
Label for the facet.
open_value
Value that determines the open state (the key field is in the future) of a topical facet.
preposition
string
Text used to augment the description of the search when the facet is used.
short_name
string

type
string
Defines the UI component and how the facet is queried from the search API
Allowed values: autocomplete, checkbox, content_id, date, hidden, taxon, text, topical
document_type
string

Allowed values: facet
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
policy_areas
A largely deprecated tag currently only used to power email alerts.
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, 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
or null

routes
array

schema_name
string

Allowed values: facet
title
string

update_type

Allowed values: major, minor, republish

View this schema on GitHub

Random example

{
  "base_path": "/272d2d6a-00b6-42c2-b252-bf3e3099a991/a5f5b801-d71a-4b4b-9b20-374bf210d698",
  "bulk_publishing": false,
  "description": "ipsum eu vel volutpat vel sed Lorem nibh pellentesque eu non Nam malesuada tristique imperdiet Quisque ac nibh. dolor porttitor habitant tristique leo at fames eros. ac interdum. senectus ac Ut interdum. Aenean finibus, tempor bibendum. vestibulum. cursus egestas. turpis sagittis morbi lectus mauris in, adipiscing sollicitudin libero. Suspendisse netus risus Pellentesque consectetur et aliquet. Sed non Duis tempor a purus scelerisque. sit Ut ac massa molestie ultricies Mauris hendrerit, elit. risus sem molestie et nisl Nam dolor suscipit est. lorem orci amet,",
  "details": {
    "closed_value": "volutpat molestie Lorem Quisque porttitor purus hendrerit, malesuada egestas. imperdiet dolor mauris lorem et Suspendisse bibendum. adipiscing nisl leo Ut interdum. dolor vel suscipit sollicitudin nibh netus libero. eu tristique Aenean a ac tempor nibh. in, ac interdum. tempor Mauris Ut ipsum orci risus vel cursus et senectus risus ac Nam at sed molestie habitant consectetur fames Sed massa turpis sit sagittis est. morbi ultricies non tristique Duis aliquet. Nam eu non ac amet, pellentesque eros. lectus sem vestibulum. scelerisque. Pellentesque elit. finibus,",
    "filter_value": "netus orci ultricies bibendum. ac ac egestas. Aenean Nam sit at Sed sem ac eu nibh. dolor Ut nisl interdum. a vel ac tempor habitant sagittis consectetur imperdiet massa senectus Duis eros. est. Lorem in, et suscipit Quisque dolor molestie Mauris eu Pellentesque et elit. volutpat turpis molestie tempor lectus sed mauris Ut aliquet. tristique vel porttitor tristique ipsum Suspendisse hendrerit, morbi scelerisque. interdum. lorem non pellentesque libero. cursus nibh vestibulum. risus purus leo amet, adipiscing non fames risus sollicitudin malesuada Nam finibus,",
    "filterable": false,
    "key": "Pellentesque lorem ac bibendum. non Ut eros. tristique aliquet. vel hendrerit, purus sit libero. elit. fames Lorem ultricies sed molestie cursus orci massa ac suscipit vel imperdiet vestibulum. mauris malesuada et morbi consectetur Aenean molestie sagittis in,",
    "keys": [
      "interdum. molestie et dolor tristique ultricies Quisque Duis egestas. non nibh. libero. ipsum a Pellentesque vestibulum. hendrerit, lectus amet, ac sem massa ac non adipiscing eros. cursus at imperdiet Lorem volutpat turpis sagittis vel Nam orci pellentesque est. sed scelerisque. suscipit morbi habitant netus dolor tempor senectus ac",
      "porttitor ac tristique dolor imperdiet lorem eu ac amet, purus adipiscing tempor Aenean non leo egestas. vestibulum. dolor Quisque Suspendisse et Ut Pellentesque risus nibh. cursus nisl Ut sit pellentesque Nam ac ultricies sem elit. mauris non sagittis Nam eros. tristique senectus risus finibus, ipsum vel sollicitudin fames lectus interdum. morbi Duis consectetur tempor bibendum. volutpat aliquet. Lorem sed est. vel molestie Sed interdum. suscipit in, habitant Mauris et orci libero. at",
      "Nam amet, finibus, nibh ultricies ac orci suscipit sit morbi Sed Pellentesque libero. molestie ac consectetur scelerisque. ipsum Mauris nisl pellentesque eu cursus Nam ac ac senectus bibendum. Ut purus hendrerit, interdum. Lorem Duis",
      "nisl Suspendisse elit. non adipiscing Quisque sagittis fames purus volutpat est. lorem sed et vestibulum. sem Nam Aenean Duis vel dolor in, Nam risus interdum. molestie bibendum. ipsum eu cursus interdum. mauris hendrerit, habitant imperdiet ac egestas. ultricies sollicitudin tristique et vel scelerisque. Ut porttitor Lorem tempor ac consectetur aliquet. tempor malesuada sit eu leo Mauris eros. morbi Pellentesque nibh massa lectus risus amet, libero. molestie a pellentesque tristique senectus suscipit dolor Ut ac turpis ac Sed nibh. finibus,"
    ],
    "name": "ac turpis eu netus massa risus molestie orci sagittis purus interdum. in, et eros. et lectus tempor sollicitudin amet, molestie interdum. non Nam porttitor non consectetur volutpat nisl suscipit a tristique est. ipsum ac mauris finibus, Sed nibh risus elit. sed malesuada Quisque pellentesque cursus Nam bibendum. vestibulum. Lorem dolor aliquet. sem Ut nibh. fames sit hendrerit, morbi at tempor habitant ultricies lorem senectus Aenean adipiscing Ut leo egestas. vel ac dolor Mauris vel ac Duis imperdiet eu Pellentesque Suspendisse libero. scelerisque. tristique",
    "type": "taxon"
  },
  "document_type": "facet",
  "last_edited_at": "2019-10-07T16:09:35+00:00",
  "locale": "ps",
  "need_ids": [
    "eu fames Mauris malesuada Pellentesque habitant ac adipiscing aliquet. Quisque cursus volutpat sem in, turpis non at nibh porttitor Aenean sit elit. molestie eros. eu tristique egestas. a amet, ipsum tempor Duis nisl orci massa Suspendisse dolor purus Nam nibh. tristique imperdiet et mauris sagittis vestibulum. sollicitudin sed non ac suscipit Nam vel et risus tempor Ut lorem hendrerit, scelerisque. est. morbi consectetur Sed interdum. leo vel Lorem ac netus ac risus bibendum. Ut libero. pellentesque dolor finibus, interdum. senectus ultricies lectus molestie",
    "molestie sollicitudin tristique netus cursus tempor Suspendisse leo et eros. hendrerit, in, et molestie a Aenean ipsum tempor sed finibus,",
    "interdum. Ut et eu tempor libero. in, Quisque amet, scelerisque. netus ac Ut Suspendisse Pellentesque eu molestie molestie morbi sollicitudin elit. habitant at risus non fames risus interdum. consectetur eros. suscipit turpis Mauris vel cursus lorem Aenean senectus sem Lorem mauris Nam egestas. tristique bibendum. ipsum hendrerit, Nam Duis Sed est. ac sagittis volutpat ac vel purus tempor dolor imperdiet ultricies non nibh. orci porttitor tristique nisl pellentesque lectus leo vestibulum. finibus, ac sed et malesuada dolor a adipiscing sit nibh aliquet. massa",
    "Aenean netus interdum. suscipit at vel senectus Pellentesque tempor egestas. mauris in, dolor habitant Sed amet, imperdiet Mauris est. tempor cursus non lectus tristique adipiscing finibus, morbi tristique purus ac vestibulum. Nam interdum. scelerisque. Ut ultricies pellentesque orci nibh fames lorem sagittis aliquet.",
    "volutpat",
    "Duis tempor consectetur nisl eu lorem Lorem eu massa tristique cursus aliquet. Quisque fames eros. habitant sit Ut et non sem ac scelerisque. et porttitor non Sed ac sagittis mauris vel dolor dolor turpis malesuada ac",
    "sagittis interdum. et interdum. vestibulum. netus adipiscing vel lorem nisl morbi ac elit. Pellentesque vel eros. ac mauris ultricies orci sollicitudin amet, ac sem Ut nibh eu massa scelerisque. volutpat libero. suscipit aliquet. non tristique Sed risus ac habitant a dolor molestie consectetur ipsum purus est. Nam tempor imperdiet risus leo cursus Suspendisse eu sit senectus egestas. et tempor Nam dolor",
    "vestibulum. fames hendrerit, nisl ultricies purus est. finibus, nibh bibendum. mauris molestie habitant risus cursus suscipit egestas. Aenean adipiscing interdum. Nam et scelerisque. Mauris Quisque Ut lectus orci eros. netus Sed Nam tristique Suspendisse non dolor ac Lorem tristique sem ac Duis et",
    "suscipit pellentesque interdum. amet, Aenean massa consectetur sollicitudin malesuada ipsum est. leo Nam ac risus Pellentesque Ut Ut sit nisl habitant tempor Suspendisse sed et ultricies finibus, sem nibh dolor vel vestibulum. netus dolor lorem tempor"
  ],
  "phase": "live",
  "previous_version": "Mauris senectus aliquet. tempor interdum. amet, sed Nam risus egestas. Duis Ut sollicitudin ac suscipit ultricies orci purus dolor fames morbi ipsum turpis et molestie cursus nibh. nisl libero. Quisque leo molestie non lectus hendrerit, Lorem Ut a in, imperdiet ac non sit at massa et Sed risus netus malesuada sem est. consectetur lorem tristique eros. mauris Aenean ac dolor adipiscing Pellentesque ac tristique volutpat vel pellentesque tempor interdum. scelerisque. porttitor sagittis vel elit. finibus, eu nibh eu bibendum. Nam habitant vestibulum. Suspendisse",
  "publishing_app": "specialist-publisher",
  "rendering_app": null,
  "schema_name": "facet",
  "title": "cursus non Nam Quisque molestie Suspendisse nibh. scelerisque. ac adipiscing est. orci consectetur netus libero. tristique turpis nisl tempor sollicitudin ac dolor Ut ultricies eu",
  "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
facet_values
Possible facet_values to show for non-dynamic select facets. All values are shown regardless of the search.
parent
The facet_group this facet belongs to.
previous_version
string

View this schema on GitHub

Random example

{
  "bulk_publishing": false,
  "links": {
    "facet_values": [
      "6e624a7b-8420-4265-8632-205b2765457e",
      "b9b97095-00bb-4872-869a-80de4ed90532"
    ],
    "parent": [
      "b2eefeb8-5ed8-498b-a935-1273b3f18cee"
    ]
  },
  "previous_version": "orci pellentesque tristique massa amet, cursus mauris malesuada Aenean nibh. Quisque aliquet. lectus a dolor scelerisque. tristique bibendum. tempor interdum. sem eros. purus non leo adipiscing risus fames ac suscipit sollicitudin sit ultricies Nam senectus nisl Nam risus elit. Ut tempor est. Mauris finibus, vel hendrerit, eu molestie morbi volutpat nibh sagittis libero. et habitant lorem ac"
}