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

Create a product rule

post

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

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
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

Back to Top

Response

Supported Media Types

201 Response

Your request is successful and a new resource has been created.
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 examples show how to create a product rule by submitting a POST request on the REST resource using cURL.

Compatibility product rule

cURL Command

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

Example of Request Body

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

{
    "id": "PSPRULE001100",
    "name": "PSP iPhone12 Pro Rule",
    "version": "1.0",
    "ruleType": "COMPATIBILITY",
    "description": "Rule007 Compatability Rule",
    "lifecycleStatus": "In design",
    "subject": {
        "id": "iPhone12Pro",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "id": "Condtion1",
            "name": "Rule condition1",
            "description": "Rule condition1",
            "stringExpression": "REQUIRES ENTITY(SupremoZoom,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2021-05-06T03:50:48.000Z",
                "endDateTime": "2021-12-29T03:50:48.000Z"
            }
        },
        {
            "id": "Condtion2",
            "name": "Rule condition2",
            "description": "Rule condition2",
            "stringExpression": "REQUIRES_MUTUAL ENTITY(SupremoZoom,ProductOfferingOracle)",
            "validFor": {
                "startDateTime": "2022-01-01T03:50:48.000Z",
                "endDateTime": "2023-09-30T03:50:48.000Z"
            }
        }
    ],
    "project": {
        "id": "PSPChristmansInitiative",
        "name": "Christmas Initiative"
    }
}

Example of Response Body

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

200 OK

Recommendation product rule

cURL Command

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

Example of Request Body

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

{
    "id": "RECOMMENDRULE001",
    "name": "RECOMMEND-RULE-001",
    "lifecycleStatus": "In design",
    "version": "1.0",
    "ruleType": "RECOMMENDATION",
    "subject": {
        "id": "iPhone12Pro",
        "name": "iPhone12 Pro",
        "@referredType": "ProductOfferingOracle"
    },
    "ruleCondition": [
        {
            "validFor": {
                "startDateTime": "2022-02-01T00:00:00.000Z",
                "endDateTime": "2023-03-31T00:00:00.000Z"
            },
            "description": "Rule condition1",
            "name": "Rule condition1",
            "id": "Condition1",
            "productRuleResult": [
                {
                    "id": "Result001",
                    "value": "iPhoneProMaxCre234455",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "UPSELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for iPhone12 device",
                    "@type": "RecommendationRuleResultOracle"
                },
                {
                    "id": "Result002",
                    "value": "Apple-redwood",
                    "valueType": "PRODUCT_OFFERING",
                    "messageType": "CROSS_SELL_RECOMMEND",
                    "score": 1,
                    "message": "Recommended for Apple device",
                    "@type": "RecommendationRuleResultOracle"
                }
            ]
        }
    ]
}

Example of Response Body

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

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

Migration product rule

cURL Command

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

Example of Request Body

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

{
   "id": "RULE-MG-2428711991-16303049976",
   "name": "Migration3008"
   "lifecycleStatus": "In design",
   "ruleType": "MIGRATION",
   "@type": "ProductRuleOracle",
   "version": "1.0",
   "subject": {
       "id": "ID-2748943967-1630348319691",
       "name": "Test30Aug",
        
       "@referredType": "ProductOfferingOracle"
   },
   "ruleCondition": [
       {
             
           "stringExpression": "UPG_TO ENTITY(Oracle_DPFTEB6S,ProductOfferingOracle)",
           "description": "Rule Condition1",
           "name": "Rule Condition1",
           "id": "Condition1"
       },
       {
           "productRuleResult": [
               {
                   "@type": "MigrationRuleResultOracle",
                   "productOfferingPrice": [
                       {
                           "id": "MG_PP-1245125592-1630339279419",
                           "name": "MG_PP-1245125592-1630339279419",
                            
                           "@referredType": "ProductOfferingPriceOracle",
                           "@type": "ProductOfferingPriceRef",
                           "@baseType": "ProductOfferingPriceOracle"
                       },
                       {
                           "id": "MG_PP-3357907241-1630339279419",
                           "name": "MG_PP-3357907241-1630339279419",
                          
                           "@referredType": "ProductOfferingPriceOracle",
                           "@type": "ProductOfferingPriceRef",
                           "@baseType": "ProductOfferingPriceOracle"
                       }
                   ],
                   "duration": "ORIGINAL_DURATION",
                   "id": "Result-1590826115-163041247168"
               }
           ],
           "validFor": {
               "startDateTime": "2021-08-30T00:00:00.000Z",
               "endDateTime": "2021-09-02T23:59:55.000Z"
           },
           "description": "MG-GRP-2293485690-163030499981",
           "name": "MG-GRP-2293485690-163030499981",
           "id": "MG-GRP-2293485690-163030499981"
       },
       {
           "productRuleResult": [
               {
                   "@type": "MigrationRuleResultOracle",
                   "commitmentStart": "ORIGINAL_END",
                   "duration": "NEW_DURATION",
                   "id": "Result-1476786685-163041247168"
               }
           ],
           "validFor": {
               "startDateTime": "2021-09-03T00:00:00.000Z",
               "endDateTime": "2021-09-30T00:00:00.000Z"
           },
           "description": "MG-GRP-1709107837-163033923660",
           "name": "MG-GRP-1709107837-163033923660",
           "id": "MG-GRP-1709107837-163033923660"
       }
   ],
   "project": {
       "id": "Summer-Initiative",
       "name": "Summer Initiative",
        
   }
}

Example of Response Body

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

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