1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Product Rule

Get a product rule

get

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

Request

Path Parameters
Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ProductRules
Type: object
Title: ProductRules
Discriminator: @type

Discriminator Values

The Product Rule resource represents a set of rules and relationships.
Show Source
Nested Schema : customProfileSpec
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : ruleCondition
Type: array
Show Source
Nested Schema : SubjectRef
Type: object
Title: SubjectRef
Subject Reference
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : RuleConditionOracle
Type: object
Title: RuleConditionOracle
A product rule condition
Show Source
Nested Schema : productRuleExpression
Type: array
Show Source
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "RuleExpressionOracle":"#/components/schemas/RuleExpressionOracle", "EntityRuleExpressionOracle":"#/components/schemas/EntityRuleExpressionOracle", "EligibilityRuleExpressionOracle":"#/components/schemas/EligibilityRuleExpressionOracle" } }
Nested Schema : productRuleResult
Type: array
Show Source
  • Discriminator: @type
    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
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

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.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

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

cURL Command

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

Example of Response Body

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

{
    "id": "PSPRULE001100",
    "name": "PSP iPhone12 Pro Rule",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/v1/productRule/PSPRULE001100",
    "lifecycleStatus": "In design",
    "ruleType": "COMPATIBILITY",
    "@type": "ProductRuleOracle",
    "created": "2021-05-27T07:13:18.000Z",
    "createdBy": "booth",
    "lastUpdate": "2021-06-01T05:07:20.465Z",
    "lastUpdatedBy": "booth",
    "version": "1.0",
    "subject": {
        "id": "iPhone12Pro",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/productOffering/iPhone12Pro",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "stringExpression": "REQUIRES ENTITY(SupremoZoom,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2021-05-06T03:50:48.000Z",
                "endDateTime": "2021-12-29T03:50:48.000Z"
            },
            "description": "Rule condition1",
            "name": "Rule condition1",
            "id": "Condtion1"
        },
        {
            "stringExpression": "REQUIRES_MUTUAL ENTITY(SupremoZoom,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2022-01-01T03:50:48.000Z",
                "endDateTime": "2023-09-30T03:50:48.000Z"
            },
            "description": "Rule condition2",
            "name": "Rule condition2",
            "id": "Condtion2"
        }
    ],
    "project": {
        "id": "PSPChristmansInitiative",
        "name": "Christmas Initiative",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/PSPChristmansInitiative"
    }
}
Back to Top