REST API Reference for Launch Cloud Service

Create a product rule

post

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagment/v1/productRule

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : ProductRules

Type: object

Title: ProductRules

Discriminator: @type

Discriminator Values

{
    "title":"ProductRules",
    "type":"object",
    "description":"The Product Rule resource represents a set of rules and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30"
        },
        "href":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ]
        },
        "ruleSubType":{
            "type":"string",
            "enum":[
                {
                }
            ]
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "lifecycleStatus":{
            "type":"string"
        },
        "@type":{
            "type":"string"
        },
        "@baseType":{
            "type":"string"
        },
        "@schemaLocation":{
            "type":"string"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "ruleCondition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleConditionOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the product rule"
        },
        "scope":{
            "type":"string",
            "enum":[
                "ALL",
                "BUNDLE",
                "PACKAGE"
            ]
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

The Product Rule resource represents a set of rules and relationships.

Show Source

@baseType: string
@schemaLocation: string
@type(required): string
applicationName: string

name of the external application
created: string (date-time)

Date and time of creation
createdBy: string

name of the person who created
customProfileSpec: array customProfileSpec
description: string
externalId: string

id of the external application
href: string
id: string

Maximum Length: 30
lastUpdate: string (date-time)
lastUpdatedBy: string

name of the person who updated
lifecycleStatus: string
name(required): string
project: object ProjectRef

Title: ProjectRef

Project Reference
ruleCondition: array ruleCondition
ruleSubType: string

Allowed Values: [ { } ]
ruleType: string

Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
scope: string

Allowed Values: [ "ALL", "BUNDLE", "PACKAGE" ]
subject: object SubjectRef

Title: SubjectRef

Subject Reference
version: string
versionState: number

Version state of the product rule

{
    "title":"ProductRules",
    "type":"object",
    "description":"The Product Rule resource represents a set of rules and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30"
        },
        "href":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ]
        },
        "ruleSubType":{
            "type":"string",
            "enum":[
                {
                }
            ]
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "lifecycleStatus":{
            "type":"string"
        },
        "@type":{
            "type":"string"
        },
        "@baseType":{
            "type":"string"
        },
        "@schemaLocation":{
            "type":"string"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "ruleCondition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleConditionOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the product rule"
        },
        "scope":{
            "type":"string",
            "enum":[
                "ALL",
                "BUNDLE",
                "PACKAGE"
            ]
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

Nested Schema : customProfileSpec

Type: array

Show Source

Array of: object CustomProfileSpecRefOracle

Title: CustomProfileSpecRefOracle

Custom Profile specification reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ruleCondition

Type: array

Show Source

Array of: object RuleConditionOracle

Title: RuleConditionOracle

A product rule condition

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuleConditionOracle"
    }
}

Nested Schema : SubjectRef

Type: object

Title: SubjectRef

Subject Reference

Show Source

@baseType: string

Immediate base (class) type of the subject entity
@referredType(required): string

The actual type of the target instance when needed for disambiguation
entityPathExpression: string

Path represent the hierarchy of the component PO within the product offering(offer id along with the associated parents i.e package_Id.bundledPO_Id.atomicOffer_Id),which is used in the runtime system to identify the subject entity that may be used in some other packages.
href: string

Unique reference of the project
id(required): string

Unique identifier of the subject
name: string

Name of the project

{
    "title":"SubjectRef",
    "type":"object",
    "description":"Subject Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the subject"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation"
        },
        "entityPathExpression":{
            "type":"string",
            "description":"Path represent the hierarchy of the component PO within the product offering(offer id along with the associated parents i.e package_Id.bundledPO_Id.atomicOffer_Id),which is used in the runtime system to identify the subject entity that may be used in some other packages."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the subject entity"
        }
    },
    "required":[
        "id",
        "@referredType"
    ]
}

Nested Schema : CustomProfileSpecRefOracle

Type: object

Title: CustomProfileSpecRefOracle

Custom Profile specification reference.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

(Class) type of the referred custom Specification.
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of customSpecificationRef.
href: string

Reference of the custom specification.
id(required): string

Unique identifier of the custom specification.
name: string

Name of the custom specification.
version: string

Version of the custom specification.
versionState: number

