Get all pricing logic algorithms
get
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm
Request
Query Parameters
-
description: string
The description of the resource.
-
eligibleForProject: string
Project Id
-
fields: string
The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
-
id: string
The unique identifier of the resource item.
-
lifecycleStatus: string
The current lifecycle status of the resource.
-
limit: integer
The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
-
name: string
The name of the resource.
-
offset: string
The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
-
version: string
The current version of the resource.
-
whereUsed: string
enrich objects with usedBy information
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root Schema : schema
Type:
Show Source
array
-
Array of:
PlaQuantityRangeOracle
Title:
PlaQuantityRangeOracle
Nested Schema : PlaQuantityRangeOracle
Title:
PlaQuantityRangeOracle
Match All
Show Source
-
object
PricingLogicAlgorithm
Title:
PricingLogicAlgorithm
Discriminator:{ "propertyName":"@type", "mapping":{ "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm", "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle" } }
-
object
PlaQuantityRangeOracle-allOf[1]
Nested Schema : PricingLogicAlgorithm
Type:
object
Title:
PricingLogicAlgorithm
Discriminator: @type
Discriminator Values
Show Source-
@baseType: string
Immediate base (class) type of the pla
-
@schemaLocation: string
A link to the schema describing this pla
-
@type: string
Class type of the product offering price
-
customProfileSpec: array
customProfileSpec
-
description: string
Description of this pla
-
href: string
Hyperlink reference of this resource
-
id: string
Maximum Length:
30
Unique id of this resource -
lastUpdate: string
(date-time)
Date and time of the last update
-
lifecycleStatus: string
Used to indicate the current lifecycle status
-
name: string
Name of the pla
-
plaSpecification: object
PlaSpecificationRef
Title:
PlaSpecificationRef
A pricing logic algorithm specification reference. A PricingLogicAlgorithmSpec is a detailed description of a tangible or intangible object made available externally in the form of a PricingLogicAlgorithm to customers or other parties playing a party role. -
validFor: object
TimePeriod
Title:
TimePeriod
The period for which the productOffering is valid -
version: string
pla version
Nested Schema : PlaQuantityRangeOracle-allOf[1]
Type:
Show Source
object
-
applicationName: string
name of the external application
-
created: string
(date-time)
Date and time of the creation
-
createdBy: string
name of the person who created item
-
externalId: string
id of the external application
-
lastUpdate: string
(date-time)
Date and time of the last update
-
lastUpdatedBy: string
name of the person who updated item
-
plaCharacteristic: array
plaCharacteristic
-
pricingType: string
Allowed Values:
[ "SIMPLE", "TIERED" ]
Specifies whether the pricing type is simple or tiered -
project: object
ProjectRef
Title:
ProjectRef
Project Reference -
tierRange: array
tierRange
-
versionState: number
Version state of the Pricing Logic Algorithm
Nested Schema : plaCharacteristic
Type:
Show Source
array
-
Array of:
object PlaCharacteristicOracle
Title:
PlaCharacteristicOracle
A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.
Nested Schema : ProjectRef
Type:
object
Title:
ProjectRef
Project Reference
Show Source
-
href: string
Unique reference of the project
-
id(required): string
Unique identifier of the project
-
name: string
Name of the project
-
version: string
Version of the project
Nested Schema : tierRange
Type:
Show Source
array
-
Array of:
object TierRangeOracle
Title:
TierRangeOracle
Contains the min and max qty for which the pricing is applicable
Nested Schema : PlaCharacteristicOracle
Type:
object
Title:
PlaCharacteristicOracle
A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.
Show Source
-
description: string
A narrative that explains in detail what the productSpecCharacteristic is
-
name: string
Name of the associated productSpecCharacteristic
-
plaCharacteristicValue: array
plaCharacteristicValue
-
valueType: string
A kind of value that the characteristic can take on, such as numeric, text and so forth
Nested Schema : plaCharacteristicValue
Type:
Show Source
array
-
Array of:
object PlaCharacteristicValueOracle
Title:
PlaCharacteristicValueOracle
A number or text that can be assigned to a ProductSpecCharacteristic.
Nested Schema : PlaCharacteristicValueOracle
Type:
object
Title:
PlaCharacteristicValueOracle
A number or text that can be assigned to a ProductSpecCharacteristic.
Show Source
-
unitOfMeasure: string
Allowed Values:
[ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
Could be minutes, GB... -
value:
value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
Nested Schema : value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type:
object
Nested Schema : TierRangeOracle
Type:
object
Title:
TierRangeOracle
Contains the min and max qty for which the pricing is applicable
Show Source
-
inclusivity: string
Allowed Values:
[ "UPPER_INCLUSIVE", "LOWER_INCLUSIVE" ]
Specifies whether to include the upper limit or lower limit -
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
Nested Schema : productOfferingPrice
Type:
Show Source
array
-
Array of:
object ProductOfferingPriceRef
Title:
ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Nested Schema : ProductOfferingPriceRef
Type:
object
Title:
ProductOfferingPriceRef
ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased
Show Source
-
@baseType: string
When sub-classing, this defines the super-class
-
@referredType: string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name
-
href: string
Reference of the related entity.
-
id(required): string
Unique identifier of a related entity.
-
name: string
Name of the related entity.
-
refId: string
Unique identifier of the reference object.
-
refName: string
Name of the reference object.
-
versionState: number
To hold the version state of reference
400 Response
Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@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
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
401 Response
Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@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
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
404 Response
Your request includes a resource URI that doesn't exist.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@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
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
405 Response
HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@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
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
500 Response
The server encountered something unexpected that prevented it from completing the request.
Root Schema : Error
Type:
object
Title:
Show Source
Error
-
@schemaLocation: string
It provides a link to the schema describing a REST resource.
-
@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
Text that provide more details and corrective actions related to the error. This can be shown to a client user.
-
reason(required): string
Text that explains the reason for error. This can be shown to a client user.
-
referenceError: string
url pointing to documentation describing the error
-
status: string
http error code extension like 400-2
Examples
The following example shows how to get all pricing logic algorithms by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm \ -H 'Content-Type: application/json'
Example of Response Body
The following example shows the contents of the response body in JSON format.
[ { "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/Oracle_7LQI7KQ6", "id": "Oracle_7LQI7KQ6", "lastUpdate": "2020-07-20T11:39:50.612Z", "version": "1.0", "@type": "PricingLogicAlgorithmOracle", "lifecycleStatus": "In design", "name": "Names_38SPRQJO2", "pricingType": "SIMPLE", "tierRange": { "minQuantity": 10, "inclusivity": "UPPER_INCLUSIVE" } }, { "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/Oracle_Y7ARDBO3", "id": "Oracle_Y7ARDBO3", "lastUpdate": "2020-07-20T11:41:14.579Z", "version": "1.0", "@type": "PricingLogicAlgorithmOracle", "lifecycleStatus": "In design", "name": "Names_71WSN09LC", "pricingType": "SIMPLE", "tierRange": { "minQuantity": 10, "maxQuantity": 20, "inclusivity": "UPPER_INCLUSIVE" } }, { "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/Oracle_C1RYBUTP", "id": "Oracle_C1RYBUTP", "lastUpdate": "2020-07-21T07:53:15.574Z", "version": "1.0", "@type": "PricingLogicAlgorithmOracle", "lifecycleStatus": "In design", "name": "Names_XC6VOOTDT", "pricingType": "SIMPLE", "tierRange": { "minQuantity": 20, "maxQuantity": 30, "inclusivity": "UPPER_INCLUSIVE" } }, { "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/Oracle_55M34GZI", "id": "Oracle_55M34GZI", "lastUpdate": "2020-07-23T07:48:01.848Z", "version": "1.0", "@type": "PricingLogicAlgorithmOracle", "lifecycleStatus": "In design", "name": "Names_B4TJ5W99K", "pricingType": "SIMPLE", "tierRange": { "minQuantity": 0, "maxQuantity": 5, "inclusivity": "UPPER_INCLUSIVE" } }, { "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/Oracle_DXE6S05T", "id": "Oracle_DXE6S05T", "lastUpdate": "2020-07-23T07:51:04.606Z", "version": "1.0", "@type": "PricingLogicAlgorithmOracle", "lifecycleStatus": "In design", "name": "Names_OII92Q42T", "pricingType": "SIMPLE", "tierRange": { "minQuantity": 20, "maxQuantity": 30, "inclusivity": "UPPER_INCLUSIVE" } }, .... ]