Get the JSON schema

Fetch the configuration schema for query pipelines.

GET /query-pipelines/_schema

Get the JSON schema

Python

import requests

url = "https://{FUSION HOST}/api/query-pipelines/_schema"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "additionalProperties": {},
  "category": "<string>",
  "categoryPriority": 123,
  "default": "<string>",
  "definitions": {},
  "description": "<string>",
  "enum": [
    {}
  ],
  "hints": [
    "<string>"
  ],
  "maxProperties": 123,
  "minProperties": 123,
  "oneOf": [
    {
      "title": "<string>",
      "description": "<string>",
      "default": "<string>",
      "category": "<string>",
      "categoryPriority": 123,
      "hints": [
        "<string>"
      ],
      "unsafe": true,
      "oneOf": [
        {
          "title": "<string>",
          "description": "<string>",
          "default": {},
          "category": "<string>",
          "categoryPriority": 123,
          "hints": [
            "<string>"
          ],
          "unsafe": true
        }
      ]
    }
  ],
  "properties": {},
  "propertyGroups": [
    {
      "label": "<string>",
      "properties": [
        "<string>"
      ]
    }
  ],
  "required": [
    "<string>"
  ],
  "title": "<string>",
  "unsafe": true
}

Authorizations

Basic authAPI key

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200

application/schema+json;qs=1.0

OK

Represents a structured object type definition used in the Experience Manager.

additionalProperties · object

Additional properties that may be included in this object.

category · string

The category classification of this object type.

categoryPriority · integer<int32>

Defines the priority of this object type within its category.

default · string number integer boolean object string[]

Default values for this object type, if applicable.

definitions · object

A collection of definitions related to this object type.

Show child attributes

description · string

A human-readable description of the object type. This value is shown in the field's tooltip in the Rules Editor.

enum · object[]

A list of valid enumeration values for this object type.

hints · string[]

A collection of hints or suggestions related to this object type.

maxProperties · integer<int32>

The maximum number of properties allowed for this object.

minProperties · integer<int32>

The minimum number of properties required for this object.

oneOf · object[]

Defines a set of possible types that this object can be.

Show child attributes

properties · object

A list of properties defined for this object type.

Show child attributes

propertyGroups · object[]

A collection of related property groups for this object type.

Show child attributes

required · string[]

A list of required properties for this object type.

title · string

The user-friendly title of this object type.

type · enum<string>

Defines the primary data type of this object.

Available options: array, boolean, integer, null, number, object, ref, string

unsafe · boolean

Indicates whether this object type is considered unsafe.