To hold the version state for the reference

{
    "title":"CustomProfileSpecRefOracle",
    "type":"object",
    "description":"Custom Profile specification reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the custom specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the custom specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the custom specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the custom specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred custom Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of customSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : RuleConditionOracle

Type: object

Title: RuleConditionOracle

A product rule condition

Show Source

@baseType: string

The immediate base class type of the Product Rule
@schemaLocation: string

A link to the schema describing this Product Rule entity
@type(required): string

the class type of the Product Rule
description: string

A string. Description of the product rule.
id(required): string

A string. Unique identifier of the product rule.
name: string

A string. The name given to the product rule
productRuleExpression: array productRuleExpression
productRuleResult: array productRuleResult
roundingMethod: string

Rounding applicable to the product rule
stringExpression: string

Metering Expression applicable to the product rule
unitOfMeasure: string

Unit of Measure of Rules
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party

{
    "type":"object",
    "title":"RuleConditionOracle",
    "description":"A product rule condition",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the product rule."
        },
        "name":{
            "type":"string",
            "description":"A string. The name given to the product rule"
        },
        "description":{
            "type":"string",
            "description":"A string. Description of the product rule."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "roundingMethod":{
            "type":"string",
            "description":"Rounding applicable to the product rule"
        },
        "stringExpression":{
            "type":"string",
            "description":"Metering Expression applicable to the product rule"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of Measure of Rules"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Product Rule"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the Product Rule"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Product Rule entity"
        },
        "productRuleExpression":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/RuleExpressionOracle"
                    },
                    {
                        "$ref":"#/components/schemas/EntityRuleExpressionOracle"
                    },
                    {
                        "$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
                        "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
                        "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
                    }
                }
            }
        },
        "productRuleResult":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/RuleResultOracle"
                    },
                    {
                        "$ref":"#/components/schemas/RecommendationRuleResultOracle"
                    },
                    {
                        "$ref":"#/components/schemas/MigrationRuleResultOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "RuleResultOracle":"#/components/schemas/RuleResultOracle",
                        "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
                        "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
                    }
                }
            }
        }
    },
    "required":[
        "id",
        "@type"
    ]
}

Nested Schema : productRuleExpression

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle", "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle", "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/RuleExpressionOracle"
            },
            {
                "$ref":"#/components/schemas/EntityRuleExpressionOracle"
            },
            {
                "$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
                "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
                "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
            }
        }
    }
}

