1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Pricing Logic Algorithms

Create a pricing logic algorithm

post

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

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : PlaQuantityRangeOracle
Title: PlaQuantityRangeOracle
Match All
Show Source
  • PricingLogicAlgorithm
    Title: PricingLogicAlgorithm
    Discriminator: { "propertyName":"@type", "mapping":{ "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm", "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle" } }
  • type
Nested Schema : PricingLogicAlgorithm
Type: object
Title: PricingLogicAlgorithm
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
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
Back to Top

Response

Supported Media Types

201 Response

Your request is successful and a new resource has been created.
Body ()
Root Schema : PlaQuantityRangeOracle
Title: PlaQuantityRangeOracle
Match All
Show Source
  • PricingLogicAlgorithm
    Title: PricingLogicAlgorithm
    Discriminator: { "propertyName":"@type", "mapping":{ "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm", "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle" } }
  • type
Nested Schema : PricingLogicAlgorithm
Type: object
Title: PricingLogicAlgorithm
Discriminator: @type

Discriminator Values

Show Source
Nested Schema : type
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 create a pricing logic algorithm by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm \ -H 'Content-Type: application/json' -D @create_pricinglogicalgorithm.json | json_pp

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
  "id": "mypla00010",
  "name": "mypla00010",
  "description": "desc of mypla001",
  "version": "1.0",
  "validFor": {
    "startDateTime": "2020-08-12T03:43:37.696Z",
    "endDateTime": "2020-08-12T03:43:37.696Z"
  },
  "@type": "PricingLogicAlgorithmOracle",
  "@baseType": "PricingLogicAlgorithm",
  "lifecycleStatus": "In study",
  "plaSpecification": {
    "id": "PLADocSPEC004",
    "href": "string",
    "version": "1.0",
    "name": "PLA Doc SPEC 004",
    "@referredType": "PricingLogicAlgorithmSpecOracle"
  }
}

Example of Response Body

The following example shows the contents of the response body in JSON format.
{
    "id": "mypla00010",
    "name": "mypla00010",
    "description": "desc of mypla001",
    "version": "1.0",
    "validFor": {
        "startDateTime": "2020-08-12T03:43:37.696Z",
        "endDateTime": "2020-08-12T03:43:37.696Z"
    },
    "@type": "PricingLogicAlgorithmOracle",
    "@baseType": "PricingLogicAlgorithm",
    "lifecycleStatus": "In study",
    "plaSpecification": {
        "id": "PLADocSPEC004",
        "href": "string",
        "name": "PLA Doc SPEC 004",
        "@referredType": "PricingLogicAlgorithmSpecOracle"
    },
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/pricingLogicAlgorithm/mypla00010",
    "createdBy": "anonymous",
    "created": "2020-08-20T11:07:51.000Z",
    "lastUpdatedBy": "anonymous",
    "lastUpdate": "2020-08-20T11:07:51.000Z"
}
Back to Top