REST API Reference for Launch Cloud Service

Get all product rules

get

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

Returns a list of product rules that match the search criteria.

Request

Query Parameters

description: string

The description of the resource.
eligibleForProject: string

The project ID.
fields: string

The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
id: string

The unique ID of the resource item.
lastUpdate: string

Filters resources by their last update date and time.
lifecycleStatus: string

The current lifecycle status of the resource.
limit: integer

The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
name: string

The name of the resource.
offset: string

The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
project.id: string

The ID of the project for filtering resource results.
project.version: string

The project version for filtering entities.
subject.@referredType: string

The subject type for filtering product rules.
subject.id: string

The ID of the subject for filtering resource results.
subject.name: string

The subject name for filtering product rules.
whereUsed: string

Whether to enrich objects with usedBy information.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

The list of product rules was returned successfully.

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,
            "description":"The ID of the product rule."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the product rule."
        },
        "version":{
            "type":"string",
            "description":"The version value associated with the product rule."
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ],
            "description":"The type or classification of the product rule. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT."
        },
        "ruleSubType":{
            "type":"string",
            "enum":[
                {
                }
            ],
            "description":"The type or classification of the product rule. Valid values are {}."
        },
        "name":{
            "type":"string",
            "description":"The name of the product rule."
        },
        "description":{
            "type":"string",
            "description":"The text description of the product rule."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the product rule."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the product rule."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the product rule."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the product rule."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the product rule was last updated."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated."
        },
        "ruleCondition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleConditionOracle"
            },
            "description":"A list of rule conditions associated with the product rule."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The product rule."
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            },
            "description":"A list of custom profile specifications associated with the product rule."
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectRef",
            "description":"The product rule."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the product rule."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the product rule."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the product rule."
        },
        "scope":{
            "type":"string",
            "enum":[
                "ALL",
                "BUNDLE",
                "PACKAGE"
            ],
            "description":"The scope associated with the product rule. Valid values are ALL, BUNDLE, and PACKAGE."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

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

Show Source

@baseType: string

The base type of the product rule.
@schemaLocation: string

The URI of the schema that defines the product rule.
@type(required): string

The class type of the product rule.
applicationName: string

The name of the application associated with the product rule.
created: string (date-time)

The date and time of creation.
createdBy: string

The name of the person who created.
customProfileSpec: array customProfileSpec

A list of custom profile specifications associated with the product rule.
description: string

The text description of the product rule.
externalId: string

The ID of the external associated with the product rule.
href: string

The hyperlink reference to the product rule.
id: string

Maximum Length: 30

The ID of the product rule.
lastUpdate: string (date-time)

The date and time when the product rule was last updated.
lastUpdatedBy: string

The name of the person who updated.
lifecycleStatus: string

The status of the product rule.
name(required): string

The name of the product rule.
project: object ProjectRef

Title: ProjectRef

The project reference resource.
ruleCondition: array ruleCondition

A list of rule conditions associated with the product rule.
ruleSubType: string

Allowed Values: [ { } ]

The type or classification of the product rule. Valid values are {}.
ruleType: string

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

The type or classification of the product rule. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT.
scope: string

Allowed Values: [ "ALL", "BUNDLE", "PACKAGE" ]

The scope associated with the product rule. Valid values are ALL, BUNDLE, and PACKAGE.
subject: object SubjectRef

Title: SubjectRef

The subject reference resource.
version: string

The version value associated with the product rule.
versionState: number

The 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,
            "description":"The ID of the product rule."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the product rule."
        },
        "version":{
            "type":"string",
            "description":"The version value associated with the product rule."
        },
        "ruleType":{
            "type":"string",
            "enum":[
                "COMPATIBILITY",
                "ELIGIBILITY",
                "MIGRATION",
                "RECOMMENDATION",
                "CONSTRAINT"
            ],
            "description":"The type or classification of the product rule. Valid values are COMPATIBILITY, ELIGIBILITY, MIGRATION, RECOMMENDATION, and CONSTRAINT."
        },
        "ruleSubType":{
            "type":"string",
            "enum":[
                {
                }
            ],
            "description":"The type or classification of the product rule. Valid values are {}."
        },
        "name":{
            "type":"string",
            "description":"The name of the product rule."
        },
        "description":{
            "type":"string",
            "description":"The text description of the product rule."
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"The status of the product rule."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the product rule."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the product rule."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the product rule."
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time when the product rule was last updated."
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"The date and time of creation."
        },
        "createdBy":{
            "type":"string",
            "description":"The name of the person who created."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"The name of the person who updated."
        },
        "ruleCondition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RuleConditionOracle"
            },
            "description":"A list of rule conditions associated with the product rule."
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef",
            "description":"The product rule."
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            },
            "description":"A list of custom profile specifications associated with the product rule."
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectRef",
            "description":"The product rule."
        },
        "externalId":{
            "type":"string",
            "description":"The ID of the external associated with the product rule."
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application associated with the product rule."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the product rule."
        },
        "scope":{
            "type":"string",
            "enum":[
                "ALL",
                "BUNDLE",
                "PACKAGE"
            ],
            "description":"The scope associated with the product rule. Valid values are ALL, BUNDLE, and PACKAGE."
        }
    },
    "required":[
        "name",
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
        }
    }
}

