Get a pricing logic algorithm
get
https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/{id}
Request
Path Parameters
-
id(required): string
The unique identifier of the resource item.
Query Parameters
-
eligibleVersionForProject: 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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Root 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
type
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 : type
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 a category 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/FirstMonthPLAPLA \ -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/FirstMonthPLAPLA", "id": "FirstMonthPLAPLA", "lastUpdate": "2020-07-23T08:06:39.753Z", "version": "1.0", "validFor": { "startDateTime": "2019-10-31T15:38:39.124Z", "endDateTime": "2020-10-31T15:38:39.124Z" }, "@type": "PricingLogicAlgorithmOracle", "@baseType": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmOracle.yml", "@schemaLocation": "PricingLogicAlgorithm", "lifecycleStatus": "Ready to publish", "name": "First Month PLA PLA updated", "description": "Description of FirstMonthPLAPLA updated" }