REST API Reference for Launch Cloud Service

Create or update an array of product rules

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/productRules

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 50

Show Source

Array of: object ProductRules

Title: ProductRules

Discriminator: { "propertyName":"@type", "mapping":{ } }

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductRuleOracle"
    },
    "minItems":"1",
    "maxItems":"50"
}

Nested 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

200 Response

Your request is successful and the resources have been created or updated.

Root Schema : schema

Type: array

Show Source

Array of: object ProductRules

Title: ProductRules

Discriminator: { "propertyName":"@type", "mapping":{ } }

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

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

Nested 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 : schema

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }

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

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

Error
BulkError

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "$ref":"#/components/schemas/BulkError"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error",
            "BulkError":"#/components/schemas/BulkError"
        }
    }
}

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 example shows how to create or update an array of product rules by submitting a PUT request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

[
{
    "id": "RECOMMEDTESTQARULE020",
    "name": "RECOMMENDTESTQA-RULE-020",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "ruleType": "RECOMMENDATION",
    "description" : "12345Test",
    "project": {
        "name": "Test 22A Project",
        "id": "Test22AProject"
    },
    "subject": {
        "id": "Oracle_CHEN02021",
        "name": "Oracle_CHEN02021",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "validFor": {
                "endDateTime": "2023-03-31T00:00:00.000Z"
            },
            "description": "Rule condition1",
            "name": "Rule condition1",
            "id": "Condition1",
            "productRuleResult": [
                {
                    "id": "Result001",
                    "value": "Oracle_CHEN02022",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "UPSELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for iPhone12 device update",
                    "@type": "RecommendationRuleResultOracle"
                },
                {
                    "id": "Result002",
                    "value": "Oracle_CHEN02024",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "CROSS_SELL_RECOMMEND",
                    "score": 5,
                    "message": "Recommended for Apple device update",
                    "@type": "RecommendationRuleResultOracle"
                }
            ]
        }
    ]
},
{
    "id": "RECOMMEDTESTQARULE021",
    "name": "RECOMMENDTESTQA-RULE-021",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "ruleType": "RECOMMENDATION",
    "description" : "12345Test",
    "project": {
        "name": "Test 22A Project",
        "id": "Test22AProject"
    },
    "subject": {
        "id": "Oracle_CHEN02021",
        "name": "Oracle_CHEN02021",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "validFor": {
                "endDateTime": "2023-03-31T00:00:00.000Z"
            },
            "description": "Rule condition1",
            "name": "Rule condition1",
            "id": "Condition1",
            "productRuleResult": [
                {
                    "id": "Result001",
                    "value": "Oracle_CHEN02022",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "UPSELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for iPhone12 device update",
                    "@type": "RecommendationRuleResultOracle"
                },
                {
                    "id": "Result002",
                    "value": "Oracle_CHEN02024",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "CROSS_SELL_RECOMMEND",
                    "score": 9,
                    "message": "Recommended for Apple device update",
                    "@type": "RecommendationRuleResultOracle"
                }
            ]
        }
    ]
}
]

Example of Response Body

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

[
   {
       "id": "RECOMMEDTESTQARULE020",
       "name": "RECOMMENDTESTQA-RULE-020",
       "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule/RECOMMEDTESTQARULE020",
       "lifecycleStatus": "In design",
       "version": "1.0",
       "created": "2021-10-04T21:25:04.000Z",
       "createdBy": "booth",
       "lastUpdate": "2021-10-06T17:30:44.823Z",
       "lastUpdatedBy": "booth",
       "ruleType": "RECOMMENDATION",
       "description" : "12345Test",
       "project": {
           "name": "Test 22A Project",
           "id": "Test22AProject",
           "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/Test 22A Project"
       },
       "subject": {
           "id": "Oracle_CHEN02021",
           "name": "Oracle_CHEN02021",
           "@referredType": "ProductOfferingOracle",
           "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/Oracle_CHEN02021"
 
       },
       "ruleCondition": [
           {
               "validFor": {
                   "endDateTime": "2023-03-31T00:00:00.000Z"
               },
               "description": "Rule condition1",
               "name": "Rule condition1",
               "id": "Condition1",
               "productRuleResult": [
                   {
                       "id": "Result001",
                       "value": "Oracle_CHEN02022",
                       "valueType": "PRODUCT_OFFERING",
                       "messageType": "UPSELL_RECOMMEND",
                       "score": 1,
                       "message": "Recommended for iPhone12 device update",
                       "@type": "RecommendationRuleResultOracle"
                   },
                   {
                       "id": "Result002",
                       "value": "Oracle_CHEN02024",
                       "valueType": "PRODUCT_OFFERING",
                       "messageType": "CROSS_SELL_RECOMMEND",
                       "score": 5,
                       "message": "Recommended for Apple device update",
                       "@type": "RecommendationRuleResultOracle"
                   }
               ]
           }
       ]
   },
   {
       "id": "RECOMMEDTESTQARULE021",
       "name": "RECOMMENDTESTQA-RULE-021",
       "lifecycleStatus": "In design",
       "created": "2021-10-04T21:25:04.000Z",
       "createdBy": "booth",
       "lastUpdate": "2021-10-06T17:30:44.823Z",
       "lastUpdatedBy": "booth",
       "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule/RECOMMEDTESTQARULE021",
       "version": "1.0",
       "ruleType": "RECOMMENDATION",
       "description" : "12345Test",
       "project": {
           "name": "Test 22A Project",
           "id": "Test22AProject",
           "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/RECOMMEDTESTQARULE021"
 
       },
       "subject": {
           "id": "Oracle_CHEN02021",
           "name": "Oracle_CHEN02021",
           "@referredType": "ProductOfferingOracle",
           "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/Oracle_CHEN02021"
       },
       "ruleCondition": [
           {
               "validFor": {
                   "endDateTime": "2023-03-31T00:00:00.000Z"
               },
               "description": "Rule condition1",
               "name": "Rule condition1",
               "id": "Condition1",
               "productRuleResult": [
                   {
                       "id": "Result001",
                       "value": "Oracle_CHEN02022",
                       "valueType": "PRODUCT_OFFERING",
                       "messageType": "UPSELL_RECOMMEND",
                       "score": 1,
                       "message": "Recommended for iPhone12 device update",
                       "@type": "RecommendationRuleResultOracle"
                   },
                   {
                       "id": "Result002",
                       "value": "Oracle_CHEN02024",
                       "valueType": "PRODUCT_OFFERING",
                       "messageType": "CROSS_SELL_RECOMMEND",
                       "score": 9,
                       "message": "Recommended for Apple device update",
                       "@type": "RecommendationRuleResultOracle"
                   }
               ]
           }
       ]
   }
   ]

