Get a JSON schema

Get the JSON schema for a single query stage type.

GET /query-stages/schema/{type}

Get a JSON schema

Python

import requests

url = "https://{FUSION HOST}/api/query-stages/schema/{type}"

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

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

print(response.text)

200

{
  "type": "object",
  "title": "Additional Query Parameters",
  "description": "This stage allows you to set, append, and remove additional query parameters",
  "properties": {
    "skip": {
      "type": "boolean",
      "title": "Skip This Stage",
      "description": "Set to true to skip this stage.",
      "default": false,
      "hints": [
        "advanced"
      ]
    },
    "label": {
      "type": "string",
      "title": "Label",
      "description": "A unique label for this stage.",
      "hints": [
        "advanced"
      ],
      "maxLength": 255
    },
    "condition": {
      "type": "string",
      "title": "Condition",
      "description": "Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.",
      "hints": [
        "code",
        "javascript",
        "advanced"
      ]
    },
    "params": {
      "type": "array",
      "title": "Parameters and Values",
      "items": {
        "type": "object",
        "required": [
          "key"
        ],
        "properties": {
          "key": {
            "type": "string",
            "title": "Parameter Name"
          },
          "value": {
            "type": "string",
            "title": "Parameter Value"
          },
          "policy": {
            "type": "string",
            "title": "Update Policy",
            "enum": [
              "replace",
              "append",
              "remove",
              "default"
            ],
            "default": "append"
          }
        }
      }
    }
  },
  "category": "Advanced",
  "categoryPriority": 2
}

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.

Path Parameters

type · string · required

The query pipeline stage type. Use /query-stages/schema to get the available stage types.

Response

200 - application/json

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.