REST API Reference for Launch Cloud Service

Create or update an array of pricing logic algorithm

put

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithms

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 50

Show Source

Array of: PlaQuantityRangeOracle

Title: PlaQuantityRangeOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaQuantityRangeOracle"
    },
    "minItems":"1",
    "maxItems":"50"
}

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 type

{
    "title":"PlaQuantityRangeOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithm"
        },
        {
            "type":"object",
            "properties":{
                "plaCharacteristic":{
                    "type":"array",
                    "items":{
                        "title":"plaCharacteristic",
                        "$ref":"#/components/schemas/PlaCharacteristicOracle"
                    }
                },
                "pricingType":{
                    "type":"string",
                    "description":"Specifies whether the pricing type is simple or tiered",
                    "enum":[
                        "SIMPLE",
                        "TIERED"
                    ]
                },
                "tierRange":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TierRangeOracle"
                    }
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "lastUpdate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the last update"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the Pricing Logic Algorithm"
                }
            }
        }
    ]
}

Nested Schema : PricingLogicAlgorithm

Type: object

Title: PricingLogicAlgorithm

Discriminator: @type

{
    "title":"PricingLogicAlgorithm",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the pla"
        },
        "description":{
            "type":"string",
            "description":"Description of this pla"
        },
        "version":{
            "type":"string",
            "description":"pla version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the pla"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this pla"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "plaSpecification":{
            "$ref":"#/components/schemas/PlaSpecificationRef"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm",
            "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle"
        }
    }
}

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

{
    "title":"PricingLogicAlgorithm",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the pla"
        },
        "description":{
            "type":"string",
            "description":"Description of this pla"
        },
        "version":{
            "type":"string",
            "description":"pla version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the pla"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this pla"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "plaSpecification":{
            "$ref":"#/components/schemas/PlaSpecificationRef"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm",
            "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "plaCharacteristic":{
            "type":"array",
            "items":{
                "title":"plaCharacteristic",
                "$ref":"#/components/schemas/PlaCharacteristicOracle"
            }
        },
        "pricingType":{
            "type":"string",
            "description":"Specifies whether the pricing type is simple or tiered",
            "enum":[
                "SIMPLE",
                "TIERED"
            ]
        },
        "tierRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TierRangeOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Pricing Logic Algorithm"
        }
    }
}

Nested Schema : plaCharacteristic

Type: array

Show Source

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.

{
    "type":"array",
    "items":{
        "title":"plaCharacteristic",
        "$ref":"#/components/schemas/PlaCharacteristicOracle"
    }
}

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

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : tierRange

Type: array

Show Source

Array of: object TierRangeOracle

Title: TierRangeOracle

Contains the min and max qty for which the pricing is applicable

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TierRangeOracle"
    }
}

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

{
    "title":"PlaCharacteristicOracle",
    "type":"object",
    "description":"A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the associated productSpecCharacteristic"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the productSpecCharacteristic is"
        },
        "valueType":{
            "type":"string",
            "description":"A kind of value that the characteristic can take on, such as numeric, text and so forth"
        },
        "plaCharacteristicValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaCharacteristicValueOracle"
            }
        }
    }
}

Nested Schema : plaCharacteristicValue

Type: array

Show Source

Array of: object PlaCharacteristicValueOracle

Title: PlaCharacteristicValueOracle

A number or text that can be assigned to a ProductSpecCharacteristic.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaCharacteristicValueOracle"
    }
}

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

{
    "title":"PlaCharacteristicValueOracle",
    "type":"object",
    "description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB...",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"object"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ],
            "description":"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

string
object value-oneOf[1]
number
boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"object"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ],
    "description":"A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic"
}

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

{
    "title":"TierRangeOracle",
    "type":"object",
    "description":"Contains the min and max qty for which the pricing is applicable",
    "properties":{
        "minQuantity":{
            "type":"integer",
            "description":"A minimum quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
        },
        "maxQuantity":{
            "type":"integer",
            "description":"A maximum quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
        },
        "inclusivity":{
            "type":"string",
            "description":"Specifies whether to include the upper limit or lower limit",
            "enum":[
                "UPPER_INCLUSIVE",
                "LOWER_INCLUSIVE"
            ]
        },
        "productOfferingPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRef"
            }
        }
    }
}

Nested Schema : productOfferingPrice

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingPriceRef"
    }
}

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