Nested Schema : customProfileSpec

Type: array

A list of custom profile specifications associated with the product rule.

Show Source

Array of: object CustomProfileSpecRefOracle

Title: CustomProfileSpecRefOracle

The custom Profile specification reference.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
    },
    "description":"A list of custom profile specifications associated with the product rule."
}

Nested Schema : ProjectRef

Type: object

Title: ProjectRef

The project reference resource.

Show Source

href: string

The hyperlink reference to the project reference.
id(required): string

The ID of the project reference.
name: string

The name of the project reference.
version: string

The version of the project.

{
    "title":"ProjectRef",
    "type":"object",
    "description":"The project reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the project reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the project reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the project reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the project."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : ruleCondition

Type: array

A list of rule conditions associated with the product rule.

Show Source

Array of: object RuleConditionOracle

Title: RuleConditionOracle

The rule condition resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RuleConditionOracle"
    },
    "description":"A list of rule conditions associated with the product rule."
}

Nested Schema : SubjectRef

Type: object

Title: SubjectRef

The subject reference resource.

Show Source

@baseType: string

The base type of the subject reference.
@referredType(required): string

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

The path that represents the hierarchy of the component product offering within the product offering. It includes the offer ID and associated parents, such as package ID, bundled product offering ID, and atomic offer ID, and helps identify the subject entity in the runtime system.
href: string

The hyperlink reference to the subject reference.
id(required): string

The ID of the subject reference.
name: string

The name of the subject reference.
version: string

The version of the subject.

{
    "title":"SubjectRef",
    "type":"object",
    "description":"The subject reference resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the subject reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the subject reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the subject reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the subject."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "entityPathExpression":{
            "type":"string",
            "description":"The path that represents the hierarchy of the component product offering within the product offering. It includes the offer ID and associated parents, such as package ID, bundled product offering ID, and atomic offer ID, and helps identify the subject entity in the runtime system."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the subject reference."
        }
    },
    "required":[
        "id",
        "@referredType"
    ]
}

Nested Schema : CustomProfileSpecRefOracle

Type: object

Title: CustomProfileSpecRefOracle

The custom Profile specification reference.

Show Source

@baseType: string

The base type of the custom profile specification reference.
@referredType(required): string

The type of the referred custom profile specification reference.
@schemaLocation: string

The URI of the schema that defines the custom profile specification reference.
@type(required): string

The class type of the custom profile specification reference.
href: string

The hyperlink reference to the custom profile specification reference.
id(required): string

The ID of the custom profile specification reference.
name: string

The name of the custom profile specification reference.
version: string

The version of the custom specification.
versionState: number

The version state of the reference.

