Get zones schema

Get zones schema

import requests

url = "https://{FUSION_HOST.com}/api/templating/zones/_schema"

response = requests.get(url)

print(response.text)

{
  "type": "Templating Zone",
  "title": "Templating Template",
  "description": "Stores configuration of the templates.",
  "properties": {
    "dirty": true,
    "metadata": {},
    "neverPublished": false,
    "isStaging": true,
    "isPublished": true,
    "inTemplates": [
      "e123f4bc-5e7e-46dd-9be8-71a4f73e511a, 8084969c-bd23-40f7-9acf-c68d6798bec2, 441eb3be-7de6-470a-8141-e416a15c7db1, fb148491-b39e-46d1-af33-44cd964d8ee0"
    ],
    "name": "Results List",
    "id": "6a163bd4-5098-466c-22aa-40bf68294303",
    "type": "result-list",
    "tags": [
      "zones-controller"
    ],
    "isOmitFilters": false,
    "queryProfile": "query-profile",
    "uiTreatment": "<string>"
  },
  "category": "<string>",
  "categoryPriority": 123,
  "unsafe": true
}

GET

zones

_schema

Get zones schema

import requests

url = "https://{FUSION_HOST.com}/api/templating/zones/_schema"

response = requests.get(url)

print(response.text)

{
  "type": "Templating Zone",
  "title": "Templating Template",
  "description": "Stores configuration of the templates.",
  "properties": {
    "dirty": true,
    "metadata": {},
    "neverPublished": false,
    "isStaging": true,
    "isPublished": true,
    "inTemplates": [
      "e123f4bc-5e7e-46dd-9be8-71a4f73e511a, 8084969c-bd23-40f7-9acf-c68d6798bec2, 441eb3be-7de6-470a-8141-e416a15c7db1, fb148491-b39e-46d1-af33-44cd964d8ee0"
    ],
    "name": "Results List",
    "id": "6a163bd4-5098-466c-22aa-40bf68294303",
    "type": "result-list",
    "tags": [
      "zones-controller"
    ],
    "isOmitFilters": false,
    "queryProfile": "query-profile",
    "uiTreatment": "<string>"
  },
  "category": "<string>",
  "categoryPriority": 123,
  "unsafe": true
}

Response

type

string

default:object

The type of object returned in the response.

Example:

"Templating Zone"

title

string

Description of what is returned in the schema response.

Example:

"Templating Template"

description

string

Description of the information stored in the schema.

Example:

"Stores configuration of the templates."

properties

object

Properties stored in the schema.

Show child attributes

properties.dirty

boolean

The status of the template. If false, the template is published. If true, this is the staging version of this template and it contains changes that have not yet been published.

properties.metadata

object

Additional data associated with this zone.

properties.neverPublished

boolean

default:false

The status of the zone. If false, the zone has been published at some point. If true, this zone has never been published.

properties.isStaging

boolean

This field indicates if the zone is published or unpublished (staging). If set to false, the zone is published. If set to true, the zone is unpublished (staging).

properties.isPublished

boolean

This field indicates if the template is a published template. If true, this template has a status of published. If false, this template is not a template with a status of published.

properties.inTemplates

string[]

IDs of the staging and/or published templates in which this zone appears. The IDs are not displayed in any particular order. The staging and published boolean fields specify if that type of template ID is returned in this field.

The IDs are listed in the items field.

properties.name

string

The name of the zone that contains the specified query profiles to search in the query.

Example:

"Results List"

properties.id

string<uuid>

The universal unique identifier (UUID) of the zone.

Example:

"6a163bd4-5098-466c-22aa-40bf68294303"

properties.type

string

Read-only value that classifies the zone in the Fusion Predictive Merchandiser UI. This value does not affect the triggering/rendering logic.

Example:

"result-list"

properties.tags

string[]

The tags to pass to the query profile during the operation (GET, POST, PUT, DELETE). This data is combined with tags send in the request paramaters.

properties.isOmitFilters

boolean

default:false

Specifies whether to include filters fq parameters in the search. If set to Off, all query parameters in the original request are passed on to the defined query profile when a template is being rendered. If set to On, all filters (fq parameters) from the original request are omitted from the query to the query profile. For example, if you have a category landing page where the category is used to filter the displayed items, this setting can allow a zone to display items outside of that category (by omitting the category filter).

properties.queryProfile

string

The query profile for this zone, that designates the endpoint that is searched.

Example:

"query-profile"

properties.uiTreatment

string

Text included in the response for this zone. If the user interface (UI) is configured to use the zone, the text in this field can be used to influence how the zone is displayed or processed in the UI.

Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

Response