{
    "title":"ProductOfferingPriceRef",
    "type":"object",
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased",
    "properties":{
        "refId":{
            "type":"string",
            "description":"Unique identifier of the reference object."
        },
        "refName":{
            "type":"string",
            "description":"Name of the reference object."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id"
    ]
}

Response

Supported Media Types

application/json

200 Response

Your request is successful and the resources have been created or updated.

Root Schema : schema

Type: array

Show Source

Array of: PlaQuantityRangeOracle

Title: PlaQuantityRangeOracle

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/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 type

{
    "title":"PlaQuantityRangeOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithm"
        },
        {
            "type":"object",
            "properties":{
                "plaCharacteristic":{
                    "type":"array",
                    "items":{
                        "title":"plaCharacteristic",
                        "$ref":"#/components/schemas/PlaCharacteristicOracle"
                    }
                },
                "pricingType":{
                    "type":"string",
                    "description":"Specifies whether the pricing type is simple or tiered",
                    "enum":[
                        "SIMPLE",
                        "TIERED"
                    ]
                },
                "tierRange":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/TierRangeOracle"
                    }
                },
                "project":{
                    "$ref":"#/components/schemas/ProjectRef"
                },
                "lastUpdate":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the last update"
                },
                "created":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of the creation"
                },
                "createdBy":{
                    "type":"string",
                    "description":"name of the person who created item"
                },
                "lastUpdatedBy":{
                    "type":"string",
                    "description":"name of the person who updated item"
                },
                "externalId":{
                    "type":"string",
                    "description":"id of the external application"
                },
                "applicationName":{
                    "type":"string",
                    "description":"name of the external application"
                },
                "versionState":{
                    "type":"number",
                    "description":"Version state of the Pricing Logic Algorithm"
                }
            }
        }
    ]
}

Nested Schema : PricingLogicAlgorithm

Type: object

Title: PricingLogicAlgorithm

Discriminator: @type

Discriminator Values

PricingLogicAlgorithm
PlaQuantityRangeOracle

{
    "title":"PricingLogicAlgorithm",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the pla"
        },
        "description":{
            "type":"string",
            "description":"Description of this pla"
        },
        "version":{
            "type":"string",
            "description":"pla version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the pla"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this pla"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "plaSpecification":{
            "$ref":"#/components/schemas/PlaSpecificationRef"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm",
            "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle"
        }
    }
}

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

{
    "title":"PricingLogicAlgorithm",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "maxLength":"30",
            "description":"Unique id of this resource"
        },
        "href":{
            "type":"string",
            "description":"Hyperlink reference of this resource"
        },
        "name":{
            "type":"string",
            "description":"Name of the pla"
        },
        "description":{
            "type":"string",
            "description":"Description of this pla"
        },
        "version":{
            "type":"string",
            "description":"pla version"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        },
        "@type":{
            "type":"string",
            "description":"Class type of the product offering price"
        },
        "@baseType":{
            "type":"string",
            "description":"Immediate base (class) type of the pla"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A link to the schema describing this pla"
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Used to indicate the current lifecycle status"
        },
        "plaSpecification":{
            "$ref":"#/components/schemas/PlaSpecificationRef"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "customProfileSpec":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomProfileSpecRefOracle"
            }
        }
    },
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithm":"#/components/schemas/PricingLogicAlgorithm",
            "PlaQuantityRangeOracle":"#/components/schemas/PlaQuantityRangeOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "plaCharacteristic":{
            "type":"array",
            "items":{
                "title":"plaCharacteristic",
                "$ref":"#/components/schemas/PlaCharacteristicOracle"
            }
        },
        "pricingType":{
            "type":"string",
            "description":"Specifies whether the pricing type is simple or tiered",
            "enum":[
                "SIMPLE",
                "TIERED"
            ]
        },
        "tierRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TierRangeOracle"
            }
        },
        "project":{
            "$ref":"#/components/schemas/ProjectRef"
        },
        "lastUpdate":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the last update"
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of the creation"
        },
        "createdBy":{
            "type":"string",
            "description":"name of the person who created item"
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"name of the person who updated item"
        },
        "externalId":{
            "type":"string",
            "description":"id of the external application"
        },
        "applicationName":{
            "type":"string",
            "description":"name of the external application"
        },
        "versionState":{
            "type":"number",
            "description":"Version state of the Pricing Logic Algorithm"
        }
    }
}

Nested Schema : plaCharacteristic

Type: array

Show Source

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.

{
    "type":"array",
    "items":{
        "title":"plaCharacteristic",
        "$ref":"#/components/schemas/PlaCharacteristicOracle"
    }
}

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

