Create or update an array of pricing logic algorithm specifications

put

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

Creates or updates one or more pricing logic algorithm specifications.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 50
The pricing logic algorithm specifications resource.
Show Source
  • PricingLogicAlgorithmSpecification
    Title: PricingLogicAlgorithmSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "PricingLogicAlgorithmSpecification":"#/components/schemas/PricingLogicAlgorithmSpecification", "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }
    The specification models flexible interface definitions to support reuse by existing rating algorithms.
Nested Schema : PricingLogicAlgorithmSpecification
Type: object
Title: PricingLogicAlgorithmSpecification
Discriminator: @type

Discriminator Values

The specification models flexible interface definitions to support reuse by existing rating algorithms.
Show Source
Nested Schema : plaSpecCharacteristic
Type: array
A list of pla specification characteristics associated with the pricing logic algorithm specification.
Show Source
  • PLASpecCharacteristic
    Title: PLASpecCharacteristic
    A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.
Nested Schema : TargetProductSchema
Type: object
Title: TargetProductSchema
The reference object to the schema and type of target product which is described by product specification.
Show Source
Nested Schema : TimePeriod
Type: object
Title: TimePeriod
The period for which the productOffering is valid.
Show Source
Nested Schema : PLASpecCharacteristic
Type: object
Title: PLASpecCharacteristic
A characteristic quality or distinctive feature of a PlaSpecification. The characteristic can take on a discrete value, such as color, can take on a range of values, (for example, sensitivity of 100-240 mV), or can be derived from a formula (for example, usage time (hrs) = 30 - talk time *3). Certain characteristics, such as color, may be configured during the ordering or some other process.
Show Source
Nested Schema : plaSpecCharacteristicValue
Type: array
A list of pla specification characteristic values associated with the pla specification characteristic.
Show Source
Nested Schema : plaSpecCharRelationship
Type: array
A list of pla specification characteristic relationships associated with the pla specification characteristic.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : PLASpecCharacteristicValue
Type: object
Title: PLASpecCharacteristicValue
A number or text that can be assigned to a PLASpecCharacteristic.
Show Source
  • The base type of the pla specification characteristic value.
  • The URI of the schema that defines the pla specification characteristic value.
  • The class type of the pla specification characteristic value.
  • Whether the pla specification characteristic value is default.
  • Allowed Values: [ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]
    An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.
  • The regular expression to define constraint on the allowed value.
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    The unit can be minutes or GB.
  • TimePeriodOracle
    Title: TimePeriodOracle
    The validity period of the related party.
  • value
    A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
  • The low range value that a characteristic can take on.
  • The upper range value that a characteristic can take on.
  • Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME" ]
    The type or classification of the pla specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, and DATETIME.
Nested Schema : value
A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : PLASpecCharRelationship
Type: object
Title: PLASpecCharRelationship
An aggregation, migration, substitution, dependency or exclusivity relationship between/among PLASpecCharacteristic.
Show Source
  • The base type of the pla specification characteristic relationship.
  • The URI of the schema that defines the pla specification characteristic relationship.
  • The class type of the pla specification characteristic relationship.
  • The order in which a characteristic specification appears within another characteristic specification grouping. For example, a grouping can represent a person name where the given name is first, the middle name is second, and the last name is third.
  • The hyperlink reference to the pla specification characteristic relationship.
  • The ID of the pla specification characteristic relationship.
  • The name of the pla specification characteristic relationship.
  • Allowed Values: [ "AGGREGATION", "MIGRATION", "SUBSTITUTION", "DEPENDENCY", "EXCLUSIVITY" ]
    The type or classification of the pla specification characteristic relationship. Valid values are AGGREGATION, MIGRATION, SUBSTITUTION, DEPENDENCY, and EXCLUSIVITY.
  • TimePeriodOracle
    Title: TimePeriodOracle
    The validity period of the related party.
Back to Top

Response

Supported Media Types

200 Response