Nested Schema : productRuleResult

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "RuleResultOracle":"#/components/schemas/RuleResultOracle", "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle", "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/RuleResultOracle"
            },
            {
                "$ref":"#/components/schemas/RecommendationRuleResultOracle"
            },
            {
                "$ref":"#/components/schemas/MigrationRuleResultOracle"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "RuleResultOracle":"#/components/schemas/RuleResultOracle",
                "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
                "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
            }
        }
    }
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/RuleExpressionOracle"
        },
        {
            "$ref":"#/components/schemas/EntityRuleExpressionOracle"
        },
        {
            "$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
            "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
            "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

RuleResultOracle
RecommendationRuleResultOracle
MigrationRuleResultOracle

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/RuleResultOracle"
        },
        {
            "$ref":"#/components/schemas/RecommendationRuleResultOracle"
        },
        {
            "$ref":"#/components/schemas/MigrationRuleResultOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "RuleResultOracle":"#/components/schemas/RuleResultOracle",
            "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
            "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Your request is successful and a new resource has been created.

Root Schema : ProductRules

Type: object

Title: ProductRules

Discriminator: @type

Discriminator Values

{
    "title":"ProductRules",
    "type":"object",
    "description":"The Product Rule resource represents a set of rules and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30"
        },
        "href":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ]
        },
        "ruleSubType":{
            "type":"string",
            "enum":[
                {
                }
            ]
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "lifecycleStatus":{
            "type":"string"
        },
        "@type":{
            "type":"string"
        },
        "@baseType":{
            "type":"string"
        },
        "@schemaLocation":{
            "type":"string"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "ruleCondition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleConditionOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the product rule"
        },
        "scope":{
            "type":"string",
            "enum":[
                "ALL",
                "BUNDLE",
                "PACKAGE"
            ]
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

The Product Rule resource represents a set of rules and relationships.

Show Source

@baseType: string
@schemaLocation: string
@type(required): string
applicationName: string

name of the external application
created: string (date-time)

Date and time of creation
createdBy: string

name of the person who created
customProfileSpec: array customProfileSpec
description: string
externalId: string

id of the external application
href: string
id: string

Maximum Length: 30
lastUpdate: string (date-time)
lastUpdatedBy: string

name of the person who updated
lifecycleStatus: string
name(required): string
project: object ProjectRef

Title: ProjectRef

Project Reference
ruleCondition: array ruleCondition
ruleSubType: string

Allowed Values: [ { } ]
ruleType: string

Allowed Values: [ "COMPATIBILITY", "ELIGIBILITY", "MIGRATION", "RECOMMENDATION", "CONSTRAINT" ]
scope: string

Allowed Values: [ "ALL", "BUNDLE", "PACKAGE" ]
subject: object SubjectRef

Title: SubjectRef

Subject Reference
version: string
versionState: number

Version state of the product rule

{
    "title":"ProductRules",
    "type":"object",
    "description":"The Product Rule resource represents a set of rules and relationships.",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30"
        },
        "href":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ]
        },
        "ruleSubType":{
            "type":"string",
            "enum":[
                {
                }
            ]
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "lifecycleStatus":{
            "type":"string"
        },
        "@type":{
            "type":"string"
        },
        "@baseType":{
            "type":"string"
        },
        "@schemaLocation":{
            "type":"string"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated"
        },
        "ruleCondition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleConditionOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectRef"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the product rule"
        },
        "scope":{
            "type":"string",
            "enum":[
                "ALL",
                "BUNDLE",
                "PACKAGE"
            ]
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

Nested Schema : customProfileSpec

Type: array

Show Source

Array of: object CustomProfileSpecRefOracle

Title: CustomProfileSpecRefOracle

Custom Profile specification reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
    }
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

Project Reference

Show Source

href: string

Unique reference of the project
id(required): string

Unique identifier of the project
name: string

Name of the project
version: string

Version of the project

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ruleCondition

Type: array

Show Source

Array of: object RuleConditionOracle

Title: RuleConditionOracle

A product rule condition

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuleConditionOracle"
    }
}

Nested Schema : SubjectRef

Type: object

Title: SubjectRef

Subject Reference

Show Source

@baseType: string

Immediate base (class) type of the subject entity
@referredType(required): string

The actual type of the target instance when needed for disambiguation
entityPathExpression: string

Path represent the hierarchy of the component PO within the product offering(offer id along with the associated parents i.e package_Id.bundledPO_Id.atomicOffer_Id),which is used in the runtime system to identify the subject entity that may be used in some other packages.
href: string

Unique reference of the project
id(required): string

Unique identifier of the subject
name: string

Name of the project

{
    "title":"SubjectRef",
    "type":"object",
    "description":"Subject Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the subject"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation"
        },
        "entityPathExpression":{
            "type":"string",
            "description":"Path represent the hierarchy of the component PO within the product offering(offer id along with the associated parents i.e package_Id.bundledPO_Id.atomicOffer_Id),which is used in the runtime system to identify the subject entity that may be used in some other packages."
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the subject entity"
        }
    },
    "required":[
        "id",
        "@referredType"
    ]
}

Nested Schema : CustomProfileSpecRefOracle

Type: object

Title: CustomProfileSpecRefOracle

Custom Profile specification reference.

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@referredType(required): string

(Class) type of the referred custom Specification.
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of customSpecificationRef.
href: string

Reference of the custom specification.
id(required): string

Unique identifier of the custom specification.
name: string

Name of the custom specification.
version: string

Version of the custom specification.
versionState: number

To hold the version state for the reference