{
    "title":"ProjectRef",
    "type":"object",
    "description":"Project Reference",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        },
        "version":{
            "type":"string",
            "description":"Version of the project"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : tierRange

Type: array

Show Source

Array of: object TierRangeOracle

Title: TierRangeOracle

Contains the min and max qty for which the pricing is applicable

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TierRangeOracle"
    }
}

Nested Schema : PlaCharacteristicOracle

Type: object

Title: PlaCharacteristicOracle

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

{
    "title":"PlaCharacteristicOracle",
    "type":"object",
    "description":"A use of the ProdSpecCharacteristicValue by a ProductOffering to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue.",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the associated productSpecCharacteristic"
        },
        "description":{
            "type":"string",
            "description":"A narrative that explains in detail what the productSpecCharacteristic is"
        },
        "valueType":{
            "type":"string",
            "description":"A kind of value that the characteristic can take on, such as numeric, text and so forth"
        },
        "plaCharacteristicValue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PlaCharacteristicValueOracle"
            }
        }
    }
}

Nested Schema : plaCharacteristicValue

Type: array

Show Source

Array of: object PlaCharacteristicValueOracle

Title: PlaCharacteristicValueOracle

A number or text that can be assigned to a ProductSpecCharacteristic.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PlaCharacteristicValueOracle"
    }
}

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

{
    "title":"PlaCharacteristicValueOracle",
    "type":"object",
    "description":"A number or text that can be assigned to a ProductSpecCharacteristic.",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "description":"Could be minutes, GB...",
            "enum":[
                "NONE",
                "SECOND",
                "MINUTE",
                "HOUR",
                "DAY",
                "MONTH",
                "BYTE",
                "KILOBYTE",
                "MEGABYTE",
                "GIGABYTE",
                "PAGES",
                "MOVIES",
                "TIME_INTERVAL",
                "QUANTITY",
                "MBPS",
                "GBPS"
            ]
        },
        "value":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"object"
                },
                {
                    "type":"number"
                },
                {
                    "type":"boolean"
                }
            ],
            "description":"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

string
object value-oneOf[1]
number
boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"object"
        },
        {
            "type":"number"
        },
        {
            "type":"boolean"
        }
    ],
    "description":"A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic"
}

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

{
    "title":"TierRangeOracle",
    "type":"object",
    "description":"Contains the min and max qty for which the pricing is applicable",
    "properties":{
        "minQuantity":{
            "type":"integer",
            "description":"A minimum quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
        },
        "maxQuantity":{
            "type":"integer",
            "description":"A maximum quantity of something, typically the total of a thing or things in number, size, value, extent, or money."
        },
        "inclusivity":{
            "type":"string",
            "description":"Specifies whether to include the upper limit or lower limit",
            "enum":[
                "UPPER_INCLUSIVE",
                "LOWER_INCLUSIVE"
            ]
        },
        "productOfferingPrice":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductOfferingPriceRef"
            }
        }
    }
}

Nested Schema : productOfferingPrice

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProductOfferingPriceRef"
    }
}

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

{
    "title":"ProductOfferingPriceRef",
    "type":"object",
    "description":"ProductPriceOffering reference. An amount, usually of money, that is asked for or allowed when a ProductOffering is bought, rented, or leased",
    "properties":{
        "refId":{
            "type":"string",
            "description":"Unique identifier of the reference object."
        },
        "refName":{
            "type":"string",
            "description":"Name of the reference object."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of a related entity."
        },
        "href":{
            "type":"string",
            "description":"Reference of the related entity."
        },
        "name":{
            "type":"string",
            "description":"Name of the related entity."
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        },
        "versionState":{
            "type":"number",
            "description":"To hold the version state of reference"
        }
    },
    "required":[
        "id"
    ]
}

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 : schema

Type: array

Show Source

Array of: object Discriminator: @type

Discriminator: { "propertyName":"@type", "mapping":{ "Error":"#/components/schemas/Error", "BulkError":"#/components/schemas/BulkError" } }

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/Error"
            },
            {
                "$ref":"#/components/schemas/BulkError"
            }
        ],
        "discriminator":{
            "propertyName":"@type",
            "mapping":{
                "Error":"#/components/schemas/Error",
                "BulkError":"#/components/schemas/BulkError"
            }
        }
    }
}

Nested Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

Error
BulkError

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/Error"
        },
        {
            "$ref":"#/components/schemas/BulkError"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "Error":"#/components/schemas/Error",
            "BulkError":"#/components/schemas/BulkError"
        }
    }
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@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

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"It provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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"
        }
    }
]