REST API Reference for Launch Cloud Service

Update a product rule

patch

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

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

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"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

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

Show Source

@baseType: string
@schemaLocation: string
@type: 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"
    ],
    "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: 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"
    ]
}

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: string

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

This field provides a link to the schema describing this REST resource
@type: 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"
    ]
}

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: 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"
    ]
}

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

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"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

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

Show Source

@baseType: string
@schemaLocation: string
@type: 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"
    ],
    "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: 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"
    ]
}

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: string

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

This field provides a link to the schema describing this REST resource
@type: 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"
    ]
}

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: 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"
    ]
}

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 example shows how to update a product rule by submitting a patch request on the REST resource using cURL.

cURL Command

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

Example of Request Body

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

Example of Response Body

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