Skip to main content
GET
/
custom-rule-types
/
{id}
Get a custom rule type
import requests

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

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
  }
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
string
required

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

Response

200 - application/json

OK

​
id
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.