Create or update an array of pricing logic algorithms
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithms
Request
There are no request parameters for this operation.
- application/json
array150-
Array of:
PlaQuantityRangeOracle
Title:
PlaQuantityRangeOracle
PlaQuantityRangeOracle-
object
PricingLogicAlgorithm
Title:
PricingLogicAlgorithmDiscriminator:{ "propertyName":"@type", "mapping":{ "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm", "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle" } }The pricing logic algorithm resource. -
object
type
objectPricingLogicAlgorithmDiscriminator Values
-
@baseType: string
The base type of the pricing logic algorithm.
-
@schemaLocation: string
The URI of the schema that defines the pricing logic algorithm.
-
@type(required): string
The class type of the pricing logic algorithm.
-
customProfileSpec: array
customProfileSpec
A list of custom profile specifications associated with the pricing logic algorithm.
-
description: string
The description of this pla.
-
href: string
The hyperlink reference to the pricing logic algorithm.
-
id: string
Maximum Length:
30The ID of the pricing logic algorithm. -
lastUpdate: string
(date-time)
The date and time when the pricing logic algorithm was last updated.
-
lifecycleStatus: string
The status of the pricing logic algorithm.
-
name: string
The name of the pricing logic algorithm.
-
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRefA pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The pla version.
object-
applicationName: string
The name of the application associated with the pricing logic algorithm quantity range.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the pricing logic algorithm quantity range.
-
lastUpdate: string
(date-time)
The date and time when the pricing logic algorithm quantity range was last updated.
-
lastUpdatedBy: string
The name of the person who updated item.
-
plaCharacteristic: array
plaCharacteristic
A list of pla characteristics associated with the pricing logic algorithm quantity range.
-
pricingType: string
Allowed Values:
[ "SIMPLE", "TIERED" ]The type or classification of the pricing logic algorithm quantity range. Valid values are SIMPLE, and TIERED. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
tierRange: array
tierRange
A list of tier ranges associated with the pricing logic algorithm quantity range.
-
versionState: number
The version state of the Pricing Logic Algorithm.
array-
Array of:
object PlaCharacteristicOracle
Title:
PlaCharacteristicOracleA use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.
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.
array-
Array of:
object TierRangeOracle
Title:
TierRangeOracleContains the minimum and maximum quantity for which the pricing is applicable.
objectPlaCharacteristicOracle-
description: string
A narrative that explains in detail what the productSpecCharacteristic is.
-
name: string
The name of the pricing logic algorithm characteristic.
-
plaCharacteristicValue: array
plaCharacteristicValue
A list of pla characteristic values associated with the pricing logic algorithm characteristic.
-
valueType: string
The type or classification of the pricing logic algorithm characteristic.
array-
Array of:
object PlaCharacteristicValueOracle
Title:
PlaCharacteristicValueOracleA number or text that can be assigned to a ProductSpecCharacteristic.
objectPlaCharacteristicValueOracle-
unitOfMeasure: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]The unit can be minutes or GB. -
value:
value
A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
objectobjectTierRangeOracle-
inclusivity: string
Allowed Values:
[ "UPPER_INCLUSIVE", "LOWER_INCLUSIVE" ]Specifies whether to include the upper limit or lower limit. Valid values are UPPER_INCLUSIVE and LOWER_INCLUSIVE. -
maxQuantity: integer
A maximum quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
minQuantity: integer
A minimum quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
productOfferingPrice: array
productOfferingPrice
A list of product offering prices associated with the tier range.
array-
Array of:
object ProductOfferingPriceRef
Title:
ProductOfferingPriceRefThe productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
objectProductOfferingPriceRef-
@baseType: string
The base type of the product offering price reference.
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
The URI of the schema that defines the product offering price reference.
-
@type(required): string
The class type of the product offering price reference.
-
href: string
The hyperlink reference to the product offering price reference.
-
id(required): string
The ID of the product offering price reference.
-
name: string
The name of the product offering price reference.
-
refId: string
The ID of the ref associated with the product offering price reference.
-
refName: string
The name of the ref associated with the product offering price reference.
-
version: string
The version of a related entity.
-
versionState: number
The version state of the reference.
Response
- application/json
200 Response
array-
Array of:
PlaQuantityRangeOracle
Title:
PlaQuantityRangeOracle
PlaQuantityRangeOracle-
object
PricingLogicAlgorithm
Title:
PricingLogicAlgorithmDiscriminator:{ "propertyName":"@type", "mapping":{ "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm", "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle" } }The pricing logic algorithm resource. -
object
type
objectPricingLogicAlgorithmDiscriminator Values
-
@baseType: string
The base type of the pricing logic algorithm.
-
@schemaLocation: string
The URI of the schema that defines the pricing logic algorithm.
-
@type(required): string
The class type of the pricing logic algorithm.
-
customProfileSpec: array
customProfileSpec
A list of custom profile specifications associated with the pricing logic algorithm.
-
description: string
The description of this pla.
-
href: string
The hyperlink reference to the pricing logic algorithm.
-
id: string
Maximum Length:
30The ID of the pricing logic algorithm. -
lastUpdate: string
(date-time)
The date and time when the pricing logic algorithm was last updated.
-
lifecycleStatus: string
The status of the pricing logic algorithm.
-
name: string
The name of the pricing logic algorithm.
-
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRefA pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
validFor: object
TimePeriod
Title:
TimePeriodThe period for which the productOffering is valid. -
version: string
The pla version.
object-
applicationName: string
The name of the application associated with the pricing logic algorithm quantity range.
-
created: string
(date-time)
The date and time of the creation.
-
createdBy: string
The name of the person who created item.
-
externalId: string
The ID of the external associated with the pricing logic algorithm quantity range.
-
lastUpdate: string
(date-time)
The date and time when the pricing logic algorithm quantity range was last updated.
-
lastUpdatedBy: string
The name of the person who updated item.
-
plaCharacteristic: array
plaCharacteristic
A list of pla characteristics associated with the pricing logic algorithm quantity range.
-
pricingType: string
Allowed Values:
[ "SIMPLE", "TIERED" ]The type or classification of the pricing logic algorithm quantity range. Valid values are SIMPLE, and TIERED. -
project: object
ProjectRef
Title:
ProjectRefThe project reference resource. -
tierRange: array
tierRange
A list of tier ranges associated with the pricing logic algorithm quantity range.
-
versionState: number
The version state of the Pricing Logic Algorithm.
array-
Array of:
object PlaCharacteristicOracle
Title:
PlaCharacteristicOracleA use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.
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.
array-
Array of:
object TierRangeOracle
Title:
TierRangeOracleContains the minimum and maximum quantity for which the pricing is applicable.
objectPlaCharacteristicOracle-
description: string
A narrative that explains in detail what the productSpecCharacteristic is.
-
name: string
The name of the pricing logic algorithm characteristic.
-
plaCharacteristicValue: array
plaCharacteristicValue
A list of pla characteristic values associated with the pricing logic algorithm characteristic.
-
valueType: string
The type or classification of the pricing logic algorithm characteristic.
array-
Array of:
object PlaCharacteristicValueOracle
Title:
PlaCharacteristicValueOracleA number or text that can be assigned to a ProductSpecCharacteristic.
objectPlaCharacteristicValueOracle-
unitOfMeasure: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]The unit can be minutes or GB. -
value:
value
A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
objectobjectTierRangeOracle-
inclusivity: string
Allowed Values:
[ "UPPER_INCLUSIVE", "LOWER_INCLUSIVE" ]Specifies whether to include the upper limit or lower limit. Valid values are UPPER_INCLUSIVE and LOWER_INCLUSIVE. -
maxQuantity: integer
A maximum quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
minQuantity: integer
A minimum quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
-
productOfferingPrice: array
productOfferingPrice
A list of product offering prices associated with the tier range.
array-
Array of:
object ProductOfferingPriceRef
Title:
ProductOfferingPriceRefThe productPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased.
objectProductOfferingPriceRef-
@baseType: string
The base type of the product offering price reference.
-
@referredType(required): string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
The URI of the schema that defines the product offering price reference.
-
@type(required): string
The class type of the product offering price reference.
-
href: string
The hyperlink reference to the product offering price reference.
-
id(required): string
The ID of the product offering price reference.
-
name: string
The name of the product offering price reference.
-
refId: string
The ID of the ref associated with the product offering price reference.
-
refName: string
The name of the ref associated with the product offering price reference.
-
version: string
The version of a related entity.
-
versionState: number
The version state of the reference.
400 Response
array-
Array of:
object Discriminator: @type
Discriminator:
{ "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }
401 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
404 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
405 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
500 Response
objectError-
@schemaLocation: string
The URI of the schema that defines the error.
-
@type: string
The class type of a REST resource.
-
code(required): string
Application related code (as defined in the API or from a common list).
-
message: string
The text that provides more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
The text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
The URL pointing to documentation describing the error.
-
status: string
The status of the error.
Examples
The following example shows how to create or update an array of pricing logic algorithm by submitting a put request on the REST resource using cURL.
cURL Command
curl -u username:password -X PUT https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithms/ -H 'Content-Type: application/json' -D @put_plogicalgos.json | json_pp
Example of Request Body
The following shows an example of the request body in JSON format.
[
{
"id": "pla_year_2021_001",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/",
"name": "pla_year_2021_001",
"description": "desc of mypla001",
"version": "1.0",
"validFor": {
"startDateTime": "2020-08-12T03:43:37.696Z",
"endDateTime": "2021-08-12T03:43:37.696Z"
},
"@type": "PlaQuantityRangeOracle",
"lifecycleStatus": "In study",
"plaSpecification": {
"id": "PlaSpec_year_2021_001",
"name": "PlaSpec_year_2021_001"
},
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project"
}
},
{
"id": "pla_year_2021_002",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/",
"name": "pla_year_2021_002",
"description": "desc of mypla001",
"version": "1.0",
"validFor": {
"startDateTime": "2020-08-12T03:43:37.696Z",
"endDateTime": "2020-08-12T03:43:37.696Z"
},
"@type": "PlaQuantityRangeOracle",
"@baseType": "PlaQuantityRange",
"@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmOracle.yml",
"lifecycleStatus": "In test",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project"
},
"plaSpecification": {
"id": "PlaSpec_year_2021_002",
"name": "PlaSpec_year_2021_002"
}
}
]
Example of Response Body
The following shows an example of the response body in JSON format.
[
{
"id": "pla_year_2021_001",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithms/pla_year_2021_001",
"name": "pla_year_2021_001",
"description": "desc of mypla001",
"validFor": {
"startDateTime": "2020-08-12T03:43:37.696Z",
"endDateTime": "2021-08-12T03:43:37.696Z"
},
"@type": "PlaQuantityRangeOracle",
"version": "1.0",
"lifecycleStatus": "In study",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
},
"plaSpecification": {
"id": "PlaSpec_year_2021_001",
"name": "PlaSpec_year_2021_001",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithmSpecification/PlaSpec_year_2021_001",
"@referredType": "PricingLogicAlgorithmSpecificationOracle"
}
},
{
"id": "pla_year_2021_002",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithms/pla_year_2021_002",
"name": "pla_year_2021_002",
"description": "desc of mypla001",
"validFor": {
"startDateTime": "2020-08-12T03:43:37.696Z",
"endDateTime": "2020-08-12T03:43:37.696Z"
},
"@type": "PlaQuantityRangeOracle",
"@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmOracle.yml",
"@baseType": "PlaQuantityRange",
"version": "1.0",
"lifecycleStatus": "In test",
"project": {
"id": "BulkDocProject",
"name": "Bulk Doc Project",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
},
"plaSpecification": {
"id": "PlaSpec_year_2021_002",
"name": "PlaSpec_year_2021_002",
"href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithmSpecification/PlaSpec_year_2021_002",
"@referredType": "PricingLogicAlgorithmSpecificationOracle"
}
}
]