{
    "title":"CustomProfileSpecRefOracle",
    "type":"object",
    "description":"Custom Profile specification reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the custom specification."
        },
        "href":{
            "type":"string",
            "description":"Reference of the custom specification."
        },
        "name":{
            "type":"string",
            "description":"Name of the custom specification."
        },
        "version":{
            "type":"string",
            "description":"Version of the custom specification."
        },
        "@referredType":{
            "type":"string",
            "description":"(Class) type of the referred custom Specification."
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of customSpecificationRef."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state for the reference"
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : RuleConditionOracle

Type: object

Title: RuleConditionOracle

A product rule condition

Show Source

@baseType: string

The immediate base class type of the Product Rule
@schemaLocation: string

A link to the schema describing this Product Rule entity
@type(required): string

the class type of the Product Rule
description: string

A string. Description of the product rule.
id(required): string

A string. Unique identifier of the product rule.
name: string

A string. The name given to the product rule
productRuleExpression: array productRuleExpression
productRuleResult: array productRuleResult
roundingMethod: string

Rounding applicable to the product rule
stringExpression: string

Metering Expression applicable to the product rule
unitOfMeasure: string

Unit of Measure of Rules
validFor: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party

{
    "type":"object",
    "title":"RuleConditionOracle",
    "description":"A product rule condition",
    "properties":{
        "id":{
            "type":"string",
            "description":"A string. Unique identifier of the product rule."
        },
        "name":{
            "type":"string",
            "description":"A string. The name given to the product rule"
        },
        "description":{
            "type":"string",
            "description":"A string. Description of the product rule."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "roundingMethod":{
            "type":"string",
            "description":"Rounding applicable to the product rule"
        },
        "stringExpression":{
            "type":"string",
            "description":"Metering Expression applicable to the product rule"
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"Unit of Measure of Rules"
        },
        "@type":{
            "type":"string",
            "description":"the class type of the Product Rule"
        },
        "@baseType":{
            "type":"string",
            "description":"The immediate base class type of the Product Rule"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this Product Rule entity"
        },
        "productRuleExpression":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/RuleExpressionOracle"
                    },
                    {
                        "$ref":"#/components/schemas/EntityRuleExpressionOracle"
                    },
                    {
                        "$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
                        "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
                        "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
                    }
                }
            }
        },
        "productRuleResult":{
            "type":"array",
            "items":{
                "anyOf":[
                    {
                        "$ref":"#/components/schemas/RuleResultOracle"
                    },
                    {
                        "$ref":"#/components/schemas/RecommendationRuleResultOracle"
                    },
                    {
                        "$ref":"#/components/schemas/MigrationRuleResultOracle"
                    }
                ],
                "discriminator":{
                    "propertyName":"@type",
                    "mapping":{
                        "RuleResultOracle":"#/components/schemas/RuleResultOracle",
                        "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
                        "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
                    }
                }
            }
        }
    },
    "required":[
        "id",
        "@type"
    ]
}

Nested Schema : productRuleExpression

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle", "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle", "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/RuleExpressionOracle"
            },
            {
                "$ref":"#/components/schemas/EntityRuleExpressionOracle"
            },
            {
                "$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
                "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
                "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
            }
        }
    }
}

Nested Schema : productRuleResult

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "RuleResultOracle":"#/components/schemas/RuleResultOracle", "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle", "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/RuleResultOracle"
            },
            {
                "$ref":"#/components/schemas/RecommendationRuleResultOracle"
            },
            {
                "$ref":"#/components/schemas/MigrationRuleResultOracle"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "RuleResultOracle":"#/components/schemas/RuleResultOracle",
                "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
                "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
            }
        }
    }
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

