Get all pricing logic algorithms

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm

Request

Query Parameters
  • The description of the resource.
  • Project Id
  • 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.
  • The unique identifier of the resource item.
  • The current lifecycle status of the resource.
  • 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.
  • The name of the resource.
  • 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.
  • The current version of the resource.
  • enrich objects with usedBy information

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : PlaQuantityRangeOracle
Title: PlaQuantityRangeOracle
Match All
Show Source
Nested Schema : PricingLogicAlgorithm
Type: object
Title: PricingLogicAlgorithm
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : PlaQuantityRangeOracle-allOf[1]
Type: object
Show Source
Nested Schema : plaCharacteristic
Type: array
Show Source
  • 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
Nested Schema : tierRange
Type: array
Show Source
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
Nested Schema : plaCharacteristicValue
Type: array
Show Source
Nested Schema : PlaCharacteristicValueOracle
Type: object
Title: PlaCharacteristicValueOracle
A number or text that can be assigned to a ProductSpecCharacteristic.
Show Source
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    Could be minutes, GB...
  • 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
Nested Schema : productOfferingPrice
Type: array
Show Source
  • 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

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.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

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"
        }
    },
    ....
]
Back to Top