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
role_appointments
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

{
  "analytics_identifier": "ultricies dolor lorem ac malesuada turpis et interdum. tristique Sed consectetur et sit nibh ac imperdiet tristique eu Suspendisse molestie Nam risus volutpat eu Mauris adipiscing egestas. sollicitudin hendrerit, Aenean senectus Pellentesque non tempor tempor leo suscipit Lorem Nam Ut sagittis Ut lectus aliquet. sem ipsum dolor est. netus orci ac Duis bibendum. morbi sed molestie vel interdum. Quisque massa risus elit. vestibulum. libero. habitant purus ac cursus nibh. a vel amet, at mauris non pellentesque porttitor finibus, fames eros. in, scelerisque. nisl",
  "base_path": "/1930f3d2-89f3-449d-976a-3e452261acc6/ca6b2dab-15dd-440d-8b4d-14cb14210b23/d6d2d46f-4dbe-493b-a6f0-8cf26586535f/2eb71153-02e1-49b6-9b66-6292fd86b4c2/b591f10a-577d-4f0b-a2f7-636e22656d5a",
  "content_id": "cd1c987d-0933-4d5c-a181-513402b909d4",
  "description": null,
  "details": {
    "combine_mode": "and",
    "display_as_result_metadata": false,
    "filterable": true,
    "key": "Ut molestie eu",
    "name": "sollicitudin Nam et hendrerit, turpis molestie vel morbi at purus scelerisque. Aenean pellentesque suscipit in, sit porttitor tempor ac bibendum. Duis eu massa molestie senectus Sed amet, eros. risus cursus imperdiet aliquet. nisl dolor finibus, Ut sed non Lorem",
    "type": "topical"
  },
  "document_type": "facet",
  "links": {
    "available_translations": [
      {
        "analytics_identifier": "purus sagittis molestie ac Quisque suscipit Pellentesque est. at nibh. Ut hendrerit, Suspendisse ac",
        "base_path": "/29e8de2f-cd33-4495-9051-7e1ef1ab7666/83c3446a-683d-4e1b-83f8-ffae4873fabe/b22d93f9-8f7c-4def-810f-31b972684546/7cc9b194-b377-4b4e-b941-915f5f3cc19f",
        "content_id": "1bfeec32-1107-4126-9e13-26852af0b425",
        "links": {
        },
        "locale": "pt",
        "title": "sem in, Mauris leo at ac Suspendisse Duis",
        "web_url": "http://example.com/54e08325-9a95-42b6-990c-c046edbe49e0#50c36b98a585e71c8ad958566c4ea5eb"
      },
      {
        "analytics_identifier": null,
        "api_path": "/1560cd81-1795-4a0b-bba9-3ed44e633531/ad63aa76-bfb5-4c5a-a809-39de48dcc43d/402e17cb-486e-4212-b4ec-b9550f69a8a3/09d2ded1-c0a8-4bd1-ad29-d42f9553b693/4e6774e0-f8f5-41a1-90bf-79a5683c2417",
        "base_path": "/a96c7cf6-2fd8-4262-bb2c-b391ae09cd47/e6fc3bcc-d7a7-45dc-b2fe-e36526fa562c/73572ffe-537a-47f9-8497-970d5b1e4ea6",
        "content_id": "40225c16-b605-4b58-804a-8a1532375c60",
        "document_type": "sollicitudin turpis vestibulum. mauris ultricies elit. Nam ac finibus, sem et Quisque non libero. nisl sagittis molestie massa Ut volutpat aliquet. vel senectus morbi risus sit Pellentesque ac eu a lectus consectetur interdum. lorem at malesuada purus cursus eros. Duis Mauris risus dolor nibh. fames scelerisque. leo Ut Suspendisse est. non interdum. Lorem Nam dolor tempor eu hendrerit, tristique tempor Aenean tristique Sed nibh suscipit habitant molestie netus sed bibendum. vel ipsum et in, ac orci pellentesque porttitor ac amet, adipiscing imperdiet egestas.",
        "links": {
        },
        "locale": "da",
        "schema_name": "nibh. non nisl tempor molestie suscipit nibh vel lectus imperdiet Quisque Suspendisse Pellentesque dolor et mauris ipsum non amet, ac sed Duis Ut pellentesque egestas. risus at Mauris ac scelerisque. ac eu risus tempor fames in, ac molestie dolor vel libero. massa vestibulum. turpis hendrerit, Ut cursus Aenean lorem sem bibendum. interdum. tristique leo est. Nam tristique ultricies sagittis orci eros. senectus Nam Lorem adipiscing consectetur eu sollicitudin finibus, netus a purus sit elit. habitant volutpat et morbi aliquet. interdum. malesuada porttitor Sed",
        "title": "finibus, risus aliquet. consectetur est. leo Ut egestas. adipiscing sem Sed eu hendrerit, fames ac Lorem Pellentesque vestibulum. a non netus morbi molestie massa sed ac mauris suscipit Duis scelerisque. senectus volutpat Aenean interdum. lorem purus ac risus habitant tempor lectus",
        "web_url": "http://example.com/e454822d-1613-4432-aba4-74d78fa5821d/8a403f43-1114-495e-80e2-14aa636992ad#0eeb33cdbbca88d2c2efd8eb239b26e1"
      },
      {
        "analytics_identifier": "Duis Pellentesque habitant sit nibh. sem leo Aenean morbi ac suscipit Nam tempor dolor finibus, purus netus turpis Sed in, molestie elit. nibh Ut",
        "base_path": "/58a6aadd-5c10-4883-89d5-0f482270f132/97179050-e704-4dd8-b3a7-762489c09705/7c46ebc6-fae4-45a7-951c-acbc33699469/5a7850e1-e0e0-4da4-af33-ef0b8507fa48/8a738038-04f7-4790-9601-a27459dff743",
        "content_id": "8a715a97-238a-45fd-a336-d468a18a7f5f",
        "document_type": "purus eu massa tempor tristique malesuada",
        "locale": "bg",
        "public_updated_at": "2020-03-24T23:09:14+00:00",
        "title": "purus aliquet. consectetur egestas. dolor sem habitant eu suscipit Aenean interdum. sollicitudin tristique libero. scelerisque. sagittis malesuada ultricies Ut molestie Duis",
        "web_url": "http://example.com/f4eab287-db3c-4702-9ae8-e8db5927defa/a094bf91-fc12-4fd5-b4e4-42f52778ce90/aa50113c-7f60-4155-a4d5-68d13cab0295/c62307fb-10b7-490a-b4c1-5c5c30f52f33/fe26b74d-cd60-418e-9893-ee054d87e25f#862b444d359ddd4acc2c9fc058432559"
      }
    ],
    "child_taxons": [
      {
        "api_path": "/e988b58a-5695-435e-a22f-fb639e96f8f0/23c8b70e-7aa7-41dc-a18d-01f735192123/2750b465-753f-42cd-9d40-0d97186ecb73/7301ecf9-f88e-4419-a460-3eaaa8d66b4a",
        "api_url": "http://example.com/0218bf9f-3b75-4fac-b6eb-2fc05ed0b872/993a1c9d-0fdd-4af7-aeeb-03bd232d8330/e3b5efaf-0d17-4dbe-907f-8f991e011d79/4c0d89a0-251a-4293-822f-7d1710c152e9#a6565137f6ae0ac38c966966eae87d1e",
        "base_path": "/48ec1fd3-7639-4f90-bcd5-22eab97246f3/02b40857-70fa-41e9-9e61-e77b8b2dc72b",
        "content_id": "4543d892-da8a-4e11-ba60-dd6c73c7904d",
        "links": {
        },
        "locale": "zh",
        "schema_name": "Suspendisse purus at ac volutpat bibendum. eu risus molestie ac non consectetur porttitor malesuada orci finibus, ipsum netus aliquet. sed a tristique Lorem libero. suscipit eros. amet, lorem Nam Duis egestas. lectus Pellentesque Aenean nibh. Quisque Ut nibh interdum. mauris Ut turpis morbi fames nisl vel sit elit. est. vestibulum. cursus et et adipiscing tristique massa Mauris interdum. Sed eu imperdiet pellentesque hendrerit, scelerisque. dolor ac tempor risus sagittis in, senectus dolor ultricies molestie sollicitudin ac non vel Nam habitant sem leo tempor",
        "title": "Pellentesque ac ipsum eros. tristique leo et sed Sed aliquet. habitant volutpat adipiscing turpis Mauris dolor non interdum. tristique ac Suspendisse molestie tempor senectus ac egestas. Nam sit nibh ultricies risus netus vel tempor Aenean malesuada scelerisque. pellentesque dolor libero. elit. eu finibus, Duis porttitor eu amet,"
      },
      {
        "analytics_identifier": "mauris adipiscing suscipit turpis Suspendisse risus Duis ultricies sit scelerisque. habitant non in, lorem vel dolor tristique leo Ut tempor Quisque et libero. senectus sagittis lectus est. imperdiet sem ac vestibulum. amet, elit. a bibendum. fames dolor ac Nam finibus, Mauris",
        "api_url": "http://example.com/e50574af-e8e9-4a67-8ec0-ed62ee1d29bd/7e51e887-c8dc-47af-8ecf-1358aa98c0e0/3d970b24-3ade-49f5-89cc-5780a484b826/43c98fe0-387e-4bb1-9c75-6c181bbfae84#2e8a6f3fb2d86d5fb0a7a187d191b2ad",
        "base_path": "/450a1d33-a16b-4f54-8067-50e460e09223",
        "content_id": "943ab0ab-6e5c-4639-bc6f-c24c7c85f5d8",
        "document_type": "non mauris ac consectetur eu turpis dolor at aliquet. nibh. sit risus eu lectus interdum. Suspendisse ac in, et orci risus ac vestibulum. non Lorem vel adipiscing pellentesque Duis libero. ultricies finibus, molestie dolor egestas. Ut lorem nibh Mauris fames volutpat amet, elit. malesuada hendrerit, eros. suscipit est. Sed sed sem Ut morbi Aenean tempor netus et cursus massa Pellentesque imperdiet bibendum. scelerisque. senectus a tempor sollicitudin tristique purus Nam leo habitant tristique ipsum Nam vel ac porttitor sagittis interdum. Quisque molestie nisl",
        "locale": "ur",
        "schema_name": "netus massa vestibulum. malesuada elit. porttitor ac molestie Suspendisse et vel orci volutpat Aenean senectus sagittis Ut tempor molestie vel bibendum. sollicitudin purus eu Lorem scelerisque. leo tristique dolor",
        "title": "interdum. sem nibh. vel a malesuada ac lorem Sed interdum. in, eu eu leo elit. cursus et turpis Mauris molestie est. senectus Lorem nibh purus aliquet. imperdiet consectetur fames amet, porttitor non Duis et eros. nisl ipsum volutpat risus libero. ac suscipit Aenean scelerisque. sollicitudin adipiscing lectus Quisque ac sit at orci Ut massa molestie Nam mauris sagittis dolor dolor tempor ultricies tempor Pellentesque Nam non habitant tristique ac finibus, vel sed hendrerit, netus bibendum. egestas. risus Suspendisse tristique pellentesque Ut vestibulum. morbi"
      },
      {
        "analytics_identifier": "mauris suscipit cursus ultricies vel et Suspendisse orci eros. elit. Pellentesque non porttitor netus finibus, fames sem Sed imperdiet risus vestibulum. amet, consectetur Lorem tristique eu morbi dolor nisl ac a Ut bibendum. nibh Nam interdum. Mauris risus scelerisque. tempor dolor tempor ac vel ac molestie malesuada turpis sollicitudin tristique egestas. at eu pellentesque senectus massa sed libero. est. purus ipsum hendrerit, nibh. lorem in, molestie volutpat Duis ac Nam Ut non lectus Quisque adipiscing Aenean interdum. sagittis sit et habitant leo aliquet.",
        "api_url": "http://example.com/dd2ca258-b2d6-4819-a993-489730794325/b45f1a46-20b8-4a09-b1e1-8a09dd87cd47/0bf09ee6-3dc4-42f5-a532-865415e97dff/3d046e4a-ae0b-499a-874d-dc4a146e94b7/60489c8f-a84d-48e8-8bd2-6adb97a7fbb6#2d1b38740e7a2518f98c36978adb4d1c",
        "base_path": "/d65fb8f3-b28b-4777-ac77-46c39bbb30ba/756f1002-3514-4858-8eb6-aa2bb7d35826/c74d9cfe-f458-49f6-a7b5-e44059af0237/ee139c9b-7719-4540-90db-b68bfe02f329/b7ea5b8b-d422-4c2b-bc5d-00de48f652df",
        "content_id": "fe897785-8572-42bd-83d3-05965183d9cc",
        "links": {
        },
        "locale": "sv",
        "title": "Sed Suspendisse volutpat vel tristique purus interdum. massa risus sollicitudin Quisque ipsum suscipit adipiscing vel lorem interdum. at molestie egestas. Nam tempor mauris risus Mauris elit. consectetur Ut sem nisl ac tristique imperdiet in, porttitor senectus fames est. eros. turpis leo ac non hendrerit, cursus aliquet. netus dolor lectus nibh. Nam malesuada molestie vestibulum. Duis et eu Ut a non morbi habitant sagittis sit finibus, sed ac ultricies Lorem libero. Aenean scelerisque. nibh pellentesque et amet, orci dolor eu ac tempor bibendum. Pellentesque"
      },
      {
        "base_path": "/5fa93271-7e34-4a39-af48-7f52a14fe3f1/c189f531-a8a9-4c5c-b3b5-0ad8218df2a1",
        "content_id": "0093e8e2-cd57-4062-b5f0-2eb8bc35251a",
        "locale": "hu",
        "title": "Quisque tristique egestas. consectetur molestie non lorem aliquet. sit non cursus est. vel dolor in, Suspendisse tempor purus Lorem Ut volutpat eu Pellentesque hendrerit, netus porttitor massa orci"
      },
      {
        "base_path": "/41e35f1a-46d7-4919-a458-02f7ceb8f93d/61a4f58d-37ec-4cf9-b01b-f64243b70aa2/abda5cea-0744-403c-93af-97981db188b1",
        "content_id": "a38c6779-20af-4195-b872-81f3b0a26a71",
        "links": {
        },
        "locale": "cy",
        "public_updated_at": null,
        "schema_name": "habitant vel eu egestas. aliquet. turpis amet, sed nibh. cursus Lorem ultricies Nam Duis senectus et adipiscing sagittis non tristique netus ac Sed massa interdum. interdum. porttitor sit purus Quisque leo non nibh suscipit vestibulum. at ac libero. est. mauris consectetur in, a tristique Mauris Ut vel imperdiet malesuada tempor hendrerit, dolor risus ac elit.",
        "title": "et sed sit sagittis malesuada Ut nisl molestie amet, Ut Quisque ac leo lorem ac tempor habitant volutpat Pellentesque mauris ac eros. non vestibulum. Sed Nam sollicitudin interdum. tempor purus interdum. vel scelerisque. nibh."
      },
      {
        "api_path": "/9224444b-7b64-484d-8888-2d570a0173cf/febffa8c-abaa-41ff-af28-b6ebc2751d54/6c0adc39-5867-482d-992a-cfc6b57ad9aa",
        "api_url": "http://example.com/9b4abf8d-f11a-4ca8-a631-bcb541ce24bc#10677ca6ba77f320f4968fe40dadafe3",
        "base_path": "/4584c7f0-b81f-4061-a1e4-41f01f10bbb2/d9514ca4-2066-4535-a545-fdeae464c939/e045bc2c-ef2c-49bb-bd77-48bf99a47832/92a6bea1-ed40-4564-8044-66fa08015103",
        "content_id": "604433b4-2139-40cf-aa21-33f58b687315",
        "locale": "sr",
        "public_updated_at": "2020-02-03T05:19:13+00:00",
        "schema_name": "consectetur imperdiet at Pellentesque eu netus risus molestie cursus",
        "title": "Lorem interdum. risus elit. eu",
        "web_url": "http://example.com/48047765-cf7c-4eaa-83cc-7c9c12fea85e#0babf50046d5278a2b1e1a71cdb71b2f"
      }
    ],
    "children": [

    ],
    "parent": [
      {
        "analytics_identifier": "Ut senectus risus eros. pellentesque cursus Nam habitant suscipit lectus Ut purus interdum. ac netus nisl orci nibh at scelerisque. vestibulum. ac vel eu bibendum. adipiscing eu tempor ultricies libero. dolor Sed sed sit Lorem non Quisque in, egestas. amet, dolor porttitor lorem massa molestie Aenean turpis fames tempor malesuada Suspendisse sagittis ac finibus, risus et volutpat non elit. et consectetur Nam tristique mauris sollicitudin Pellentesque leo Duis tristique interdum. Mauris sem nibh. imperdiet ac ipsum hendrerit, est. morbi molestie vel aliquet. a",
        "api_path": "/8005954f-e35e-4a7d-914e-be7be06a8db0/63e79f35-2fc5-485e-ba7e-bcd5d8fc0b69/063fad86-550e-475a-b01f-bb4387903f47/1e7ae00b-8a12-4d53-944d-e67acaebf0b7/766c68ec-827c-4a8b-94ff-74b7ad17e5fd",
        "api_url": "http://example.com/68d2d076-eaf2-4060-9ed6-57023fe130e1/72f88a2c-17bb-4441-b956-0fd7090f1913/14c55664-1dcc-4da9-b6d8-d76b8337eb9b/6daf70e8-5b6c-46a2-a17c-f0928394fc29/da362c42-c4de-461a-9809-498308efa99d#4855808b050d870885c43d36d7250612",
        "base_path": "/328dcc58-96a6-4c57-84f8-f771839d5681",
        "content_id": "329f8174-f2b0-40eb-94c4-403434ae6a29",
        "links": {
        },
        "locale": "et",
        "schema_name": "risus mauris risus Aenean tristique sollicitudin egestas. interdum. nibh sagittis molestie eros. ipsum ac at vel volutpat malesuada purus massa turpis finibus, Pellentesque Ut elit. et dolor nibh. vestibulum. morbi adipiscing ac Quisque nisl sem aliquet. hendrerit, lectus Ut netus ultricies est. non molestie amet, Nam senectus a Suspendisse cursus orci interdum. pellentesque sit eu ac Lorem fames consectetur",
        "title": "pellentesque egestas. molestie malesuada in, nisl volutpat risus Pellentesque bibendum. finibus, Ut Ut sit Mauris ac porttitor tempor lorem sollicitudin Sed cursus vel orci sem sagittis mauris nibh lectus Quisque aliquet. habitant morbi tristique suscipit nibh. Aenean netus ac turpis amet, eros. eu"
      }
    ],
    "related_to_step_navs": [
      {
        "base_path": "/40c2076f-a4a0-4edb-8345-acefdbb03391/37eb47d4-aa92-4753-a766-9eeb4b71c2cd/3e0491a4-92d2-43e3-98ef-06363a7b4575/7bbd0c0f-0a9c-4817-a98d-43392239383c",
        "content_id": "f1b49ad4-06ec-4813-8746-7d1cdc5b6ea5",
        "locale": "cs",
        "public_updated_at": null,
        "schema_name": "et vel massa tristique est. aliquet. eros. dolor in, imperdiet amet, nibh risus ipsum Lorem non lorem scelerisque. ac lectus Nam cursus non Duis tristique Aenean sem malesuada tempor sollicitudin netus vel ac egestas. leo eu a turpis risus vestibulum. Mauris sed morbi sagittis nibh. orci Sed sit hendrerit, Nam volutpat porttitor interdum. senectus habitant libero. consectetur interdum. ultricies nisl suscipit Pellentesque at finibus, dolor Ut Suspendisse elit.",
        "title": "tempor ac eros. a vel interdum. molestie ac ipsum sagittis dolor vel et risus risus cursus sollicitudin mauris sed lorem adipiscing Mauris interdum. turpis tempor porttitor scelerisque. lectus Ut dolor non Pellentesque eu sem amet, Nam habitant sit libero."
      },
      {
        "api_path": "/a51b3582-d04a-4c74-b1ab-cecc740b386c/f5b9cd3a-7dc7-4cb5-9212-d262f52183fe/062eb737-37c7-48b9-8f10-0e8faeccc9c3/d43cb417-3334-48bb-abf4-5108375bacee/3742b98d-d191-4e11-9848-d6f1ec23855b",
        "api_url": "http://example.com/cf12e953-7067-46f2-8b0b-bb70b9b97c10/985de939-4705-47cd-b7f2-ca449bb72ace#69e8851bdf03b1119d340589f51d12ef",
        "base_path": "/6096ec82-cf24-4ff2-8837-e260f117e296",
        "content_id": "d27693e0-4809-41f9-9719-7f51a1c2db1c",
        "document_type": "a molestie non mauris tristique imperdiet Ut fames lectus morbi dolor turpis leo sed tristique sit ac Nam Lorem Aenean Sed consectetur elit. et est. ultricies pellentesque risus eu suscipit et risus porttitor eu massa ipsum adipiscing tempor dolor purus orci vel at ac nibh Pellentesque finibus, eros. nibh. volutpat Nam habitant",
        "links": {
        },
        "locale": "zh",
        "public_updated_at": null,
        "title": "at ipsum morbi lectus purus elit. ac non sollicitudin egestas. ultricies imperdiet risus molestie Duis Nam eu cursus pellentesque aliquet. nibh tempor in, scelerisque. Quisque orci hendrerit, porttitor Pellentesque tristique interdum. est. habitant Suspendisse dolor vestibulum. volutpat sem Lorem libero. tempor tristique mauris ac risus malesuada vel a adipiscing nibh. ac amet, lorem consectetur suscipit netus dolor sagittis ac non fames Aenean Sed Mauris leo molestie eros. massa bibendum. Ut senectus sit finibus, vel Ut turpis Nam et"
      }
    ],
    "topic_taxonomy_taxons": [

    ]
  },
  "locale": "zh-tw",
  "need_ids": [
    "at vel ac nisl leo eu non adipiscing ipsum Mauris non Lorem sollicitudin in, vel molestie Pellentesque lectus nibh fames Aenean purus hendrerit, aliquet. ultricies habitant finibus, orci Sed dolor risus interdum. a bibendum. Quisque ac suscipit Ut imperdiet netus Suspendisse cursus et risus tempor ac pellentesque sed est. porttitor malesuada Nam tristique turpis dolor massa Duis eros. mauris sem morbi",
    "eros. nisl leo aliquet. lectus netus dolor ac Ut tempor sagittis fames est. imperdiet porttitor tempor amet, scelerisque. ipsum suscipit elit. Nam mauris habitant risus finibus, cursus massa bibendum. tristique vel nibh. libero. non Aenean volutpat consectetur Mauris interdum. eu nibh Quisque sem non lorem ultricies turpis",
    "ac risus ipsum bibendum. pellentesque et dolor ac Mauris scelerisque. vestibulum. Ut Quisque dolor eu a tempor mauris nisl tristique fames interdum. in, libero. molestie Nam sit lectus netus orci suscipit est. leo non porttitor volutpat senectus imperdiet elit. cursus Suspendisse tristique Lorem Duis habitant morbi Sed purus Nam sem risus adipiscing eu egestas. malesuada Aenean sollicitudin lorem consectetur amet, ac sagittis molestie aliquet. sed at eros.",
    "sagittis Ut at morbi Suspendisse finibus, pellentesque volutpat tristique Nam adipiscing turpis molestie nisl vel risus tempor aliquet. dolor tristique lectus est. Mauris elit. ipsum massa ac ac dolor nibh sed suscipit purus Ut eu in, fames bibendum. Sed interdum. Aenean consectetur egestas. eros. amet, libero."
  ],
  "phase": "beta",
  "public_updated_at": "2020-04-21T18:12:44+00:00",
  "publishing_request_id": null,
  "publishing_scheduled_at": null,
  "rendering_app": "search-api",
  "schema_name": "facet",
  "title": "Ut nisl Lorem non ac mauris molestie interdum. ac eu nibh volutpat a adipiscing tempor Quisque vestibulum. Ut sollicitudin egestas. cursus vel bibendum. et molestie sed fames Nam purus malesuada consectetur pellentesque Aenean interdum. tristique dolor est. aliquet. hendrerit, risus ac ultricies nibh. dolor ipsum netus Suspendisse et orci turpis morbi massa Pellentesque Duis ac finibus, libero. tristique porttitor sem scelerisque. suscipit sagittis eu Mauris Nam eros. lorem leo Sed elit. sit senectus non lectus risus amet, at habitant vel in, tempor imperdiet",
  "updated_at": "2020-05-25T18:22:16+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
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
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

{
  "access_limited": {
    "auth_bypass_ids": [
      "641aa7f1-dc94-4100-a085-1b1a8dcfc4c7",
      "fbff856c-20f9-48b0-992c-12b5e210a4a6",
      "693967bc-5c80-4ed0-bdde-6f3e5718517f",
      "46c678dd-20a5-4b00-9a24-058c9c4e2914",
      "06f3303c-37ec-4c77-bdee-9b868ea67b82",
      "65286765-df4f-4c90-89d1-fe59dacad516",
      "489226bb-2451-4933-abec-7468e19a1a41"
    ],
    "users": [
      "sed netus turpis risus sit egestas. senectus tristique dolor molestie massa in, interdum. orci Lorem vel Quisque scelerisque. ac Sed finibus, et ac adipiscing Ut cursus ac dolor elit. Nam ultricies Duis ac libero. lorem malesuada Suspendisse nisl vel Aenean lectus pellentesque a interdum. suscipit Ut aliquet. morbi sem est. Mauris Pellentesque nibh ipsum porttitor eu et sagittis Nam volutpat at fames molestie",
      "vel Ut eu sagittis vestibulum. senectus interdum. Aenean Mauris nibh ac aliquet. turpis sit morbi sed non porttitor finibus, pellentesque consectetur at fames habitant elit. orci dolor tristique tristique hendrerit, non eu tempor interdum. risus tempor ipsum ac netus sollicitudin Duis volutpat imperdiet vel Quisque nibh. in, a lectus mauris cursus Nam Suspendisse Ut eros. leo massa bibendum. ultricies amet, risus est. et dolor malesuada egestas. et lorem molestie Lorem scelerisque. molestie sem nisl purus ac suscipit libero. Pellentesque adipiscing ac Nam Sed"
    ]
  },
  "analytics_identifier": "hendrerit, interdum. molestie egestas. et sed Nam massa risus Mauris lectus scelerisque. purus leo porttitor morbi adipiscing sit Pellentesque Ut libero. Aenean bibendum. dolor eu sollicitudin senectus Duis non volutpat malesuada lorem imperdiet cursus netus ipsum dolor ac suscipit orci fames elit. ultricies sem consectetur in, interdum. pellentesque nibh habitant tristique ac tristique finibus, Ut Lorem vestibulum. ac sagittis non ac et nibh. at Suspendisse Nam risus",
  "change_note": null,
  "description": "vestibulum. suscipit interdum. pellentesque non tempor finibus, eu Nam Quisque nibh. in, amet, libero. sem Ut lectus Sed risus sagittis et ac ipsum ac non adipiscing lorem massa tristique nisl aliquet. nibh",
  "details": {
    "closed_value": "consectetur Lorem Quisque elit. aliquet. senectus cursus a Duis Sed mauris nibh interdum. est. molestie vel ipsum finibus, turpis sit porttitor morbi pellentesque at ac orci bibendum. sagittis et in, ac Ut tempor Nam interdum. ac lectus Suspendisse purus vel sollicitudin scelerisque. ac habitant adipiscing non",
    "combine_mode": "and",
    "filter_value": "sit Mauris est. nibh interdum. molestie interdum. nibh. et morbi purus senectus turpis ac et netus Aenean cursus suscipit ac vel ultricies sem Suspendisse molestie finibus, Quisque bibendum. egestas. Pellentesque sagittis tristique at ac leo hendrerit, porttitor vestibulum. amet, sollicitudin mauris habitant risus aliquet. Nam malesuada orci massa a risus imperdiet adipiscing fames tempor ipsum",
    "filterable": false,
    "key": "Aenean ipsum Suspendisse dolor habitant interdum. eu amet, vel Pellentesque finibus, tempor et tempor suscipit Mauris tristique bibendum. Lorem non ac eros. Quisque sit in, vestibulum. Ut at volutpat aliquet. sem eu sollicitudin tristique consectetur adipiscing leo libero. Nam est. risus ultricies orci sagittis a risus egestas. non massa fames mauris imperdiet nisl morbi porttitor Sed malesuada et nibh. pellentesque ac Duis dolor ac molestie senectus nibh lectus ac scelerisque. netus elit. turpis Ut hendrerit, lorem vel Nam",
    "name": "purus in, fames molestie et hendrerit, non est. aliquet. vel imperdiet risus dolor Quisque nisl",
    "type": "hidden"
  },
  "document_type": "facet",
  "last_edited_at": "2020-02-08T16:17:04+00:00",
  "links": {
    "policy_areas": [
      "b2ef657e-76a0-4274-a242-ea27089930b0"
    ]
  },
  "phase": "live",
  "publishing_app": "email-alert-frontend",
  "schema_name": "facet",
  "title": "vestibulum. Nam eros. bibendum. Pellentesque ultricies interdum. vel Suspendisse tristique massa molestie volutpat tristique Duis habitant leo risus in, fames morbi lorem elit. sagittis non senectus scelerisque. ac at eu adipiscing pellentesque suscipit lectus finibus, imperdiet interdum. Nam ipsum consectetur et orci purus cursus Lorem dolor eu sem porttitor nisl aliquet. egestas. Ut ac netus mauris sit nibh Mauris ac tempor amet,"
}

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

    ]
  }
}