Admin
Apps Manager
Async Parsing
Connectors
Indexing
Job Config
Job Launcher
Job Rest Server
ML Model Service
Proxy
Query
Templating
import requests
url = "https://{FUSION HOST}/api/custom-rule-types"
payload = {
"id": "custom-rule-type",
"pipeline_id": "custom-rule-pipeline",
"display_type": "My Custom Rule",
"schema": {
"type": "object",
"properties": {
"custom_param1": {
"type": "string",
"title": "Manufacturer",
"description": "The manufacturer of the product this rule action applies to."
},
"custom_param2": {
"type": "string",
"title": "Type",
"description": "The type of product this rule action applies to."
}
}
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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
}
}Create a custom rule type
The request is a JSON body defining the new custom rule type.
import requests
url = "https://{FUSION HOST}/api/custom-rule-types"
payload = {
"id": "custom-rule-type",
"pipeline_id": "custom-rule-pipeline",
"display_type": "My Custom Rule",
"schema": {
"type": "object",
"properties": {
"custom_param1": {
"type": "string",
"title": "Manufacturer",
"description": "The manufacturer of the product this rule action applies to."
},
"custom_param2": {
"type": "string",
"title": "Type",
"description": "The type of product this rule action applies to."
}
}
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, 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
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
The app to which this object belongs, as app:SomeApp.
Body
The custom rule type ID. This value must be unique across all apps in Fusion (global namespace).
A user-friendly name for the custom rule type.
The ID of the pipeline that is invoked during rule processing.
Represents a structured object type definition used in the Experience Manager.
Show child attributes
Show child attributes
Additional properties that may be included in this object.
The category classification of this object type.
Defines the priority of this object type within its category.
Default values for this object type, if applicable.
A collection of definitions related to this object type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref A human-readable description of the object type. This value is shown in the field's tooltip in the Rules Editor.
A list of valid enumeration values for this object type.
A collection of hints or suggestions related to this object type.
The maximum number of properties allowed for this object.
The minimum number of properties required for this object.
Defines a set of possible types that this object can be.
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref A list of properties defined for this object type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref A list of required properties for this object type.
The user-friendly title of this object type.
Defines the primary data type of this object.
array, boolean, integer, null, number, object, ref, string Indicates whether this object type is considered unsafe.
Response
OK
The custom rule type ID. This value must be unique across all apps in Fusion (global namespace).
A user-friendly name for the custom rule type.
The ID of the pipeline that is invoked during rule processing.
Represents a structured object type definition used in the Experience Manager.
Show child attributes
Show child attributes
Additional properties that may be included in this object.
The category classification of this object type.
Defines the priority of this object type within its category.
Default values for this object type, if applicable.
A collection of definitions related to this object type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref A human-readable description of the object type. This value is shown in the field's tooltip in the Rules Editor.
A list of valid enumeration values for this object type.
A collection of hints or suggestions related to this object type.
The maximum number of properties allowed for this object.
The minimum number of properties required for this object.
Defines a set of possible types that this object can be.
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref A list of properties defined for this object type.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref Show child attributes
Show child attributes
string, number, integer, boolean, object, array, null, ref A list of required properties for this object type.
The user-friendly title of this object type.
Defines the primary data type of this object.
array, boolean, integer, null, number, object, ref, string Indicates whether this object type is considered unsafe.
Was this page helpful?