{
    "title":"CustomProfileSpecRefOracle",
    "type":"object",
    "description":"The custom Profile specification reference.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the custom profile specification reference."
        },
        "href":{
            "type":"string",
            "description":"The hyperlink reference to the custom profile specification reference."
        },
        "name":{
            "type":"string",
            "description":"The name of the custom profile specification reference."
        },
        "version":{
            "type":"string",
            "description":"The version of the custom specification."
        },
        "@referredType":{
            "type":"string",
            "description":"The type of the referred custom profile specification reference."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the custom profile specification reference."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the custom profile specification reference."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the custom profile specification reference."
        },
        "versionState":{
            "type":"number",
            "description":"The version state of the reference."
        }
    },
    "required":[
        "id",
        "@type",
        "@referredType"
    ]
}

Nested Schema : RuleConditionOracle

Type: object

Title: RuleConditionOracle

The rule condition resource.

Show Source

@baseType: string

The base type of the rule condition.
@schemaLocation: string

The URI of the schema that defines the rule condition.
@type(required): string

The class type of the rule condition.
description: string

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

The ID of the rule condition.
name: string

The name of the rule condition.
productRuleExpression: array productRuleExpression

A list of product rule expressions associated with the rule condition.
productRuleResult: array productRuleResult

A list of product rule results associated with the rule condition.
roundingMethod: string

The rounding applicable to the product rule.
stringExpression: string

The metering Expression applicable to the product rule.
unitOfMeasure: string

The unit of Measure of Rules.
validFor: object TimePeriodOracle

Title: TimePeriodOracle

The validity period of the related party.

{
    "type":"object",
    "title":"RuleConditionOracle",
    "description":"The rule condition resource.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the rule condition."
        },
        "name":{
            "type":"string",
            "description":"The name of the rule condition."
        },
        "description":{
            "type":"string",
            "description":"A string. Description of the product rule."
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriodOracle",
            "description":"The period for which the rule condition is valid."
        },
        "roundingMethod":{
            "type":"string",
            "description":"The rounding applicable to the product rule."
        },
        "stringExpression":{
            "type":"string",
            "description":"The metering Expression applicable to the product rule."
        },
        "unitOfMeasure":{
            "type":"string",
            "description":"The unit of Measure of Rules."
        },
        "@type":{
            "type":"string",
            "description":"The class type of the rule condition."
        },
        "@baseType":{
            "type":"string",
            "description":"The base type of the rule condition."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the rule condition."
        },
        "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"
                    }
                }
            },
            "description":"A list of product rule expressions associated with the rule condition."
        },
        "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"
                    }
                }
            },
            "description":"A list of product rule results associated with the rule condition."
        }
    },
    "required":[
        "id",
        "@type"
    ]
}

Nested Schema : productRuleExpression

Type: array

A list of product rule expressions associated with the rule condition.

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"
            }
        }
    },
    "description":"A list of product rule expressions associated with the rule condition."
}

Nested Schema : productRuleResult

Type: array

A list of product rule results associated with the rule condition.

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"
            }
        }
    },
    "description":"A list of product rule results associated with the rule condition."
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

The validity period of the related party.

Show Source

endDateTime: string (date-time)

The end date and time of the time period.
startDateTime: string (date-time)

The start date and time of the time period.

{
    "description":"The validity period of the related party.",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The start date and time of the time period."
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"The end date and time of the time period."
        }
    }
}

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

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

404 Response

The resource with the specified URI couldn't be found.

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

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

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

500 Response

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

Root Schema : Error

Type: object

Title: Error

The error resource.

Show Source

@schemaLocation: string

The URI of the schema that defines the error.
@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

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

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

The URL pointing to documentation describing the error.
status: string

The status of the error.

{
    "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":"The text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The text that provides more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The status of the error."
        },
        "referenceError":{
            "type":"string",
            "description":"The URL pointing to documentation describing the error."
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI of the schema that defines the error."
        }
    },
    "required":[
        "code",
        "reason"
    ],
    "description":"The error resource."
}

Examples

The following example shows how to get all product rules by submitting a get request on the REST resource using cURL.

cURL Command

curl -u username:password -X GET https://{FusionAppsHost}/atcProductCatalog/11.13.18.05/v1/productRule \ -H 'Content-Type: application/json'

Example of Response Body

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

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