Create a custom profile specification
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification
Request
There are no request parameters for this operation.
- application/json
objectCustomProfileSpecificationOracle-
@baseType: string
The base type of the custom profile specification.
-
@schemaLocation: string
The URI of the schema that defines the custom profile specification.
-
@type(required): string
The class type of the custom profile specification.
-
applicationName: string
The name of the application associated with the custom profile specification.
-
charValueObject: array
charValueObject
A list of char value objects associated with the custom profile specification.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created.
-
customProfileSpecChar: array
customProfileSpecChar
A list of custom profile specification characteristics associated with the custom profile specification.
-
customProfileSpecRel: array
customProfileSpecRel
A list of custom profile specification rels associated with the custom profile specification.
-
description: string
A string. A narrative that explains in detail what the Custom ProfileSpec is.
-
externalId: string
The ID of the external associated with the custom profile specification.
-
href: string
A string. Reference of the Custom ProfileSpec.
-
id: string
Maximum Length:
30The ID of the custom profile specification. -
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the Custom ProfileSpec.
-
lastUpdatedBy: string
The name of the person who updated.
-
lifecycleStatus: string
Indicates the current lifecycle status of the custom profile specification.
-
name(required): string
A string. Name of the Custom ProfileSpec.
-
profileCode: string
The profile code associated with the custom profile specification.
-
profileType(required): string
Allowed Values:
[ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP", "STANDARD_ZONE", "CUSTOM_ANALYZER_RULE", "POLICY_SPEC_TERM", "TIME_MODEL" ]The type or classification of the custom profile specification. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. - relatedParty: array relatedParty
-
targetProductSchema: object
TargetProductSchemaOracle
Title:
TargetProductSchemaOracle -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
A string. Custom ProfileSpec version.
-
versionState: number
The version state of the Customer Profile Specification.
array-
Array of:
object CharValueObjectRefOracle
Title:
CharValueObjectRefOracleThe Reference of the resource referred in CharValue of custom profile specification.
arrayarray-
Array of:
object CustomProfileSpecRel
Title:
CustomProfileSpecRelA migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.
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.
objectTargetProductSchemaOracle-
object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification. -
object
TargetProductSchemaOracle-allOf[1]
objectTimePeriod-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
objectCharValueObjectRefOracle-
@baseType: string
The base type of the characteristic value object reference.
-
@referredType(required): string
The type of the referred characteristic value object reference.
-
@schemaLocation: string
(uri)
The URI of the schema that defines the characteristic value object reference.
-
@type(required): string
The class type of the characteristic value object reference.
-
href: string
The hyperlink reference to the characteristic value object reference.
-
id(required): string
The ID of the characteristic value object reference.
-
name: string
The name of the characteristic value object reference.
-
resourceType: string
Allowed Values:
[ "SERVICE_SPEC" ]The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.
objectCustomProfileSpecRel-
href: string
The hyperlink reference to the custom profile specification rel.
-
id(required): string
The ID of the custom profile specification rel.
-
relationshipType(required): string
Allowed Values:
[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT", "CONDITION", "EXCLUDES", "REQUIRES", "ALLOWED" ]The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED. -
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party. -
versionState: number
The version state of the reference.
objectTimePeriodOracle-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
objectRelatedParty-
@baseType: string
The base type of the related party reference or party role reference.
-
@schemaLocation: string
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type(required): string
The class type of the related party reference or party role reference.
-
partyOrPartyRole(required):
partyOrPartyRole
A list of party or party roles associated with the related party reference or party role reference.
-
role: string
The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.
arrayobjectTargetProductSchema-
@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.
object-
subType: string
The type or classification of the target product schema.
Response
- application/json
201 Response
objectCustomProfileSpecificationOracle-
@baseType: string
The base type of the custom profile specification.
-
@schemaLocation: string
The URI of the schema that defines the custom profile specification.
-
@type(required): string
The class type of the custom profile specification.
-
applicationName: string
The name of the application associated with the custom profile specification.
-
charValueObject: array
charValueObject
A list of char value objects associated with the custom profile specification.
-
created: string
(date-time)
The date and time of creation.
-
createdBy: string
The name of the person who created.
-
customProfileSpecChar: array
customProfileSpecChar
A list of custom profile specification characteristics associated with the custom profile specification.
-
customProfileSpecRel: array
customProfileSpecRel
A list of custom profile specification rels associated with the custom profile specification.
-
description: string
A string. A narrative that explains in detail what the Custom ProfileSpec is.
-
externalId: string
The ID of the external associated with the custom profile specification.
-
href: string
A string. Reference of the Custom ProfileSpec.
-
id: string
Maximum Length:
30The ID of the custom profile specification. -
lastUpdate: string
(date-time)
A date time (DateTime). Date and time of the last update of the Custom ProfileSpec.
-
lastUpdatedBy: string
The name of the person who updated.
-
lifecycleStatus: string
Indicates the current lifecycle status of the custom profile specification.
-
name(required): string
A string. Name of the Custom ProfileSpec.
-
profileCode: string
The profile code associated with the custom profile specification.
-
profileType(required): string
Allowed Values:
[ "DEVICE_SPEC", "BUSINESS_CONFIG", "TRADE_IN", "CHARGING_TERM", "SUSPENSION_TERM", "RETURN_CHECKLIST", "ENTITY_PROFILE", "RENEWAL_TERM", "FINANCE_PLAN", "ZONE_VALUE_MAP", "STANDARD_ZONE", "CUSTOM_ANALYZER_RULE", "POLICY_SPEC_TERM", "TIME_MODEL" ]The type or classification of the custom profile specification. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. - relatedParty: array relatedParty
-
targetProductSchema: object
TargetProductSchemaOracle
Title:
TargetProductSchemaOracle -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
A string. Custom ProfileSpec version.
-
versionState: number
The version state of the Customer Profile Specification.
array-
Array of:
object CharValueObjectRefOracle
Title:
CharValueObjectRefOracleThe Reference of the resource referred in CharValue of custom profile specification.
arrayarray-
Array of:
object CustomProfileSpecRel
Title:
CustomProfileSpecRelA migration, substitution, dependency or exclusivity relationship between/among custom profile specifications.
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.
objectTargetProductSchemaOracle-
object
TargetProductSchema
Title:
TargetProductSchemaThe reference object to the schema and type of target product which is described by product specification. -
object
TargetProductSchemaOracle-allOf[1]
objectTimePeriod-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
objectCharValueObjectRefOracle-
@baseType: string
The base type of the characteristic value object reference.
-
@referredType(required): string
The type of the referred characteristic value object reference.
-
@schemaLocation: string
(uri)
The URI of the schema that defines the characteristic value object reference.
-
@type(required): string
The class type of the characteristic value object reference.
-
href: string
The hyperlink reference to the characteristic value object reference.
-
id(required): string
The ID of the characteristic value object reference.
-
name: string
The name of the characteristic value object reference.
-
resourceType: string
Allowed Values:
[ "SERVICE_SPEC" ]The type or classification of the characteristic value object reference. Valid values are SERVICE_SPEC.
objectCustomProfileSpecRel-
href: string
The hyperlink reference to the custom profile specification rel.
-
id(required): string
The ID of the custom profile specification rel.
-
relationshipType(required): string
Allowed Values:
[ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY", "PARENT", "CONDITION", "EXCLUDES", "REQUIRES", "ALLOWED" ]The type or classification of the custom profile specification rel. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, EXCLUSIVITY, PARENT, CONDITION, EXCLUDES, REQUIRES, and ALLOWED. -
validFor: object
TimePeriodOracle
Title:
TimePeriodOracleThe validity period of the related party. -
versionState: number
The version state of the reference.
objectTimePeriodOracle-
endDateTime: string
(date-time)
The end date and time of the time period.
-
startDateTime: string
(date-time)
The start date and time of the time period.
objectRelatedParty-
@baseType: string
The base type of the related party reference or party role reference.
-
@schemaLocation: string
A URI to a JSON-Schema file that defines additional attributes and relationships.
-
@type(required): string
The class type of the related party reference or party role reference.
-
partyOrPartyRole(required):
partyOrPartyRole
A list of party or party roles associated with the related party reference or party role reference.
-
role: string
The role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user'.
arrayobjectTargetProductSchema-
@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.
object-
subType: string
The type or classification of the target product schema.
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
- Creating custom profile specification using CHARGING_TERM
- Creating custom profile specification using SUSPENSION_TERM
- Creating custom profile specification of type Entity Profile
- Extending Finance Plan in custom profile specification
- Value Map Template using Custom Profile Specification
- Standard Zone using Custom Profile Specification
- Custom Analyzer Rule using Custom Profile Specification
- Policy Specification Term using Custom Profile Specification
- Time Model using Custom Profile Specification
Creating custom profile specification using CHARGING_TERM
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspec.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Basic Charging Term template 3",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2022-07-01T11:15:57.000Z",
"createdBy": "booth",
"lastUpdate": "2022-07-05T19:36:52.038Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"profileType": "CHARGING_TERM",
"customProfileSpecChar": [
{
"name": "Align Cycle",
"description": "The day the cycle charges apply and are applicable for recurring charges",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Activation Day",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Subscription Day",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Suspense Day",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Apply Taxes for Recurring",
"description": "Parameter that determines when tax need to be applied",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "At Billing",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "After computing charge",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "None",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Apply Taxes for Usage",
"description": "Parameter that determines when tax need to be applied",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "At Billing",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "After computing charge",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "None",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Apply Taxes for one time",
"description": "Parameter that determines when tax need to be applied",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "ONE_TIME",
"customProfileSpecCharValue": [
{
"value": "After computing charge",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "None",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "At suspense",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Bill Ahead Value",
"description": "Bill Ahead Value",
"valueType": "DECIMAL",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"allowedUnits": [
"DAYS",
"MONTHS"
]
},
{
"name": "Cancel Pro-ration",
"description": "Cancel Pro-ration applicable for recurring charges",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Prorate",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Do not prorate",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Discount For Part Of Cycle for Cycle",
"description": "Application of discount When discount is Valid for part of cycle",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start to validity end",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Discount For Part Of Cycle for Usage",
"description": "Application of discount When discount is Valid for part of cycle",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start to validity end",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Discount From Mid Cycle for Cycle",
"description": "Application of discount When discount is Valid from Mid-cycle",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Discount From Mid Cycle for Usage",
"description": "Application of discount When discount is Valid from Mid-cycle",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Discount Validity proration for Cycle",
"description": "Application of discount based on the discount validity",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharRel": [
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount to Mid Cycle for Cycle",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount For Part Of Cycle for Cycle",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount From Mid Cycle for Cycle",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
}
]
},
{
"name": "Discount Validity proration for Usage",
"description": "Application of discount based on the discount validity",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE",
"customProfileSpecCharRel": [
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount From Mid Cycle for Usage",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount to Mid Cycle for Usage",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount For Part Of Cycle for Usage",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
}
]
},
{
"name": "Discount to Mid Cycle for Cycle",
"description": "Application of discount When discount is Valid to Mid-cycle",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Apply to Validity end",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Discount to Mid Cycle for Usage",
"description": "Application of discount When discount is Valid to Mid-cycle",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "Apply to Validity end",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "In Advance Suspense",
"description": "Determines the unit of number of cycles for which the charges will be calculated and payment collected on order of a new subscription.",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "No Advance suspense",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Charge Ahead/ Value/Unit",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Increment Quantity",
"description": "Select the increment that is used to determine the charge",
"valueType": "DECIMAL",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE"
},
{
"name": "Minimum Quantity",
"description": "Enter the minimum quantity of the event that results in a fee",
"valueType": "DECIMAL",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE"
},
{
"name": "Purchase Pro-ration",
"description": "Purchase Pro-ration applicable for recurring charges",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Prorate",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
},
{
"value": "Do not prorate",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
}
}
]
},
{
"name": "Quantity Treatment",
"description": "Define the Quantity of units based on which charging should be done",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"characteristicType": "USAGE",
"customProfileSpecCharRel": [
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Rounding Increment Units",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Minimum Quantity",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Increment Quantity",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Rounding Mode",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"charSpecSeq": 0
}
]
},
{
"name": "Rounding Increment Units",
"description": "The units to which the rounding should be done",
"valueType": "DECIMAL",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"characteristicType": "USAGE"
},
{
"name": "Rounding Mode",
"description": "Select how the Usage event quantity is rounded",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "To the Nearest",
"valueType": "STRING",
"unitOfMeasure": "NONE",
"@type": "CustomProfileSpecCharValue",
"isDefault": true
},
{
"value": "Up",
"valueType": "STRING",
"unitOfMeasure": "NONE",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
},
{
"value": "Down",
"valueType": "STRING",
"unitOfMeasure": "NONE",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
}
]
},
{
"name": "Purchase Pro-ration for Rollover",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"active": true,
"characteristicType": "ROLLOVER",
"customProfileSpecCharValue": [
{
"value": "PRORATE_CHARGE",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "NO_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FULL_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Cancel Pro-ration for Rollover",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"active": true,
"characteristicType": "ROLLOVER",
"customProfileSpecCharValue": [
{
"value": "PRORATE_CHARGE",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "NO_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FULL_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Basic Charging Term template 3",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ATC_BASIC_CHARG_TERM_TEMP_3",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-19T07:40:00.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-19T07:40:00.711Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "CHARGING_TERM",
"customProfileSpecChar": [
{
"name": "Align Cycle",
"description": "The day the cycle charges apply and are applicable for recurring charges",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Activation Day",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Subscription Day",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Suspense Day",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Apply Taxes for Recurring",
"description": "Parameter that determines when tax need to be applied",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "At Billing",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "After computing charge",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "None",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Apply Taxes for Usage",
"description": "Parameter that determines when tax need to be applied",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "At Billing",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "After computing charge",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "None",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Apply Taxes for one time",
"description": "Parameter that determines when tax need to be applied",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "ONE_TIME",
"customProfileSpecCharValue": [
{
"value": "After computing charge",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "None",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "At suspense",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Bill Ahead Value",
"description": "Bill Ahead Value",
"valueType": "DECIMAL",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"allowedUnits": [
"DAYS",
"MONTHS"
]
},
{
"name": "Cancel Pro-ration",
"description": "Cancel Pro-ration applicable for recurring charges",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Prorate",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Do not prorate",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Discount For Part Of Cycle for Cycle",
"description": "Application of discount When discount is Valid for part of cycle",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start to validity end",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Discount For Part Of Cycle for Usage",
"description": "Application of discount When discount is Valid for part of cycle",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start to validity end",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Discount From Mid Cycle for Cycle",
"description": "Application of discount When discount is Valid from Mid-cycle",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Discount From Mid Cycle for Usage",
"description": "Application of discount When discount is Valid from Mid-cycle",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "Apply from Validity start",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Discount Validity proration for Cycle",
"description": "Application of discount based on the discount validity",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharRel": [
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount to Mid Cycle for Cycle",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount For Part Of Cycle for Cycle",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount From Mid Cycle for Cycle",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
}
]
},
{
"name": "Discount Validity proration for Usage",
"description": "Application of discount based on the discount validity",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharRel": [
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount From Mid Cycle for Usage",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount to Mid Cycle for Usage",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Discount For Part Of Cycle for Usage",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
}
]
},
{
"name": "Discount to Mid Cycle for Cycle",
"description": "Application of discount When discount is Valid to Mid-cycle",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Apply to Validity end",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Discount to Mid Cycle for Usage",
"description": "Application of discount When discount is Valid to Mid-cycle",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "Apply to Validity end",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Apply to full cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Dont apply to this cycle",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Not applicable",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "In Advance Suspense",
"description": "Determines the unit of number of cycles for which the charges will be calculated and payment collected on order of a new subscription.",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "No Advance suspense",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Charge Ahead/ Value/Unit",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Increment Quantity",
"description": "Select the increment that is used to determine the charge",
"valueType": "DECIMAL",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE"
},
{
"name": "Minimum Quantity",
"description": "Enter the minimum quantity of the event that results in a fee",
"valueType": "DECIMAL",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE"
},
{
"name": "Purchase Pro-ration",
"description": "Purchase Pro-ration applicable for recurring charges",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "RECURRING",
"customProfileSpecCharValue": [
{
"value": "Prorate",
"valueType": "STRING",
"isDefault": true,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Do not prorate",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Quantity Treatment",
"description": "Define the Quantity of units based on which charging should be done",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharRel": [
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Rounding Increment Units",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Minimum Quantity",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Increment Quantity",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
},
{
"id": "ATC_BASIC_CHARG_TERM_TEMP_3",
"name": "Rounding Mode",
"relationshipType": "AGGREGATION",
"validFor": {
"startDateTime": "2022-07-05T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 0
}
]
},
{
"name": "Rounding Increment Units",
"description": "The units to which the rounding should be done",
"valueType": "DECIMAL",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"characteristicType": "USAGE"
},
{
"name": "Rounding Mode",
"description": "Select how the Usage event quantity is rounded",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"characteristicType": "USAGE",
"customProfileSpecCharValue": [
{
"value": "To the Nearest",
"valueType": "STRING",
"unitOfMeasure": "NONE",
"isDefault": true,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Up",
"valueType": "STRING",
"unitOfMeasure": "NONE",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Down",
"valueType": "STRING",
"unitOfMeasure": "NONE",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Purchase Pro-ration for Rollover",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"active": true,
"characteristicType": "ROLLOVER",
"customProfileSpecCharValue": [
{
"value": "PRORATE_CHARGE",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "NO_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FULL_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Cancel Pro-ration for Rollover",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"active": true,
"characteristicType": "ROLLOVER",
"customProfileSpecCharValue": [
{
"value": "PRORATE_CHARGE",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "NO_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FULL_CHARGE",
"valueType": "STRING",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-16T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
}
]
}
Creating custom profile specification using SUSPENSION_TERM
cURL Command
curl -u username:password -H POST \
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ \
-H 'Content-Type: application/json' -D @post_customerprofspecsuspensionterm.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "PSP Suspension Term template",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"profileType": "SUSPENSION_TERM",
"customProfileSpecChar": [
{
"name": "Contract Duration",
"description": "The impact to contract duration due to suspension",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Original Duration",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Extended Duration",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
}
]
},
{
"name": "Duration",
"description": "Duration of suspension",
"valueType": "NUMBER",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"allowedUnits": [
"DAYS",
"MONTHS"
]
},
{
"name": "Duration Of Suspension",
"description": "Define the suspension duration",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"customProfileSpecCharRel": [
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "Duration",
"charSpecSeq": 1,
"@type": "CustomProfileSpecCharRel",
"relationshipType": "AGGREGATION"
},
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "Contract Duration",
"charSpecSeq": 2,
"@type": "CustomProfileSpecCharRel",
"relationshipType": "AGGREGATION"
},
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "Upgrade Eligibility Duration",
"charSpecSeq": 3,
"@type": "CustomProfileSpecCharRel",
"relationshipType": "AGGREGATION"
}
]
},
{
"name": "Maximum Number Of Bill Suspensions",
"description": "Number of Bill suspensions allowed",
"valueType": "NUMBER",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar"
},
{
"name": "Suspend Resume Terms",
"description": "Terms to resume suspension",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Suspense At Regular Rate",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"isDefault": true
},
{
"value": "No Suspense",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
},
{
"value": "Suspense At Reduced Rate",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
}
]
},
{
"name": "Upgrade Eligibility Duration",
"description": "The impact to upgrade eligibility duration due to suspension",
"valueType": "STRING",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Original Contract Duration",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"isDefault": true
},
{
"value": "Extended Duration",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
}
]
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "PSP Suspension Term template",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ATC_SUSPENSION_TERM_TEMP",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-19T11:46:55.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-19T11:46:55.178Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"versionState": 0,
"profileType": "SUSPENSION_TERM",
"customProfileSpecChar": [
{
"name": "Contract Duration",
"description": "The impact to contract duration due to suspension",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"customProfileSpecCharValue": [
{
"value": "Original Duration",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Extended Duration",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Duration",
"description": "Duration of suspension",
"valueType": "NUMBER",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"allowedUnits": [
"DAYS",
"MONTHS"
]
},
{
"name": "Duration Of Suspension",
"description": "Define the suspension duration",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"customProfileSpecCharRel": [
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "Duration",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
},
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "Contract Duration",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 2
},
{
"id": "ATC_SUSPENSION_TERM_TEMP",
"name": "Upgrade Eligibility Duration",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 3
}
]
},
{
"name": "Maximum Number Of Bill Suspensions",
"description": "Number of Bill suspensions allowed",
"valueType": "NUMBER",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true
},
{
"name": "Suspend Resume Terms",
"description": "Terms to resume suspension",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"customProfileSpecCharValue": [
{
"value": "Suspense At Regular Rate",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "No Suspense",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Suspense At Reduced Rate",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Upgrade Eligibility Duration",
"description": "The impact to upgrade eligibility duration due to suspension",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"minCardinality": 0,
"maxCardinality": 1,
"active": true,
"customProfileSpecCharValue": [
{
"value": "Original Contract Duration",
"valueType": "STRING",
"isDefault": true,
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Extended Duration",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
}
]
}
Creating custom profile specification of type Entity Profile
You could then set modeling rules for design-time features available for a service provider, ensuring the design-time application follows the applied restrictions resulting in an error-free publishing to runtime applications. Such restrictions are based on the service provider's ecosystem and not on individual runtime applications. Which means, there could only be one restriction for the ecosystem and not for each runtime application. You can achieve this by setting up an entity profile.
The following examples show how to create a custom profile specification of type entity profile. This example has a rule that restricts only one commitment term for Product Offering entity of the type package.
cURL Command
curl -u username:password -H POST \
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ \
-H 'Content-Type: application/json' -D @post_customerprofspecsuspensionterm.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "ProductOfferingOracle",
"name": "Product Offering",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"profileType": "ENTITY_PROFILE",
"targetProductSchema": {
"@type": "ProductOfferingOracle",
"@schemaLocation": "ProductOfferingOracle.yml"
},
"customProfileSpecChar": [
{
"name": "Product Offering",
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2025-02-19T12:52:27.387Z"
},
"active": true,
"characteristicType": "RULE",
"customProfileSpecCharRel": [
{
"id": "ProductOfferingOracle",
"name": "Product Offering_info_productType",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecRel"
}
]
},
{
"name": "Product Offering_info_productType",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "FEATURE",
"attributeName": "productOfferingInfo.productType",
"customProfileSpecCharRel": [
{
"id": "ProductOfferingOracle",
"name": "condition_productType_package",
"relationshipType": "CONDITION",
"@type": "CustomProfileSpecRel"
}
]
},
{
"name": "condition_productType_package",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "ATTRIBUTE",
"attributeName": "productOfferingInfo.productType",
"customProfileSpecCharValue": [
{
"value": "PACKAGE",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "ProductOfferingOracle",
"name": "requires_term_type_commitmentTerm",
"relationshipType": "REQUIRES",
"@type": "CustomProfileSpecRel"
}
]
},
{
"name": "requires_term_type_commitmentTerm",
"@type": "CustomProfileSpecChar",
"minCardinality": 1,
"maxCardinality": 1,
"active": true,
"characteristicType": "ATTRIBUTE",
"attributeName": "productOfferingTerm[commitmentTermType=='SERVICE']"
}
],
"applicationName": "ALL"
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "ProductOfferingOracle",
"name": "Product Offering",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ProductOfferingOracle",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-19T12:53:26.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-19T12:53:26.072Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"versionState": 0,
"profileType": "ENTITY_PROFILE",
"targetProductSchema": {
"@type": "ProductOfferingOracle",
"@schemaLocation": "ProductOfferingOracle.yml"
},
"customProfileSpecChar": [
{
"name": "Product Offering",
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2025-02-19T12:52:27.387Z"
},
"active": true,
"characteristicType": "RULE",
"customProfileSpecCharRel": [
{
"id": "ProductOfferingOracle",
"name": "Product Offering_info_productType",
"relationshipType": "AGGREGATION",
"@type": "CustomProfileSpecRel"
}
]
},
{
"name": "Product Offering_info_productType",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "FEATURE",
"attributeName": "productOfferingInfo.productType",
"customProfileSpecCharRel": [
{
"id": "ProductOfferingOracle",
"name": "condition_productType_package",
"relationshipType": "CONDITION",
"@type": "CustomProfileSpecRel"
}
]
},
{
"name": "condition_productType_package",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "ATTRIBUTE",
"attributeName": "productOfferingInfo.productType",
"customProfileSpecCharValue": [
{
"value": "PACKAGE",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "ProductOfferingOracle",
"name": "requires_term_type_commitmentTerm",
"relationshipType": "REQUIRES",
"@type": "CustomProfileSpecRel"
}
]
},
{
"name": "requires_term_type_commitmentTerm",
"@type": "CustomProfileSpecChar",
"minCardinality": 1,
"maxCardinality": 1,
"active": true,
"characteristicType": "ATTRIBUTE",
"attributeName": "productOfferingTerm[commitmentTermType=='SERVICE']"
}
],
"applicationName": "ALL"
}
Extending Finance Plan in custom profile specification
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspecfinance.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "GlobalFinancePlan",
"name": "GlobalFinancePlan",
"description": "The Global Finance Plan sets the amortization details for interest based installment plans ",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "FINANCE_PLAN",
"customProfileSpecChar": [
{
"name": "INTEREST_TYPE",
"displayText": "Interest Type",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"characteristicType": "LOOKUP"
},
{
"name": "PATTERN_TYPE",
"displayText": "Pattern Type",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"characteristicType": "LOOKUP"
},
{
"name": "FINANCE_TERM_PERIOD",
"displayText": "Duration",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"characteristicType": "LOOKUP"
},
{
"name": "InterestDetails",
"displayText": "Interest Details",
"valueType": "DECIMAL",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"valueTo": "1",
"value": 1.0,
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"valueTo": "2",
"value": 0.5,
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"valueTo": "3",
"value": 0.357,
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "InterestConcession",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"valueTo": "1",
"value": 4.0,
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"valueTo": "2",
"value": 3.0,
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"valueTo": "3",
"value": 5.0,
"valueType": "DECIMAL",
"@type": "CustomProfileSpecCharValue",
"isDefault": false
}
],
"customProfileSpecCharRel": [
{
"charSpecSeq": 1,
"id": "GlobalFinancePlan",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"name": "interestDetails"
}
]
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "GlobalFinancePlan",
"name": "GlobalFinancePlan",
"description": "The Global Finance Plan sets the amortization details for interest based installment plans ",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/GlobalFinancePlan",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-19T12:59:34.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-19T12:59:34.157Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "FINANCE_PLAN",
"customProfileSpecChar": [
{
"name": "INTEREST_TYPE",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Interest Type",
"active": true,
"characteristicType": "LOOKUP"
},
{
"name": "PATTERN_TYPE",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Pattern Type",
"active": true,
"characteristicType": "LOOKUP"
},
{
"name": "FINANCE_TERM_PERIOD",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Duration",
"active": true,
"characteristicType": "LOOKUP"
},
{
"name": "InterestDetails",
"valueType": "DECIMAL",
"@type": "CustomProfileSpecChar",
"displayText": "Interest Details",
"active": true,
"customProfileSpecCharValue": [
{
"value": 1.0,
"valueTo": "1",
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": 0.5,
"valueTo": "2",
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": 0.357,
"valueTo": "3",
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "InterestConcession",
"@type": "CustomProfileSpecChar",
"active": true,
"customProfileSpecCharValue": [
{
"value": 4.0,
"valueTo": "1",
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": 3.0,
"valueTo": "2",
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
},
{
"value": 5.0,
"valueTo": "3",
"valueType": "DECIMAL",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "GlobalFinancePlan",
"name": "interestDetails",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
}
]
}
Value Map Template for Custom Profile Specification
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspecvaluemap.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "Europe_Value_Map",
"name": "Europe Value Map",
"description": "This describes zones for Europe Value Map",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "ZONE_VALUE_MAP",
"customProfileSpecChar": [
{
"name": "*",
"valueType": "STRING",
"extensible": true,
"displayText": "*",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING"
},
{
"name": "213",
"valueType": "STRING",
"extensible": true,
"displayText": "213",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Germany",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "214",
"valueType": "STRING",
"extensible": true,
"displayText": "214",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Austria",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "707",
"valueType": "STRING",
"extensible": true,
"displayText": "707",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Onnet",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "765",
"valueType": "STRING",
"extensible": true,
"displayText": "765",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Fixed",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "786",
"valueType": "STRING",
"extensible": true,
"displayText": "786",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Offnet",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Austria",
"valueType": "STRING",
"displayText": "Austria",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Fixed",
"valueType": "STRING",
"displayText": "Fixed",
"active": true,
"@type": "CustomProfileSpecChar",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Germany",
"valueType": "STRING",
"displayText": "Germany",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Latvia",
"valueType": "STRING",
"extensible": true,
"displayText": "Latvia",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING"
},
{
"name": "Offnet",
"valueType": "STRING",
"displayText": "Offnet",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Onnet",
"valueType": "STRING",
"extensible": true,
"displayText": "Onnet",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "Europe_Value_Map",
"name": "Europe Value Map",
"description": "This describes zones for Europe Value Map",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/Europe_Value_Map",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-19T13:08:42.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-19T13:08:42.177Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "ZONE_VALUE_MAP",
"customProfileSpecChar": [
{
"name": "*",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "*",
"active": true,
"characteristicType": "STRING"
},
{
"name": "213",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "213",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Germany",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "214",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "214",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Austria",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "707",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "707",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Onnet",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "765",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "765",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Fixed",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "786",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "786",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Offnet",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Austria",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Austria",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Fixed",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Fixed",
"active": true,
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Germany",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Germany",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Latvia",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "Latvia",
"active": true,
"characteristicType": "STRING"
},
{
"name": "Offnet",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Offnet",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "Onnet",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"extensible": true,
"displayText": "Onnet",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharRel": [
{
"id": "Europe_Value_Map",
"name": "Latvia",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
}
]
}
Standard Zone for Custom Profile Specification
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspecstandardzone.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "UKStandardZone",
"name": "UKStandardZone",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "STANDARD_ZONE",
"customProfileSpecChar": [
{
"name": "IC_Global",
"description": "IC_Global",
"valueType": "STRING",
"active": true,
"characteristicType": "STRING",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Rule1",
"valueTo": "156",
"valueFrom": "801",
"valueType": "STRING",
"valueReferenceId": "All",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_Bhutan",
"description": "IC_Bhutan",
"valueType": "STRING",
"active": true,
"characteristicType": "STRING",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Rule2",
"valueTo": "15",
"valueFrom": "801",
"valueType": "STRING",
"valueReferenceId": "All",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_EEU",
"description": "IC_EEU",
"valueType": "STRING",
"active": true,
"characteristicType": "STRING",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Rule9",
"valueTo": "820.0",
"valueFrom": "311.0",
"valueType": "STRING",
"valueReferenceId": "ServiceSpecGprs",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_International",
"description": "IC_International",
"valueType": "STRING",
"active": true,
"characteristicType": "STRING",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Rule2",
"valueTo": "321.0",
"valueFrom": "913.0",
"valueType": "STRING",
"valueReferenceId": "ServiceSpecGsm",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Rule1",
"valueTo": "891.0",
"valueFrom": "945.0",
"valueReferenceId": "ServiceSpecGprs",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Rule3",
"valueTo": "563.0",
"valueFrom": "256.0",
"valueReferenceId": "All",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_National",
"description": "IC_National",
"valueType": "STRING",
"active": true,
"characteristicType": "STRING",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Rule3",
"valueTo": "567.0",
"valueFrom": "913.0",
"valueType": "STRING",
"valueReferenceId": "ServiceSpecGsm",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_RegionY",
"description": "IC_RegionY",
"valueType": "STRING",
"active": true,
"characteristicType": "STRING",
"@type": "CustomProfileSpecChar",
"customProfileSpecCharValue": [
{
"value": "Rule7",
"valueTo": "520.0",
"valueFrom": "911.0",
"valueType": "STRING",
"valueReferenceId": "ServiceSpecGsm",
"valueReferenceType": "SERVICE_SPEC",
"@type": "CustomProfileSpecCharValue"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IMPACT_CATEGORY",
"valueType": "STRING",
"displayText": "Impact Category",
"active": true,
"@type": "CustomProfileSpecChar",
"characteristicType": "STRING"
}
],
"charValueObject": [
{
"id": "ServiceSpecGprs",
"name": "TelcoGprs",
"version": "1.0",
"@type": "CharValueObjectRefOracle",
"@referredType": "ServiceSpecificationOracle",
"resourceType": "SERVICE_SPEC"
},
{
"id": "ServiceSpecGsm",
"name": "TelcoGsm",
"version": "1.0",
"@type": "CharValueObjectRefOracle",
"@referredType": "ServiceSpecificationOracle",
"resourceType": "SERVICE_SPEC"
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "UKStandardZone",
"name": "UKStandardZone",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/UKStandardZone",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-02-19T13:20:13.000Z",
"createdBy": "booth",
"lastUpdate": "2025-02-19T13:20:13.182Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "DBE_RI_ProdModel_PreSeed_PSP",
"name": "DBE RI Product Model Preseed",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_RI_ProdModel_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "STANDARD_ZONE",
"customProfileSpecChar": [
{
"name": "IC_Global",
"description": "IC_Global",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Rule1",
"valueTo": "156",
"valueFrom": "801",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "All",
"valueReferenceType": "SERVICE_SPEC"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_Bhutan",
"description": "IC_Bhutan",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Rule2",
"valueTo": "15",
"valueFrom": "801",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "All",
"valueReferenceType": "SERVICE_SPEC"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_EEU",
"description": "IC_EEU",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Rule9",
"valueTo": "820.0",
"valueFrom": "311.0",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "ServiceSpecGprs",
"valueReferenceType": "SERVICE_SPEC"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_International",
"description": "IC_International",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Rule2",
"valueTo": "321.0",
"valueFrom": "913.0",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "ServiceSpecGsm",
"valueReferenceType": "SERVICE_SPEC"
},
{
"value": "Rule1",
"valueTo": "891.0",
"valueFrom": "945.0",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "ServiceSpecGprs",
"valueReferenceType": "SERVICE_SPEC"
},
{
"value": "Rule3",
"valueTo": "563.0",
"valueFrom": "256.0",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "All",
"valueReferenceType": "SERVICE_SPEC"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_National",
"description": "IC_National",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Rule3",
"valueTo": "567.0",
"valueFrom": "913.0",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "ServiceSpecGsm",
"valueReferenceType": "SERVICE_SPEC"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IC_RegionY",
"description": "IC_RegionY",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Rule7",
"valueTo": "520.0",
"valueFrom": "911.0",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue",
"valueReferenceId": "ServiceSpecGsm",
"valueReferenceType": "SERVICE_SPEC"
}
],
"customProfileSpecCharRel": [
{
"id": "UKStandardZone",
"name": "IMPACT_CATEGORY",
"relationshipType": "PARENT",
"@type": "CustomProfileSpecCharRel",
"charSpecSeq": 1
}
]
},
{
"name": "IMPACT_CATEGORY",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Impact Category",
"active": true,
"characteristicType": "STRING"
}
],
"charValueObject": [
{
"id": "ServiceSpecGprs",
"name": "TelcoGprs",
"version": "1.0",
"@referredType": "ServiceSpecificationOracle",
"@type": "CharValueObjectRefOracle",
"resourceType": "SERVICE_SPEC"
},
{
"id": "ServiceSpecGsm",
"name": "TelcoGsm",
"version": "1.0",
"@referredType": "ServiceSpecificationOracle",
"@type": "CharValueObjectRefOracle",
"resourceType": "SERVICE_SPEC"
}
]
}
Custom Analyzer Rule using Custom Profile Specification
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspec.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "TEST_RULE_ID",
"name": "TEST_RULE",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"versionState": 0,
"profileType": "CUSTOM_ANALYZER_RULE",
"customProfileSpecChar": [
{
"name": "CONDITION",
"description": "Description",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"active": true,
"customProfileSpecCharValue": [
{
"value": "CONDITION_DESCRIPTION",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "TEST_RULE",
"description": "DESCRIPTION",
"valueType": "BOOLEAN",
"@type": "CustomProfileSpecChar",
"configurable": true,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"active": true,
"customProfileSpecCharValue": [
{
"value": true,
"valueType": "BOOLEAN",
"isDefault": true,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": false,
"valueType": "BOOLEAN",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "TEST_RULE_ID",
"name": "TEST_RULE",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/TEST_RULE_ID",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-05-02T09:11:13.000Z",
"createdBy": "booth",
"lastUpdate": "2025-05-02T09:11:13.136Z",
"lastUpdatedBy": "booth",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"versionState": 0,
"profileType": "CUSTOM_ANALYZER_RULE",
"customProfileSpecChar": [
{
"name": "CONDITION",
"description": "Description",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"configurable": true,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"active": true,
"customProfileSpecCharValue": [
{
"value": "CONDITION_DESCRIPTION",
"valueType": "STRING",
"isDefault": false,
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "TEST_RULE",
"description": "DESCRIPTION",
"valueType": "BOOLEAN",
"@type": "CustomProfileSpecChar",
"configurable": true,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"active": true,
"customProfileSpecCharValue": [
{
"value": true,
"valueType": "BOOLEAN",
"isDefault": true,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": false,
"valueType": "BOOLEAN",
"isDefault": false,
"validFor": {
"startDateTime": "2025-01-03T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
]
}
]
}
Policy Specification Term using Custom Profile Specification
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspec.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "CPS-POLICY-SPEC",
"name": "PolicySpec",
"description": "Rule that sends alerts to the user when they use most or all of their data.",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2025-01-07T00:00:00.000Z"
},
"project": {
"id": "P-693379996-1735908512172",
"name": "TestInit",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "POLICY_SPEC_TERM",
"customProfileSpecChar": [
{
"name": "Internet_Speed",
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"active": true,
"allowedUnits": [
"MEGABYTE"
],
"customProfileSpecCharValue": [
{
"value": "Low Quality of Service",
"valueTo": "50",
"valueFrom": "100",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "High_Quality_of_Service",
"valueTo": "50",
"valueFrom": "1",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
],
"balanceElementCode": "MINUTES",
"balanceElement": {
"id": "MINUTES",
"name": "MINUTES",
"@referredType": "BalanceElementOracle",
"@type": "BalanceElementRef",
"version": "1.0"
}
},
{
"name": "Quality of Service",
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"active": true,
"allowedUnits": [
"MEGABYTE"
],
"customProfileSpecCharValue": [
{
"value": "High Quality of Service",
"valueTo": "50",
"valueFrom": "1",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Low Quality of Service",
"valueTo": "50",
"valueFrom": "100",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
],
"balanceElementCode": "MINUTES",
"balanceElement": {
"id": "MINUTES",
"name": "MINUTES",
"@referredType": "BalanceElementOracle",
"@type": "BalanceElementRef",
"version": "1.0"
}
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "CPS-POLICY-SPEC",
"name": "PolicySpec",
"description": "Rule that sends alerts to the user when they use most or all of their data.",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/CPS-POLICY-SPEC",
"version": "1.0",
"lifecycleStatus": "In design",
"@type": "CustomProfileSpecificationOracle",
"validFor": {
"startDateTime": "2025-01-07T00:00:00.000Z"
},
"created": "2025-07-30T07:32:51.000Z",
"createdBy": "booth",
"lastUpdate": "2025-07-30T09:50:45.257Z",
"lastUpdatedBy": "booth",
"project": {
"id": "P-693379996-1735908512172",
"name": "TestInit",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"versionState": 0,
"profileType": "POLICY_SPEC_TERM",
"customProfileSpecChar": [
{
"name": "Internet_Speed",
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"active": true,
"allowedUnits": [
"MEGABYTE"
],
"customProfileSpecCharValue": [
{
"value": "Low Quality of Service",
"valueTo": "50",
"valueFrom": "100",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "High_Quality_of_Service",
"valueTo": "50",
"valueFrom": "1",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
],
"balanceElementCode": "MINUTES",
"balanceElement": {
"id": "MINUTES",
"name": "MINUTES",
"@referredType": "BalanceElementOracle",
"@type": "BalanceElementRef",
"version": "1.0"
}
},
{
"name": "Quality of Service",
"@type": "CustomProfileSpecChar",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"active": true,
"allowedUnits": [
"MEGABYTE"
],
"customProfileSpecCharValue": [
{
"value": "High Quality of Service",
"valueTo": "50",
"valueFrom": "1",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
},
{
"value": "Low Quality of Service",
"valueTo": "50",
"valueFrom": "100",
"valueType": "SPEC_CHAR",
"validFor": {
"startDateTime": "2025-06-10T00:00:00.000Z"
},
"@type": "CustomProfileSpecCharValue"
}
],
"balanceElementCode": "MINUTES",
"balanceElement": {
"id": "MINUTES",
"name": "MINUTES",
"@referredType": "BalanceElementOracle",
"@type": "BalanceElementRef",
"version": "1.0"
}
}
]
}
Time Mode using Custom Profile Specification
cURL Command
curl -u username:password -H POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/ -H 'Content-Type: application/json' -D @post_customprofspec.json | json_pp
Example of Request Body
The following shows an example of the request body.
{
"id": "US_TIME_MODEL",
"name": "US TIME MODEL",
"href": "http://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/US_TIME_MODEL",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-11-11T03:17:58.000Z",
"createdBy": "FUSION",
"lastUpdate": "2025-11-11T03:18:00.188Z",
"lastUpdatedBy": "FUSION",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "P_2070266466_1765876172595",
"name": "26B-TOD-Init",
"href": "http://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_25C_RI_Model_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"isLocked": false,
"versionState": 0,
"profileType": "TIME_MODEL",
"customProfileSpecChar": [
{
"name": "OffPeak",
"description": "OffPeak",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Monday,Tueday,Wednesday,Thursday;Any Month of the Year",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FRIDAY;00:00:00-15:00:00",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Peak",
"description": "Peak",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "All Day;Saturday,Sunday",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FRIDAY;15:00:00-19:00:00",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "TIME_PERIOD",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Time period",
"active": true,
"characteristicType": "STRING"
}
]
}
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"id": "US_TIME_MODEL",
"name": "US TIME MODEL",
"href": "http://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/customProfileSpecification/US_TIME_MODEL",
"version": "1.0",
"lifecycleStatus": "In design",
"created": "2025-11-11T03:17:58.000Z",
"createdBy": "FUSION",
"lastUpdate": "2025-11-11T03:18:00.188Z",
"lastUpdatedBy": "FUSION",
"@type": "CustomProfileSpecificationOracle",
"project": {
"id": "P_2070266466_1765876172595",
"name": "26B-TOD-Init",
"href": "http://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/DBE_25C_RI_Model_PreSeed_PSP",
"version": "1.0",
"@referredType": "ProjectOracle"
},
"isLocked": false,
"versionState": 0,
"profileType": "TIME_MODEL",
"customProfileSpecChar": [
{
"name": "OffPeak",
"description": "OffPeak",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "Monday,Tueday,Wednesday,Thursday;Any Month of the Year",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FRIDAY;00:00:00-15:00:00",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "Peak",
"description": "Peak",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"active": true,
"characteristicType": "STRING",
"customProfileSpecCharValue": [
{
"value": "All Day;Saturday,Sunday",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
},
{
"value": "FRIDAY;15:00:00-19:00:00",
"valueType": "STRING",
"@type": "CustomProfileSpecCharValue"
}
]
},
{
"name": "TIME_PERIOD",
"valueType": "STRING",
"@type": "CustomProfileSpecChar",
"displayText": "Time period",
"active": true,
"characteristicType": "STRING"
}
]
}