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
-
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.
-
validFor.endDateTime: string
The valid for end date time for filtering entities.
-
validFor.startDateTime: string
The valid for start date time for filtering entities.
-
version: string
The current version of the resource.
-
whereUsed: string
Whether to enrich objects with usedBy information.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
The list of policy rules was returned successfully.
Root Schema : PolicyRuleOracle
Title:
PolicyRuleOracleMatch All
Show Source
-
object
PolicyRule
Title:
PolicyRuleDiscriminator:{ "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. -
object
PolicyRuleOracle-allOf[1]
Nested Schema : PolicyRule
Type:
objectTitle:
PolicyRuleDiscriminator: @type
Discriminator Values
The policy resource represents a policy/rule applied to an entity or entity spec.
Show Source
-
@baseType: string
The base type of the policy rule.
-
@schemaLocation: string
The URI of the schema that defines the policy rule.
-
@type: string
The class type of the policy rule.
-
actionExecutionStrategy: string
Allowed Values:
[ "DO_SUCCESS", "DO_ALL", "DO_FAILURE", "DO_ALL_OR_NOTHING" ]Indicates the current action execution strategy for policy rule. Valid values are DO_SUCCESS, DO_ALL, DO_FAILURE, and DO_ALL_OR_NOTHING. -
description: string
The description of the policy rule.
-
href: string
The hyperlink reference to the policy rule.
-
id: string
Maximum Length:
30The ID of the policy rule. -
lifecycleStatus: string
The status of the policy rule.
-
name(required): string
The name of the policy rule.
-
policyActionRelationship: array
policyActionRelationship
A list of policy action relationships associated with the policy rule.
-
priority: number
The indicatest the policy rule priority.
-
sequencedActions: string
Allowed Values:
[ "MANDATORY", "RECOMMENDED", "BEST_EFFORT" ]Indicates the ordering of policy action in the policy rule. Valid values are MANDATORY, RECOMMENDED, and BEST_EFFORT. -
targetPolicyEffect: string
Allowed Values:
[ "PERMIT", "DENY" ]Indicates the effect of targeted policy in the policy rule. Valid values are PERMIT, and DENY. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The policy rule version.
Nested Schema : PolicyRuleOracle-allOf[1]
Type:
Show Source
object-
applicationName: string
The name of the application associated with the policy rule.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created.
-
customAnalyzerRule: array
customAnalyzerRule
A list of custom analyzer rules associated with the policy rule.
-
customerProfileSpecification: object
CustomerProfileSpecificationRef
Title:
CustomerProfileSpecificationRefThe customer Profile specification reference. -
customProfileSpecification: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
externalId: string
The ID of the external associated with the policy rule.
-
lastUpdate: string
(date-time)
The date and time when the policy rule was last updated.
-
lastUpdatedBy: string
The name of the person who updated.
-
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRefA 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. -
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRefThe 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. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
serviceSpecification:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle -
specCharUse: array
specCharUse
A list of spec characteristic uses associated with the policy rule.
-
standardZone: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
timeModel: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle -
valueMap: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
versionState: number
The version state of the Price policy.
Nested Schema : customAnalyzerRule
Type:
arrayA list of custom analyzer rules associated with the policy rule.
Show Source
-
Array of:
object CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference.
Nested Schema : CustomerProfileSpecificationRef
Type:
objectTitle:
CustomerProfileSpecificationRefThe customer Profile specification reference.
Show Source
-
@baseType: string
The base type of the customer profile specification reference.
-
@referredType(required): string
The type of the referred customer profile specification reference.
-
@schemaLocation: string
The URI of the schema that defines the customer profile specification reference.
-
@type(required): string
The class type of the customer profile specification reference.
-
href: string
The hyperlink reference to the customer profile specification reference.
-
id(required): string
The ID of the customer profile specification reference.
-
name: string
The name of the customer profile specification reference.
-
version: string
The version of the usage specification.
-
versionState: number
The version state of the reference.
Nested Schema : CustomProfileSpecRefOracle
Type:
objectTitle:
CustomProfileSpecRefOracleThe 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.
Nested Schema : PlaSpecificationRef
Type:
objectTitle:
PlaSpecificationRefA 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
-
@baseType: string
The base type of the pricing logic algorithm specification reference.
-
@referredType(required): string
The type of the referred pricing logic algorithm specification reference.
-
@schemaLocation: string
The URI of the schema that defines the pricing logic algorithm specification reference.
-
@type(required): string
The class type of the pricing logic algorithm specification reference.
-
href: string
The hyperlink reference to the pricing logic algorithm specification reference.
-
id(required): string
The ID of the pricing logic algorithm specification reference.
-
name: string
The name of the pricing logic algorithm specification reference.
-
version: string
The version of the pricing logic algorithm specification.
-
versionState: number
The version state of the reference.
Nested Schema : ProductSpecificationRef
Type:
objectTitle:
ProductSpecificationRefThe 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
-
@baseType: string
The base type of the product specification reference.
-
@referredType(required): string
The type of the referred product specification reference.
-
@schemaLocation: string
The URI of the schema that defines the product specification reference.
-
@type(required): string
The class type of the product specification reference.
-
href: string
The hyperlink reference to the product specification reference.
-
id(required): string
The ID of the product specification reference.
-
name: string
The name of the product specification reference.
-
targetProductSchema: object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification. -
version: string
The version of the product specification.
-
versionState: number
The version state of the reference.
Nested Schema : ProjectRef
Type:
objectTitle:
ProjectRefThe 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.
Nested Schema : ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracleMatch All
Show Source
-
object
ServiceSpecificationRef
Title:
ServiceSpecificationRefDiscriminator:{ "propertyName":"@type", "mapping":{ "ServiceSpecificationRef":"#/components/schemas/ServiceSpecificationRef", "ServiceSpecificationRefOracle":"#/components/schemas/ServiceSpecificationRefOracle" } }The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification. -
object
ServiceSpecificationRefOracle-allOf[1]
Nested Schema : specCharUse
Type:
arrayA list of spec characteristic uses associated with the policy rule.
Show Source
-
Array of:
object SpecCharUseOracle
Title:
SpecCharUseOracleThe characteristic that defines Constraints.
Nested Schema : UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracleMatch All
Show Source
-
object
UsageSpecificationRef
Title:
UsageSpecificationRefDiscriminator:{ "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. -
object
UsageSpecificationRefOracle-allOf[1]
Nested Schema : TargetProductSchema
Type:
objectTitle:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification.
Show Source
-
@schemaLocation(required): string
The URI of the schema that defines the target product schema.
-
@type(required): string
The class type of the target product schema.
Nested Schema : ServiceSpecificationRef
Type:
objectTitle:
ServiceSpecificationRefDiscriminator: @type
Discriminator Values
The service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
Show Source
-
@baseType: string
The base type of the service specification reference.
-
@referredType(required): string
The type of the referred service specification reference.
-
@schemaLocation: string
The URI of the schema that defines the service specification reference.
-
@type(required): string
The class type of the service specification reference.
-
href: string
The hyperlink reference to the service specification reference.
-
id(required): string
The ID of the service specification reference.
-
name: string
The name of the service specification reference.
-
targetServiceSchema: object
TargetServiceSchema
Title:
TargetServiceSchemaThe reference object to the schema and type of target product which is described by product specification. -
version: string
The service specification version.
-
versionState: number
The version state of the reference.
Nested Schema : ServiceSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
isApplicableToChildServices: boolean
Whether the service specification reference is applicable to child services.
-
role: string
Allowed Values:
[ "PRIMARY", "AUXILIARY" ]The service specification role. Valid values are PRIMARY, and AUXILIARY. -
serviceCode: string
The service code associated with the service specification reference.
Nested Schema : SpecCharUseOracle
Type:
objectTitle:
SpecCharUseOracleThe characteristic that defines Constraints.
Show Source
-
charSpecSeq : integer
The characteristic sequence.
-
customAnalyzerRule: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
customerProfileSpecification: object
CustomerProfileSpecificationRef
Title:
CustomerProfileSpecificationRefThe customer Profile specification reference. -
customProfileSpecification: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
displayName: string
The name of the display associated with the specification characteristic use.
-
name(required): string
The name of the specification characteristic use.
-
operator: string
Allowed Values:
[ "EQUALS", "GT", "LT", "GTE", "LTE", "NOT_EQUALS", "IS_NULL", "IS_NOT_NULL", "CONTAINS", "MAPS_TO", "NOT_MAPS_TO", "MATCHES", "NOT_MATCHES" ]The logic expression operator. -
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRefA 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. -
productSpecification: object
ProductSpecificationRef
Title:
ProductSpecificationRefThe 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. -
relationshipType(required): string
Allowed Values:
[ "AGGREGATION" ]The type or classification of the specification characteristic use. Valid values are AGGREGATION. -
serviceSpecification:
ServiceSpecificationRefOracle
Title:
ServiceSpecificationRefOracle -
standardZone: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
timeModel: object
CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference. -
usageSpecification:
UsageSpecificationRefOracle
Title:
UsageSpecificationRefOracle -
valueType: string
The type or classification of the specification characteristic use.
Nested Schema : UsageSpecificationRef
Type:
objectTitle:
UsageSpecificationRefDiscriminator: @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
-
@baseType: string
The base type of the usage specification reference.
-
@referredType(required): string
The type of the referred usage specification reference.
-
@schemaLocation: string
The URI of the schema that defines the usage specification reference.
-
@type(required): string
The class type of the usage specification reference.
-
href: string
The hyperlink reference to the usage specification reference.
-
id(required): string
The ID of the usage specification reference.
-
name: string
The name of the usage specification reference.
-
version: string
The version of the usage specification.
-
versionState: number
The version state of the reference.
Nested Schema : UsageSpecificationRefOracle-allOf[1]
Type:
Show Source
object-
usageCode: string
The usage code associated with the usage specification reference.
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:
objectTitle:
ErrorThe 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.
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
404 Response
The resource with the specified URI couldn't be found.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
objectTitle:
ErrorThe 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.
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
}
]