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

Create a policy rule

post

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : PolicyRuleOracle
Title: PolicyRuleOracle
Match All
Show Source
  • PolicyRule
    Title: PolicyRule
    Discriminator: { "propertyName":"@type", "mapping":{ "PolicyRule":"#/components/schemas/PolicyRule", "PolicyRuleOracle":"#/components/schemas/PolicyRuleOracle" } }
    The policy resource represents a policy/rule applied to an entity or entity spec.
  • type
Nested Schema : PolicyRule
Type: object
Title: PolicyRule
Discriminator: @type

Discriminator Values

The policy resource represents a policy/rule applied to an entity or entity spec.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : PlaSpecificationRef
Type: object
Title: PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.
Show Source
Nested Schema : ProductSpecificationRef
Type: object
Title: ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : ServiceSpecificationRefOracle
Title: ServiceSpecificationRefOracle
Match All
Show Source
  • ServiceSpecificationRef
    Title: ServiceSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }
    Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : specCharUse
Type: array
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
Nested Schema : ServiceSpecificationRef
Type: object
Title: ServiceSpecificationRef
Discriminator: @type

Discriminator Values

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : SpecCharUseOracle
Type: object
Title: SpecCharUseOracle
Characteristic used to define Constraints
Show Source
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source
Back to Top

Response

Supported Media Types

201 Response

Your request is successful and a new resource has been created.
Body ()
Root Schema : PolicyRuleOracle
Title: PolicyRuleOracle
Match All
Show Source
  • PolicyRule
    Title: PolicyRule
    Discriminator: { "propertyName":"@type", "mapping":{ "PolicyRule":"#/components/schemas/PolicyRule", "PolicyRuleOracle":"#/components/schemas/PolicyRuleOracle" } }
    The policy resource represents a policy/rule applied to an entity or entity spec.
  • type
Nested Schema : PolicyRule
Type: object
Title: PolicyRule
Discriminator: @type

Discriminator Values

The policy resource represents a policy/rule applied to an entity or entity spec.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
Customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : PlaSpecificationRef
Type: object
Title: PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role.
Show Source
Nested Schema : ProductSpecificationRef
Type: object
Title: ProductSpecificationRef
Product specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : ServiceSpecificationRefOracle
Title: ServiceSpecificationRefOracle
Match All
Show Source
  • ServiceSpecificationRef
    Title: ServiceSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }
    Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : specCharUse
Type: array
Show Source
Nested Schema : UsageSpecificationRefOracle
Title: UsageSpecificationRefOracle
Match All
Show Source
  • UsageSpecificationRef
    Title: UsageSpecificationRef
    Discriminator: { "propertyName":"@type", "mapping":{ "UsageSpecificationRef":"#/components/schemas/UsageSpecificationRef", "UsageSpecificationRefOracle":"#/components/schemas/UsageSpecificationRefOracle" } }
    Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
  • UsageSpecificationRefOracle-allOf[1]
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification
Show Source
Nested Schema : ServiceSpecificationRef
Type: object
Title: ServiceSpecificationRef
Discriminator: @type

Discriminator Values

Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type: object
Show Source
Nested Schema : SpecCharUseOracle
Type: object
Title: SpecCharUseOracle
Characteristic used to define Constraints
Show Source
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

Usage specification reference: A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.
Show Source
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type: object
Show Source

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 policy rule by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule \ -H 'Content-Type: application/json' -D @policyrule_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": "PR-1108218803-172976061",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/PR-1108218803-17297606",
    "name": "ABA 11",
    "@type": "PolicyRuleOracle",
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "version": "1.0",
    "specCharUse": [
        {
            "name": "Account Type",
            "relationshipType": "AGGREGATION",
            "operator": "EQUALS",
            "charSpecSeq": 0,
            "valueType": "STRING",
            "customProfileSpecification": {
                "id": "Siebel-Default-DiscMat-CPS",
                "name": "Siebel Default Discount Matrice CPS",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Siebel-Default-DiscMat-CPS",
                "version": "1.0",
                "@referredType": "CustomProfileSpecificationOracle",
                "@type": "CustomProfileSpecificationOracle"
            }
        }
    ],
    "policyActionRelationship": [
        {
            "id": "relX1ss",
            "priority": 1,
            "constraint": {
                "id": "constrx1ss",
                "conditionCombLogic": "ALL_OF",
                "policyCondition": [
                    {
                        "id": "conx1ss",
                        "operator": "EQUALS",
                        "value": "Residential",
                        "statement": "Account Type"
                    }
                ]
            },
            "policyAction": {
                "id": "DF-2288701335-1729760653989",
                "name": "DF-2288701335-1729760653989",
                "@type": "ProductOfferingPriceRef",
                "version": "1.0",
                "actionValueType": "PRODUCT_OFFERING_PRICE"
            }
        }
    ],
    "customProfileSpecification": {
        "id": "Siebel-Default-DiscMat-CPS",
        "name": "Siebel Default Discount Matrice CPS",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Siebel-Default-DiscMat-CPS",
        "version": "1.0",
        "@referredType": "CustomProfileSpecificationOracle",
        "@type": "CustomProfileSpecificationOracle"
    },
    "lifecycleStatus": "In design",
    "priority": 0
}

Example of Response Body

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

{
    "lastUpdate": "2025-02-17T13:01:56.170Z",
    "lastUpdatedBy": "booth",
    "created": "2025-02-17T13:01:56.000Z",
    "createdBy": "booth",
    "versionState": 0,
    "id": "PR-1108218803-172976061",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/PR-1108218803-172976061",
    "name": "ABA 11",
    "@type": "PolicyRuleOracle",
    "project": {
        "id": "DBE_RI_Mob_ProdModel_PSP",
        "name": "DBE RI Mobile Product Model",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_Mob_ProdModel_PSP",
        "version": "1.0",
        "@referredType": "ProjectOracle"
    },
    "version": "1.0",
    "specCharUse": [
        {
            "name": "Account Type",
            "relationshipType": "AGGREGATION",
            "operator": "EQUALS",
            "charSpecSeq": 0,
            "valueType": "STRING",
            "customProfileSpecification": {
                "id": "Siebel-Default-DiscMat-CPS",
                "name": "Siebel Default Discount Matrice CPS",
                "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Siebel-Default-DiscMat-CPS",
                "version": "1.0",
                "versionState": -1,
                "@referredType": "CustomProfileSpecificationOracle",
                "@type": "CustomProfileSpecificationOracle"
            }
        }
    ],
    "policyActionRelationship": [
        {
            "id": "relX1ss",
            "priority": 1,
            "constraint": {
                "id": "constrx1ss",
                "conditionCombLogic": "ALL_OF",
                "policyCondition": [
                    {
                        "id": "conx1ss",
                        "operator": "EQUALS",
                        "value": "Residential",
                        "statement": "Account Type"
                    }
                ]
            },
            "policyAction": {
                "id": "DF-2288701335-1729760653989",
                "name": "DF-2288701335-1729760653989",
                "@type": "ProductOfferingPriceRef",
                "version": "1.0",
                "actionValueType": "PRODUCT_OFFERING_PRICE"
            }
        }
    ],
    "customProfileSpecification": {
        "id": "Siebel-Default-DiscMat-CPS",
        "name": "Siebel Default Discount Matrice CPS",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Siebel-Default-DiscMat-CPS",
        "version": "1.0",
        "versionState": -1,
        "@referredType": "CustomProfileSpecificationOracle",
        "@type": "CustomProfileSpecificationOracle"
    },
    "lifecycleStatus": "In design",
    "priority": 0
}
Back to Top