RuleExpressionOracle
EntityRuleExpressionOracle
EligibilityRuleExpressionOracle

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/RuleExpressionOracle"
        },
        {
            "$ref":"#/components/schemas/EntityRuleExpressionOracle"
        },
        {
            "$ref":"#/components/schemas/EligibilityRuleExpressionOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle",
            "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle",
            "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle"
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

RuleResultOracle
RecommendationRuleResultOracle
MigrationRuleResultOracle

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/RuleResultOracle"
        },
        {
            "$ref":"#/components/schemas/RecommendationRuleResultOracle"
        },
        {
            "$ref":"#/components/schemas/MigrationRuleResultOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "RuleResultOracle":"#/components/schemas/RuleResultOracle",
            "RecommendationRuleResultOracle":"#/components/schemas/RecommendationRuleResultOracle",
            "MigrationRuleResultOracle":"#/components/schemas/MigrationRuleResultOracle"
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

Examples

The following examples show how to create a product rule by submitting a POST request on the REST resource using cURL.

Compatibility product rule

cURL Command

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule \ -H 'Content-Type: application/json' -D @productrule_create.json | json_pp

Example of Request Body

The following shows an example of creating a product rule based on compatibility rule in JSON format.

{
    "id": "RULE-CP-4055990588-17296789138",
    "name": "Sleek Protective Mustang 11 Max CR",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRule/RULE-CP-4055990588-17296789138",
    "lifecycleStatus": "In design",
    "ruleType": "COMPATIBILITY",
    "@type": "ProductRuleOracle",
    "version": "1.0",
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "subject": {
        "id": "PO-SLK-M11-MAX-CASE",
        "name": "Sleek Protective Mustang 11 Max Case",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO-SLK-M11-MAX-CASE",
        "@referredType": "ProductOfferingOracle",
        "@type": "SubjectRef",
        "@baseType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "id": "Condition1",
            "name": "Rule condition1",
            "description": "Rule condition1",
            "stringExpression": "REQUIRES ENTITY(PO-Mustang11Max,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "@type": "RuleConditionOracle",
            "productRuleExpression": [
                {
                    "id": "OPERANDNODE1",
                    "expressionType": "ENTITY",
                    "value": "PO-Mustang11Max",
                    "@type": "EntityRuleExpressionOracle",
                    "valueType": "PRODUCT_OFFERING",
                    "productRuleExpressionRelationship": {
                        "id": "REQUIRES_OPERANDNODE1",
                        "name": "RHS of (REQUIRES_OPERANDNODE1)",
                        "relationshipType": "RIGHT_HAND_SIDE",
                        "@type": "ProductRuleExprRelationshipOracle"
                    }
                },
                {
                    "id": "REQUIRES_OPERANDNODE1",
                    "operator": "REQUIRES",
                    "expressionType": "UNARY",
                    "@type": "RuleExpressionOracle"
                }
            ]
        }
    ],
    "scope": "ALL"
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "id": "RULE-CP-4055990588-17296789138",
    "name": "Sleek Protective Mustang 11 Max CR",
    "href": "https://cptbbwiqy.fusionapps.ocs.oc-test.com:443/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRule/RULE-CP-4055990588-17296789138",
    "lifecycleStatus": "In design",
    "ruleType": "COMPATIBILITY",
    "@type": "ProductRuleOracle",
    "created": "2025-02-17T12:01:50.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T12:01:50.098Z",
    "lastUpdatedBy": "booth",
    "version": "1.0",
    "versionState": 0,
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "href": "https://cptbbwiqy.fusionapps.ocs.oc-test.com/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "subject": {
        "id": "PO-SLK-M11-MAX-CASE",
        "name": "Sleek Protective Mustang 11 Max Case",
        "href": "https://cptbbwiqy.fusionapps.ocs.oc-test.com/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO-SLK-M11-MAX-CASE",
        "@referredType": "ProductOfferingOracle",
        "@type": "SubjectRef",
        "@baseType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "id": "Condition1",
            "name": "Rule condition1",
            "description": "Rule condition1",
            "stringExpression": "REQUIRES ENTITY(PO-Mustang11Max,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "@type": "RuleConditionOracle",
            "productRuleExpression": [
                {
                    "id": "REQUIRES_OPERANDNODE1",
                    "operator": "REQUIRES",
                    "expressionType": "UNARY",
                    "@type": "RuleExpressionOracle"
                },
                {
                    "id": "OPERANDNODE1",
                    "expressionType": "ENTITY",
                    "value": "PO-Mustang11Max",
                    "@type": "EntityRuleExpressionOracle",
                    "valueType": "PRODUCT_OFFERING",
                    "productRuleExpressionRelationship": {
                        "id": "REQUIRES_OPERANDNODE1",
                        "name": "RHS of (REQUIRES_OPERANDNODE1)",
                        "relationshipType": "RIGHT_HAND_SIDE",
                        "@type": "ProductRuleExprRelationshipOracle"
                    }
                }
            ]
        }
    ],
    "scope": "ALL"
}

Recommendation product rule

cURL Command