Recommendation product rule

cURL Command

curl -u username:password -X PUT \ 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule -H 'Content-Type: application/json' -D @put_recommendproductrule.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": "RECOMMENDRULE001",
    "name": "RECOMMEND-RULE-001",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "ruleType": "RECOMMENDATION",
    "subject": {
        "id": "iPhone12Pro",
        "name": "iPhone12 Pro",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "validFor": {
                "startDateTime": "2022-02-01T00:00:00.000Z",
                "endDateTime": "2023-03-31T00:00:00.000Z"
            },
            "description": "Rule condition1",
            "name": "Rule condition1",
            "id": "Condition1",
            "productRuleResult": [
                {
                    "id": "Result001",
                    "value": "iPhoneProMaxCre234455",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "UPSELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for iPhone12 device",
                    "@type": "RecommendationRuleResultOracle"
                },
                {
                    "id": "Result002",
                    "value": "Apple-redwood",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "CROSS_SELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for Apple device",
                    "@type": "RecommendationRuleResultOracle"
                }
            ]
        }
    ]
}

Example of Response Body

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

{
    "id": "RECOMMENDRULE001",
    "name": "RECOMMEND-RULE-001",
    "lifecycleStatus": "In design",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule/RECOMMENDRULE001",
     "version": "1.0",
   "created": "2021-08-30T06:30:50.000Z",
   "createdBy": "booth",
   "lastUpdate": "2021-08-31T12:21:12.377Z",
   "lastUpdatedBy": "booth",      "ruleType": "RECOMMENDATION",
    "subject": {
        "id": "iPhone12Pro",
        "name": "iPhone12 Pro",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "validFor": {
                "startDateTime": "2022-02-01T00:00:00.000Z",
                "endDateTime": "2023-03-31T00:00:00.000Z"
            },
            "description": "Rule condition1",
            "name": "Rule condition1",
            "id": "Condition1",
            "productRuleResult": [
                {
                    "id": "Result001",
                    "value": "iPhoneProMaxCre234455",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "UPSELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for iPhone12 device",
                    "@type": "RecommendationRuleResultOracle"
                },
                {
                    "id": "Result002",
                    "value": "Apple-redwood",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "CROSS_SELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for Apple device",
                    "@type": "RecommendationRuleResultOracle"
                }
            ]
        }
    ]
}

Migration product rule

cURL Command

