List all custom rule types

import requests

url = "https://{FUSION HOST}/api/custom-rule-types"

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

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

print(response.text)

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

GET

custom-rule-types

List all custom rule types

import requests

url = "https://{FUSION HOST}/api/custom-rule-types"

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

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

print(response.text)

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

Authorizations

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/json

string

The custom rule type ID. This value must be unique across all apps in Fusion (global namespace).

display_type

string

A user-friendly name for the custom rule type.

pipeline_id

string

The ID of the pipeline that is invoked during rule processing.

schema

Object Type · object

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

Show child attributes

schema.additionalProperties

object

Additional properties that may be included in this object.

schema.category

string

The category classification of this object type.

schema.categoryPriority

integer<int32>

Defines the priority of this object type within its category.

schema.default

Default values for this object type, if applicable.

schema.definitions

object

A collection of definitions related to this object type.

Show child attributes

schema.definitions.{key}

object

Show child attributes

schema.definitions.{key}.type

enum<string>

Available options:

string,

number,

integer,

boolean,

object,

array,

null,

ref

schema.definitions.{key}.title

string

schema.definitions.{key}.description

string

schema.definitions.{key}.default

schema.definitions.{key}.category

string

schema.definitions.{key}.categoryPriority

integer<int32>

schema.definitions.{key}.hints

string[]

schema.definitions.{key}.unsafe

boolean

schema.definitions.{key}.oneOf

object[]

Show child attributes

schema.definitions.{key}.oneOf.type

enum<string>

Available options:

string,

number,

integer,

boolean,

object,

array,

null,

ref

schema.definitions.{key}.oneOf.title

string

schema.definitions.{key}.oneOf.description

string

schema.definitions.{key}.oneOf.default

object

schema.definitions.{key}.oneOf.category

string

schema.definitions.{key}.oneOf.categoryPriority

integer<int32>

schema.definitions.{key}.oneOf.hints

string[]

schema.definitions.{key}.oneOf.unsafe

boolean

schema.description

string

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

schema.enum

object[]

A list of valid enumeration values for this object type.

schema.hints

string[]

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

schema.maxProperties

integer<int32>

The maximum number of properties allowed for this object.

schema.minProperties

integer<int32>

The minimum number of properties required for this object.

schema.oneOf

object[]

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

Show child attributes

schema.oneOf.type

enum<string>

Available options:

string,

number,

integer,

boolean,

object,

array,

null,

ref

schema.oneOf.title

string

schema.oneOf.description

string

schema.oneOf.default

schema.oneOf.category

string

schema.oneOf.categoryPriority

integer<int32>

schema.oneOf.hints

string[]

schema.oneOf.unsafe

boolean

schema.oneOf.oneOf

object[]

Show child attributes

schema.oneOf.oneOf.type

enum<string>

Available options:

string,

number,

integer,

boolean,

object,

array,

null,

ref

schema.oneOf.oneOf.title

string

schema.oneOf.oneOf.description

string

schema.oneOf.oneOf.default

object

schema.oneOf.oneOf.category

string

schema.oneOf.oneOf.categoryPriority

integer<int32>

schema.oneOf.oneOf.hints

string[]

schema.oneOf.oneOf.unsafe

boolean

schema.properties

object

A list of properties defined for this object type.

Show child attributes

schema.properties.{key}

object

Show child attributes

schema.properties.{key}.type

enum<string>

Available options:

string,

number,

integer,

boolean,

object,

array,

null,

ref

schema.properties.{key}.title

string

schema.properties.{key}.description

string

schema.properties.{key}.default

schema.properties.{key}.category

string

schema.properties.{key}.categoryPriority

integer<int32>

schema.properties.{key}.hints

string[]

schema.properties.{key}.unsafe

boolean

schema.properties.{key}.oneOf

object[]

Show child attributes

schema.properties.{key}.oneOf.type

enum<string>

Available options:

string,

number,

integer,

boolean,

object,

array,

null,

ref

schema.properties.{key}.oneOf.title

string

schema.properties.{key}.oneOf.description

string

schema.properties.{key}.oneOf.default

object

schema.properties.{key}.oneOf.category

string

schema.properties.{key}.oneOf.categoryPriority

integer<int32>

schema.properties.{key}.oneOf.hints

string[]

schema.properties.{key}.oneOf.unsafe

boolean

schema.propertyGroups

object[]

A collection of related property groups for this object type.

Show child attributes

schema.propertyGroups.label

string

schema.propertyGroups.properties

string[]

schema.required

string[]

A list of required properties for this object type.

schema.title

string

The user-friendly title of this object type.

schema.type

enum<string>

Defines the primary data type of this object.

Available options:

array,

boolean,

integer,

null,

number,

object,

ref,

string

schema.unsafe

boolean

Indicates whether this object type is considered unsafe.

Delete a custom rule type Create a custom rule type

⌘I

Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

List all custom rule types

Authorizations

Response