Get all policy rules

get

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

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

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The list of policy rules was returned successfully.
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.
  • PolicyRuleOracle-allOf[1]
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 : PolicyRuleOracle-allOf[1]
Type: object
Show Source
Nested Schema : customAnalyzerRule
Type: array
A list of custom analyzer rules associated with the policy rule.
Show Source
Nested Schema : CustomerProfileSpecificationRef
Type: object
Title: CustomerProfileSpecificationRef
The customer Profile specification reference.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
The 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
The 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
The project reference resource.
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" } }
    The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
  • ServiceSpecificationRefOracle-allOf[1]
Nested Schema : specCharUse
Type: array
A list of spec characteristic uses associated with the policy rule.
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" } }
    The 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

The 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
The characteristic that defines Constraints.
Show Source
Nested Schema : UsageSpecificationRef
Type: object
Title: UsageSpecificationRef
Discriminator: @type

Discriminator Values

The 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
The error resource.
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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
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
The error resource.
Show Source

500 Response

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

Examples

The following example shows how to get all policy rules 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/tmf-api/policyManagement/v5/policyRule \ -H 'Content-Type: application/json'

Example of Response Body

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

[
    {
        "lastUpdate": "2025-03-10T10:14:18.143Z",
        "lastUpdatedBy": "booth",
        "created": "2025-01-21T12:23:10.000Z",
        "createdBy": "booth",
        "id": "PR-1108218803-17297606",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/PR-1108218803-17297606",
        "name": "ABA 1",
        "description": "Policy Condition 1",
        "@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",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "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
    },
    {
        "lastUpdate": "2025-03-10T10:14:18.143Z",
        "lastUpdatedBy": "booth",
        "created": "2025-01-21T12:23:10.000Z",
        "createdBy": "booth",
        "id": "PR-1108218803-17297605",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/PR-1108218803-17297605",
        "name": "ABA 2",
        "description": "Policy Condition 2",
        "@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",
        "validFor": {
            "startDateTime": "2024-08-09T00:00:00.000Z",
            "endDateTime": "2028-08-09T00:00:00.000Z"
        },
        "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