GET
/
query-stages
/
schema
/
{type}
Get a JSON schema
curl --request GET \
  --url https://{FUSION HOST}/api/query-stages/schema/{type} \
  --header 'Authorization: Basic <encoded-value>'
{}

Authorizations

​
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

Defines the priority of this object type within its category.

​
default
object

Default values for this object type, if applicable.

​
definitions
object

A collection of definitions related to this object type.

​
description
string

A human-readable description of the object type.

​
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

The maximum number of properties allowed for this object.

​
minProperties
integer

The minimum number of properties required for this object.

​
oneOf
object[]

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

​
properties
object

A list of properties defined for this object type.

​
propertyGroups
object[]

A collection of related property groups for this object type.

​
required
string[]

A list of required properties for this object type.

​
title
string

The 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.