The list of pricing logic algorithm specifications was created or updated successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : PricingLogicAlgorithmSpecificationsOracle
Title: PricingLogicAlgorithmSpecificationsOracle
Match All
Show Source
  • PricingLogicAlgorithmSpecification
    Title: PricingLogicAlgorithmSpecification
    Discriminator: { "propertyName":"@type", "mapping":{ "PricingLogicAlgorithmSpecification":"#/components/schemas/PricingLogicAlgorithmSpecification", "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }
    The specification models flexible interface definitions to support reuse by existing rating algorithms.
  • Discriminator: @type
    Discriminator: { "propertyName":"@type", "mapping":{ "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle", "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle", "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle", "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle" } }
Nested Schema : PricingLogicAlgorithmSpecification
Type: object
Title: PricingLogicAlgorithmSpecification
Discriminator: @type

Discriminator Values

The specification models flexible interface definitions to support reuse by existing rating algorithms.
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

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 : schema
Type: array
Show Source
Nested Schema : Discriminator: @type
Type: object
Discriminator: @type

Discriminator Values

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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
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
The error resource.
Show Source

500 Response

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

Examples

The following example shows how to create or update an array of pricing logic algorithm specification 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/pricingLogicAlgorithmSpecifications -H 'Content-Type: application/json' -D @put_plaspecifications_v4.json | json_pp

Example of Request Body

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

[
    {
        "id": "PlaSpec_year_2021_001",
        "name": "PlaSpec_year_2021_001",
        "description": "description of plaspec001",
        "version": "1.0",
        "@type": "PricingLogicAlgorithmSpecificationOracle",
        "@baseType": "PricingLogicAlgorithmSpecification",
        "lifecycleStatus": "In design",
        "validFor": {
            "startDateTime": "2020-05-02T16:42:23.0Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project"
        },
        "plaSpecCharacteristic": [
            {
                "name": "Colours123",
                "description": "Phone Colour",
                "valueType": "STRING",
                "configurable": true,
                "minCardinality": 1,
                "maxCardinality": 1,
                "isUnique": true,
                "extensible": false,
                "validFor": {
                    "startDateTime": "2020-05-02T16:42:23.0Z",
                    "endDateTime": "2021-07-14T00:00:00.0Z"
                },
                "plaSpecCharacteristicValue": [
                    {
                        "isDefault": false,
                        "value": "Gold",
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        }
                    },
                    {
                        "isDefault": false,
                        "value": "Blue",
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        }
                    },
                    {
                        "isDefault": true,
                        "value": "Yellow",
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        }
                    }
                ]
            }
        ]
    },
    {
        "id": "PlaSpec_year_2021_002",
        "name": "PlaSpec_year_2021_002",
        "description": "description of plaspec001",
        "version": "1.0",
        "@type": "PricingLogicAlgorithmSpecificationOracle",
        "@baseType": "PricingLogicAlgorithmSpecification",
        "lifecycleStatus": "In design",
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project"
        },
        "plaSpecCharacteristic": [
            {
                "name": "Colours123",
                "description": "Phone Colour",
                "valueType": "STRING",
                "configurable": true,
                "minCardinality": 1,
                "maxCardinality": 1,
                "isUnique": true,
                "extensible": false,
                "validFor": {
                    "startDateTime": "2020-05-02T16:42:23.0Z",
                    "endDateTime": "2021-07-14T00:00:00.0Z"
                },
                "plaSpecCharacteristicValue": [
                    {
                        "isDefault": false,
                        "value": "Gold",
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        }
                    },
                    {
                        "isDefault": false,
                        "value": "Blue",
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        }
                    },
                    {
                        "isDefault": true,
                        "value": "Yellow",
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        }
                    }
                ]
            }
        ]
    }
]

Example of Response Body

The following shows an example of the response body in JSON format.

[
    {
        "id": "PlaSpec_year_2021_001",
        "name": "PlaSpec_year_2021_001",
        "description": "description of plaspec001",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecifications/PlaSpec_year_2021_001",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "@type": "PricingLogicAlgorithmSpecificationOracle",
        "@baseType": "PricingLogicAlgorithmSpecification",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecificationOracle.yml",
        "validFor": {
            "startDateTime": "2020-05-02T16:42:23.0Z"
        },
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "plaSpecCharacteristic": [
            {
                "name": "Colours123",
                "description": "Phone Colour",
                "valueType": "STRING",
                "extensible": false,
                "configurable": true,
                "isUnique": true,
                "minCardinality": 1,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-05-02T16:42:23.0Z",
                    "endDateTime": "2021-07-14T00:00:00.0Z"
                },
                "plaSpecCharacteristicValue": [
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        },
                        "value": "Gold"
                    },
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        },
                        "value": "Blue"
                    },
                    {
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        },
                        "value": "Yellow"
                    }
                ]
            }
        ]
    },
    {
        "id": "PlaSpec_year_2021_002",
        "name": "PlaSpec_year_2021_002",
        "description": "description of plaspec001",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecifications/PlaSpec_year_2021_002",
        "version": "1.0",
        "lifecycleStatus": "In design",
        "@type": "PricingLogicAlgorithmSpecificationOracle",
        "@baseType": "PricingLogicAlgorithmSpecification",
        "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecificationOracle.yml",
        "project": {
            "id": "BulkDocProject",
            "name": "Bulk Doc Project",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/project/BulkDocProject"
        },
        "plaSpecCharacteristic": [
            {
                "name": "Colours123",
                "description": "Phone Colour",
                "valueType": "STRING",
                "extensible": false,
                "configurable": true,
                "isUnique": true,
                "minCardinality": 1,
                "maxCardinality": 1,
                "validFor": {
                    "startDateTime": "2020-05-02T16:42:23.0Z",
                    "endDateTime": "2021-07-14T00:00:00.0Z"
                },
                "plaSpecCharacteristicValue": [
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        },
                        "value": "Gold"
                    },
                    {
                        "isDefault": false,
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        },
                        "value": "Blue"
                    },
                    {
                        "isDefault": true,
                        "validFor": {
                            "startDateTime": "2020-05-02T16:42:23.0Z",
                            "endDateTime": "2021-07-14T00:00:00.0Z"
                        },
                        "value": "Yellow"
                    }
                ]
            }
        ]
    }
]
Back to Top