curl curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule \ -H 'Content-Type: application/json' -D @create_productrule.json | json_pp

Example of Request Body

The following shows an example of creating a product rule based on compatibility rule in JSON format.

{
    "id": "RULE-RC-675598761-172967838164",
    "name": "Mustang 11 Upsell Rule2",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRule/RULE-RC-675598761-172967838164",
    "lifecycleStatus": "Ready to publish",
    "ruleType": "RECOMMENDATION",
    "@type": "ProductRuleOracle",
    "version": "1.0",
    "subject": {
        "id": "PO-Mustang11",
        "name": "Mustang 11",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO-Mustang11",
        "versionState": -1,
        "@referredType": "ProductOfferingOracle",
        "@type": "SubjectRef",
        "@baseType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "id": "Condition1",
            "name": "Rule condition1",
            "description": "Rule condition1",
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "@type": "RuleConditionOracle",
            "productRuleResult": [
                {
                    "id": "CR-3236288663-1729678381843",
                    "value": "PO-Mustang11Pro",
                    "valueType": "PRODUCT_OFFERING",
                    "@type": "RecommendationRuleResultOracle",
                    "message": "Upsell to Mustang 11 Pro",
                    "score": 8,
                    "messageType": "UPSELL_RECOMMEND"
                }
            ]
        }
    ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "id": "RULE-RC-675598761-172967838164",
    "name": "Mustang 11 Upsell Rule2",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRule/RULE-RC-675598761-172967838164",
    "lifecycleStatus": "In design",
    "ruleType": "RECOMMENDATION",
    "@type": "ProductRuleOracle",
    "created": "2025-02-17T12:17:13.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T12:17:13.073Z",
    "lastUpdatedBy": "booth",
    "version": "1.0",
    "versionState": 0,
    "subject": {
        "id": "PO-Mustang11",
        "name": "Mustang 11",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO-Mustang11",
        "versionState": -1,
        "@referredType": "ProductOfferingOracle",
        "@type": "SubjectRef",
        "@baseType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "id": "Condition1",
            "name": "Rule condition1",
            "description": "Rule condition1",
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "@type": "RuleConditionOracle",
            "productRuleResult": [
                {
                    "id": "CR-3236288663-1729678381843",
                    "value": "PO-Mustang11Pro",
                    "valueType": "PRODUCT_OFFERING",
                    "@type": "RecommendationRuleResultOracle",
                    "message": "Upsell to Mustang 11 Pro",
                    "score": 8,
                    "messageType": "UPSELL_RECOMMEND"
                }
            ]
        }
    ]
}

Migration product rule

cURL Command

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule \ -H 'Content-Type: application/json' -D create_productrule.json | json_pp

Example of Request Body

The following shows an example of creating a product rule based on compatibility rule in JSON format.