curl -u username:password -X PUT \ 'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule' -H 'Content-Type: application/json' -D @put_migrateproductrule.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-2428711991-16303049976",
   "name": "Migration3008"
   "lifecycleStatus": "In design",
   "ruleType": "MIGRATION",
   "@type": "ProductRuleOracle",
   "version": "1.0",
   "subject": {
       "id": "ID-2748943967-1630348319691",
       "name": "Test30Aug",
        
       "@referredType": "ProductOfferingOracle"
   },
   "ruleCondition": [
       {
             
           "stringExpression": "UPG_TO ENTITY(Oracle_DPFTEB6S,ProductOfferingOracle)",
           "description": "Rule Condition1",
           "name": "Rule Condition1",
           "id": "Condition1"
       },
       {
           "productRuleResult": [
               {
                   "@type": "MigrationRuleResultOracle",
                   "productOfferingPrice": [
                       {
                           "id": "MG_PP-1245125592-1630339279419",
                           "name": "MG_PP-1245125592-1630339279419",
                            
                           "@referredType": "ProductOfferingPriceOracle",
                           "@type": "ProductOfferingPriceRef",
                           "@baseType": "ProductOfferingPriceOracle"
                       },
                       {
                           "id": "MG_PP-3357907241-1630339279419",
                           "name": "MG_PP-3357907241-1630339279419",
                          
                           "@referredType": "ProductOfferingPriceOracle",
                           "@type": "ProductOfferingPriceRef",
                           "@baseType": "ProductOfferingPriceOracle"
                       }
                   ],
                   "duration": "ORIGINAL_DURATION",
                   "id": "Result-1590826115-163041247168"
               }
           ],
           "validFor": {
               "startDateTime": "2021-08-30T00:00:00.000Z",
               "endDateTime": "2021-09-02T23:59:55.000Z"
           },
           "description": "MG-GRP-2293485690-163030499981",
           "name": "MG-GRP-2293485690-163030499981",
           "id": "MG-GRP-2293485690-163030499981"
       },
       {
           "productRuleResult": [
               {
                   "@type": "MigrationRuleResultOracle",
                   "commitmentStart": "ORIGINAL_END",
                   "duration": "NEW_DURATION",
                   "id": "Result-1476786685-163041247168"
               }
           ],
           "validFor": {
               "startDateTime": "2021-09-03T00:00:00.000Z",
               "endDateTime": "2021-09-30T00:00:00.000Z"
           },
           "description": "MG-GRP-1709107837-163033923660",
           "name": "MG-GRP-1709107837-163033923660",
           "id": "MG-GRP-1709107837-163033923660"
       }
   ],
   "project": {
       "id": "Summer-Initiative",
       "name": "Summer Initiative",
        
   }
}

Example of Response Body

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

{
   "id": "RULE-MG-2428711991-16303049976",
   "name": "Migration3008",
   "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule/RULE-MG-2428711991-16303049976",
   "lifecycleStatus": "In design",
   "ruleType": "MIGRATION",
   "@type": "ProductRuleOracle",
   "created": "2021-08-30T06:30:50.000Z",
   "createdBy": "booth",
   "lastUpdate": "2021-08-31T12:21:12.377Z",
   "lastUpdatedBy": "booth",
   "version": "1.0",
   "subject": {
       "id": "ID-2748943967-1630348319691",
       "name": "Test30Aug",
       "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/ID-2748943967-1630348319691",
       "@referredType": "ProductOfferingOracle"
   },
   "ruleCondition": [
       {
             
           "stringExpression": "UPG_TO ENTITY(Oracle_DPFTEB6S,ProductOfferingOracle)",
           "description": "Rule Condition1",
           "name": "Rule Condition1",
           "id": "Condition1"
       },
       {
           "productRuleResult": [
               {
                   "@type": "MigrationRuleResultOracle",
                   "productOfferingPrice": [
                       {
                           "id": "MG_PP-1245125592-1630339279419",
                           "name": "MG_PP-1245125592-1630339279419",
                           "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/MG_PP-1245125592-1630339279419",
                           "@referredType": "ProductOfferingPriceOracle",
                           "@type": "ProductOfferingPriceRef",
                           "@baseType": "ProductOfferingPriceOracle"
                       },
                       {
                           "id": "MG_PP-3357907241-1630339279419",
                           "name": "MG_PP-3357907241-1630339279419",
                           "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOfferingPrice/MG_PP-3357907241-1630339279419",
                           "@referredType": "ProductOfferingPriceOracle",
                           "@type": "ProductOfferingPriceRef",
                           "@baseType": "ProductOfferingPriceOracle"
                       }
                   ],
                   "duration": "ORIGINAL_DURATION",
                   "id": "Result-1590826115-163041247168"
               }
           ],
           "validFor": {
               "startDateTime": "2021-08-30T00:00:00.000Z",
               "endDateTime": "2021-09-02T23:59:55.000Z"
           },
           "description": "MG-GRP-2293485690-163030499981",
           "name": "MG-GRP-2293485690-163030499981",
           "id": "MG-GRP-2293485690-163030499981"
       },
       {
           "productRuleResult": [
               {
                   "@type": "MigrationRuleResultOracle",
                   "commitmentStart": "ORIGINAL_END",
                   "duration": "NEW_DURATION",
                   "id": "Result-1476786685-163041247168"
               }
           ],
           "validFor": {
               "startDateTime": "2021-09-03T00:00:00.000Z",
               "endDateTime": "2021-09-30T00:00:00.000Z"
           },
           "description": "MG-GRP-1709107837-163033923660",
           "name": "MG-GRP-1709107837-163033923660",
           "id": "MG-GRP-1709107837-163033923660"
       }
   ],
   "project": {
       "id": "Summer-Initiative",
       "name": "Summer Initiative",
       "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/Summer-Initiative"
   }
}