Create a policy rule
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule
Request
There are no request parameters for this operation.
- application/json
PolicyRuleOracle-
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
type
objectPolicyRuleDiscriminator Values
-
@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.
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.
array-
Array of:
object CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference.
objectCustomerProfileSpecificationRef-
@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.
objectCustomProfileSpecRefOracle-
@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.
objectPlaSpecificationRef-
@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.
objectProductSpecificationRef-
@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.
objectProjectRef-
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.
ServiceSpecificationRefOracle-
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]
array-
Array of:
object SpecCharUseOracle
Title:
SpecCharUseOracleThe characteristic that defines Constraints.
UsageSpecificationRefOracle-
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]
objectTargetProductSchema-
@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.
objectServiceSpecificationRefDiscriminator Values
-
@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.
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.
objectSpecCharUseOracle-
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.
objectUsageSpecificationRefDiscriminator Values
-
@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.
object-
usageCode: string
The usage code associated with the usage specification reference.
Response
- application/json
201 Response
PolicyRuleOracle-
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
type
objectPolicyRuleDiscriminator Values
-
@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.
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.
array-
Array of:
object CustomProfileSpecRefOracle
Title:
CustomProfileSpecRefOracleThe custom Profile specification reference.
objectCustomerProfileSpecificationRef-
@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.
objectCustomProfileSpecRefOracle-
@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.
objectPlaSpecificationRef-
@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.
objectProductSpecificationRef-
@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.
objectProjectRef-
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.
ServiceSpecificationRefOracle-
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]
array-
Array of:
object SpecCharUseOracle
Title:
SpecCharUseOracleThe characteristic that defines Constraints.
UsageSpecificationRefOracle-
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]
objectTargetProductSchema-
@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.
objectServiceSpecificationRefDiscriminator Values
-
@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.
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.
objectSpecCharUseOracle-
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.
objectUsageSpecificationRefDiscriminator Values
-
@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.
object-
usageCode: string
The usage code associated with the usage specification reference.
400 Response
objectError-
@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
objectError-
@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
objectError-
@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
objectError-
@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
objectError-
@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 examples show how to create a policy rule by submitting a POST request on the REST resource using cURL.
Simple Policy
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": "TIME_PERIOD",
"charSpecSeq": 1,
"relationshipType": "AGGREGATION",
"valueType": "STRING",
"operator": "EQUALS",
"timeModel": {
"id": "US_TIME_MODEL",
"name": "US_TIME_MODEL",
"version": "1.0",
"@referredType": "CustomProfileSpecificationOracle",
"@type": "CustomProfileSpecRefOracle"
},
{
"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"
},
{
"id": "POL_CD_720981118_1763961223737",
"operator": "EQUALS",
"value": "Peak",
"statement": "TIME_PERIOD"
}
]
},
"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"
},
"timeModel": {
"id": "US_TIME_MODEL",
"name": "US_TIME_MODEL",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS_RB_12_8_2025_12_57_39",
"@referredType": "CustomProfileSpecificationOracle",
"@type": "CustomProfileSpecRefOracle"
},
"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
}
Policy with Time Model Reference
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 the request body.
{
"lastUpdate": "2025-11-24T05:13:44.928Z",
"lastUpdatedBy": "booth",
"created": "2025-11-24T05:13:44.385Z",
"createdBy": "booth",
"versionState": 0,
"id": "POLICY_3468603563_176396172373",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/POLICY_3468603563_176396122373",
"name": "TOD Simpleusage Price",
"@type": "PolicyRuleOracle",
"@baseType": "PolicyRule",
"version": "1.0",
"specCharUse": [
{
"name": "TIME_PERIOD",
"charSpecSeq": 1,
"relationshipType": "AGGREGATION",
"valueType": "STRING",
"operator": "EQUALS",
"timeModel": {
"id": "US_TIME_MODEL",
"name": "US_TIME_MODEL",
"version": "1.0",
"@referredType": "CustomProfileSpecificationOracle",
"@type": "CustomProfileSpecRefOracle"
}
}
],
"policyActionRelationship": [
{
"id": "Rel-1_3605974434_1763061223737",
"priority": 1,
"constraint": {
"id": "const-1_2247977805_19639612237",
"conditionCombLogic": "ALL_OF",
"policyCondition": [
{
"id": "POL_CD_720981118_1763961223737",
"operator": "EQUALS",
"value": "Peak",
"statement": "TIME_PERIOD"
}
]
},
"policyAction": {
"id": "POP_4070639991_1763961182389",
"name": "POP_4070639991_1763961182389",
"@type": "ProductOfferingPriceOracle",
"version": "1.0",
"actionValueType": "PRODUCT_OFFERING_PRICE"
}
}
],
"timeModel": {
"id": "US_TIME_MODEL",
"name": "US_TIME_MODEL",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS_RB_12_8_2025_12_57_39",
"@referredType": "CustomProfileSpecificationOracle",
"@type": "CustomProfileSpecRefOracle"
},
"lifecycleStatus": "In design",
"priority": 0
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"lastUpdate": "2025-11-24T05:13:44.928Z",
"lastUpdatedBy": "booth",
"created": "2025-11-24T05:13:44.385Z",
"createdBy": "booth",
"versionState": 0,
"id": "POLICY_3468603563_176396172373",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/POLICY_3468603563_176396122373",
"name": "TOD Simpleusage Price",
"@type": "PolicyRuleOracle",
"@baseType": "PolicyRule",
"version": "1.0",
"specCharUse": [
{
"name": "TIME_PERIOD",
"charSpecSeq": 1,
"relationshipType": "AGGREGATION",
"valueType": "STRING",
"operator": "EQUALS",
"timeModel": {
"id": "US_TIME_MODEL",
"name": "US_TIME_MODEL",
"version": "1.0",
"@referredType": "CustomProfileSpecificationOracle",
"@type": "CustomProfileSpecRefOracle"
}
}
],
"policyActionRelationship": [
{
"id": "Rel-1_3605974434_1763061223737",
"priority": 1,
"constraint": {
"id": "const-1_2247977805_19639612237",
"conditionCombLogic": "ALL_OF",
"policyCondition": [
{
"id": "POL_CD_720981118_1763961223737",
"operator": "EQUALS",
"value": "Peak",
"statement": "TIME_PERIOD"
}
]
},
"policyAction": {
"id": "POP_4070639991_1763961182389",
"name": "POP_4070639991_1763961182389",
"@type": "ProductOfferingPriceOracle",
"version": "1.0",
"actionValueType": "PRODUCT_OFFERING_PRICE"
}
}
],
"timeModel": {
"id": "US_TIME_MODEL",
"name": "US_TIME_MODEL",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/PS_RB_12_8_2025_12_57_39",
"@referredType": "CustomProfileSpecificationOracle",
"@type": "CustomProfileSpecRefOracle"
},
"lifecycleStatus": "In design",
"priority": 0
}
Policy with Composite Policy Condition to Support Multiple Attribute Values
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 the request body.
{
"lastUpdate": "2026-02-07T21:11:34.053Z",
"lastUpdatedBy": "booth",
"created": "2026-02-07T21:11:34.000Z",
"createdBy": "booth",
"versionState": 0,
"id": "AttrCnstrA4K73M92QZ9FKQM",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/AttrCnstrA4K73M92QZ9FKQM",
"name": "AttrPricingConstraintA4K73M92QZ9FKQM",
"@type": "PolicyRuleOracle",
"project": {
"id": "ProjA4K73M92QZ9FKQM",
"name": "ProjA4K73M92QZ9FKQM",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/ProjA4K73M92QZ9FKQM",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"version": "1.0",
"specCharUse": [
{
"name": "Color_AutoA4K73M92QZ9FKQM",
"relationshipType": "AGGREGATION",
"charSpecSeq": 2,
"valueType": "STRING",
"productSpecification": {
"id": "ProdSpecA4K73M92QZ9FKQM",
"name": "ProdSpecA4K73M92QZ9FKQM",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/ProdSpecA4K73M92QZ9FKQM",
"@referredType": "ProductSpecificationOracle",
"@type": "ProductSpecificationRef"
}
},
{
"name": "Memory_AutoA4K73M92QZ9FKQM",
"relationshipType": "AGGREGATION",
"charSpecSeq": 1,
"valueType": "STRING",
"productSpecification": {
"id": "ProdSpecA4K73M92QZ9FKQM",
"name": "ProdSpecA4K73M92QZ9FKQM",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/ProdSpecA4K73M92QZ9FKQM",
"@referredType": "ProductSpecificationOracle",
"@type": "ProductSpecificationRef"
}
}
],
"policyActionRelationship": [
{
"id": "Rel-1_2985551798_1761748914086",
"priority": 1,
"constraint": {
"id": "const-1_583186672_176174891408",
"conditionCombLogic": "ALL_OF",
"policyCondition": [
{
"@type": "PolicyConditionComposite",
"id": "POL_CD_2922645092_176174891408",
"conditionCombinationLogic": "ONE_OF",
"isComposite": true,
"condition": [
{
"value": "Red",
"id": "POL_CD_2922645092_176174891408",
"statement": "Color",
"@type": "PolicyConditionOracle",
"operator": "EQUALS"
},
{
"value": "Blue",
"id": "POL_CD_2922645092_176174891408",
"statement": "Color",
"@type": "PolicyConditionOracle",
"operator": "EQUALS"
}
]
}
]
},
"policyAction": {
"id": "POP_3530789013_1761748856316",
"name": "POP_3530789013_1761748856316",
"description": "POP_3530789013_1761748856316",
"version": "1.0"
}
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"lastUpdate": "2026-02-07T21:11:34.053Z",
"lastUpdatedBy": "booth",
"created": "2026-02-07T21:11:34.000Z",
"createdBy": "booth",
"versionState": 0,
"id": "AttrCnstrA4K73M92QZ9FKQM",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/policyManagement/v5/policyRule/AttrCnstrA4K73M92QZ9FKQM",
"name": "AttrPricingConstraintA4K73M92QZ9FKQM",
"@type": "PolicyRuleOracle",
"project": {
"id": "ProjA4K73M92QZ9FKQM",
"name": "ProjA4K73M92QZ9FKQM",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/ProjA4K73M92QZ9FKQM",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"version": "1.0",
"specCharUse": [
{
"name": "Color_AutoA4K73M92QZ9FKQM",
"relationshipType": "AGGREGATION",
"charSpecSeq": 2,
"valueType": "STRING",
"productSpecification": {
"id": "ProdSpecA4K73M92QZ9FKQM",
"name": "ProdSpecA4K73M92QZ9FKQM",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/ProdSpecA4K73M92QZ9FKQM",
"@referredType": "ProductSpecificationOracle",
"@type": "ProductSpecificationRef"
}
},
{
"name": "Memory_AutoA4K73M92QZ9FKQM",
"relationshipType": "AGGREGATION",
"charSpecSeq": 1,
"valueType": "STRING",
"productSpecification": {
"id": "ProdSpecA4K73M92QZ9FKQM",
"name": "ProdSpecA4K73M92QZ9FKQM",
"version": "1.0",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/productSpecification/ProdSpecA4K73M92QZ9FKQM",
"@referredType": "ProductSpecificationOracle",
"@type": "ProductSpecificationRef"
}
}
],
"policyActionRelationship": [
{
"id": "Rel-1_2985551798_1761748914086",
"priority": 1,
"constraint": {
"id": "const-1_583186672_176174891408",
"conditionCombLogic": "ALL_OF",
"policyCondition": [
{
"@type": "PolicyConditionComposite",
"id": "POL_CD_2922645092_176174891408",
"conditionCombinationLogic": "ONE_OF",
"isComposite": true,
"condition": [
{
"value": "Red",
"id": "POL_CD_2922645092_176174891408",
"statement": "Color",
"@type": "PolicyConditionOracle",
"operator": "EQUALS"
},
{
"value": "Blue",
"id": "POL_CD_2922645092_176174891408",
"statement": "Color",
"@type": "PolicyConditionOracle",
"operator": "EQUALS"
}
]
}
]
},
"policyAction": {
"id": "POP_3530789013_1761748856316",
"name": "POP_3530789013_1761748856316",
"description": "POP_3530789013_1761748856316",
"version": "1.0"
}
}
]
}