{
      "id": "RULE-MG-1331982568-17296782301",
      "name": "Supremo 5G Unlimited to Supremo 5G Premium",
      "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRule/RULE-MG-1331982568-17296782301",
      "lifecycleStatus": "Ready to publish",
      "ruleType": "MIGRATION",
      "@type": "ProductRuleOracle",
      "created": "2025-01-20T13:37:18.000Z",
      "createdBy": "booth",
      "lastUpdate": "2025-01-30T08:49:30.518Z",
      "lastUpdatedBy": "booth",
      "version": "1.0",
      "versionState": 0,
      "subject": {
        "id": "PO-SUP-5G-UNLMTD-PACK",
        "name": "Supremo 5G Unlimited",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO-SUP-5G-UNLMTD-PACK",
        "versionState": -1,
        "@referredType": "ProductOfferingOracle",
        "@type": "SubjectRef",
        "@baseType": "ProductOfferingOracle"
      },
      "ruleCondition": [
        {
          "id": "MG-GRP-1637325533-172967823039",
          "name": "MG-GRP-1637325533-172967823039",
          "description": "MG-GRP-1637325533-172967823039",
          "stringExpression": "UPG_FRM ENTITY(PO-SUP-5G-PREM-PACK,ProductOfferingOracle)",
          "validFor": {
            "startDateTime": "2024-09-03T00:00:00.000Z"
          },
          "@type": "RuleConditionOracle",
          "productRuleExpression": [
            {
              "id": "OPERANDNODE1",
              "expressionType": "ENTITY",
              "value": "PO-SUP-5G-PREM-PACK",
              "@type": "EntityRuleExpressionOracle",
              "valueType": "PRODUCT_OFFERING",
              "productRuleExpressionRelationship": {
                "id": "UPG_FRM_OPERANDNODE1",
                "name": "RHS of (UPG_FRM_OPERANDNODE1)",
                "relationshipType": "RIGHT_HAND_SIDE",
                "@type": "ProductRuleExprRelationshipOracle"
              }
            },
            {
              "id": "UPG_FRM_OPERANDNODE1",
              "operator": "UPG_FRM",
              "expressionType": "UNARY",
              "@type": "RuleExpressionOracle"
            }
          ],
          "productRuleResult": [
            {
              "duration": "ORIGINAL_DURATION",
              "id": "Result-468685504-1729678285178",
              "@type": "MigrationRuleResultOracle",
              "productOfferingPrice": [
                {
                  "id": "MG_PP-11441434-1729678284326",
                  "name": "MG_PP-11441434-1729678284326",
                  "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/MG_PP-11441434-1729678284326",
                  "versionState": -1,
                  "@referredType": "ProductOfferingPriceOracle",
                  "@type": "ProductOfferingPriceRef",
                  "@baseType": "ProductOfferingPriceOracle"
                }
              ]
            }
          ]
        }
      ]
    }

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "id": "RULE-MG-1331982568-17296782301",
    "name": "Supremo 5G Unlimited to Supremo 5G Premium",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRule/RULE-MG-1331982568-17296782301",
    "lifecycleStatus": "In design",
    "ruleType": "MIGRATION",
    "@type": "ProductRuleOracle",
    "created": "2025-02-17T12:11:54.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T12:11:54.215Z",
    "lastUpdatedBy": "booth",
    "version": "1.0",
    "versionState": 0,
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "subject": {
        "id": "PO-SUP-5G-UNLMTD-PACK",
        "name": "Supremo 5G Unlimited",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOffering/PO-SUP-5G-UNLMTD-PACK",
        "versionState": -1,
        "@referredType": "ProductOfferingOracle",
        "@type": "SubjectRef",
        "@baseType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "id": "MG-GRP-1637325533-172967823039",
            "name": "MG-GRP-1637325533-172967823039",
            "description": "MG-GRP-1637325533-172967823039",
            "stringExpression": "UPG_FRM ENTITY(PO-SUP-5G-PREM-PACK,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2024-09-03T00:00:00.000Z"
            },
            "@type": "RuleConditionOracle",
            "productRuleExpression": [
                {
                    "id": "UPG_FRM_OPERANDNODE1",
                    "operator": "UPG_FRM",
                    "expressionType": "UNARY",
                    "@type": "RuleExpressionOracle"
                },
                {
                    "id": "OPERANDNODE1",
                    "expressionType": "ENTITY",
                    "value": "PO-SUP-5G-PREM-PACK",
                    "@type": "EntityRuleExpressionOracle",
                    "valueType": "PRODUCT_OFFERING",
                    "productRuleExpressionRelationship": {
                        "id": "UPG_FRM_OPERANDNODE1",
                        "name": "RHS of (UPG_FRM_OPERANDNODE1)",
                        "relationshipType": "RIGHT_HAND_SIDE",
                        "@type": "ProductRuleExprRelationshipOracle"
                    }
                }
            ],
            "productRuleResult": [
                {
                    "duration": "ORIGINAL_DURATION",
                    "id": "Result-468685504-1729678285178",
                    "@type": "MigrationRuleResultOracle",
                    "productOfferingPrice": [
                        {
                            "id": "MG_PP-11441434-1729678284326",
                            "name": "MG_PP-11441434-1729678284326",
                            "version": "1.0",
                            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productOfferingPrice/MG_PP-11441434-1729678284326",
                            "versionState": -1,
                            "@referredType": "ProductOfferingPriceOracle",
                            "@type": "ProductOfferingPriceRef",
                            "@baseType": "ProductOfferingPriceOracle"
                        }
                    ]
                }
            ]
        }
    ]
}