REST API Reference for Launch Cloud Service

Create a pricing logic algorithm specification

post

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

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "$ref":"#/components/schemas/OneTimePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/UsagePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/RecurringPLASpecOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle",
            "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
            "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
            "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Your request is successful and a new resource has been created.

Root Schema : Discriminator: @type

Type: object

Discriminator: @type

Discriminator Values

PricingLogicAlgorithmSpecificationOracle
OneTimePLASpecOracle
UsagePLASpecOracle
RecurringPLASpecOracle

{
    "anyOf":[
        {
            "$ref":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle"
        },
        {
            "$ref":"#/components/schemas/OneTimePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/UsagePLASpecOracle"
        },
        {
            "$ref":"#/components/schemas/RecurringPLASpecOracle"
        }
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "PricingLogicAlgorithmSpecificationOracle":"#/components/schemas/PricingLogicAlgorithmSpecificationOracle",
            "OneTimePLASpecOracle":"#/components/schemas/OneTimePLASpecOracle",
            "UsagePLASpecOracle":"#/components/schemas/UsagePLASpecOracle",
            "RecurringPLASpecOracle":"#/components/schemas/RecurringPLASpecOracle"
        }
    }
}

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.

Root Schema : Error

Type: object

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

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 a pricing logic algorithm specification 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/productCatalogManagement/v1/pricingLogicAlgorithmSpecification \ -H 'Content-Type: application/json' -D @create_pricinglogicalgorithmspec.json | json_pp

Example of Request Body

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

{
    "id": "PLAspec1",
    "name": "PLA Spec",
    "description": "Description of PLAspec",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "@type": "PricingLogicAlgorithmSpecificationOracle",
    "@baseType": "PricingLogicAlgorithmSpecification",
    "plaSpecCharacteristic": [
        {
            "name": "Colour",
            "description": "Phone Colour",
            "valueType": "STRING",
            "configurable": true,
            "minCardinality": 1,
            "maxCardinality": 1,
            "isUnique": true,
            "extensible": false,
             "@type": "PLASpecCharacteristic"
        }
    ]
}

Example of Response Body

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

{
    "id": "PLAspec1",
    "name": "PLA Spec",
    "description": "Description of PLAspec",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/pricingLogicAlgorithmSpecification/PLAspec1",
    "version": "1.0",
    "lifecycleStatus": "In design",
    "created": "2025-02-17T12:53:28.000Z",
    "createdBy": "booth",
    "lastUpdate": "2025-02-17T12:53:28.047Z",
    "lastUpdatedBy": "booth",
    "@type": "PricingLogicAlgorithmSpecificationOracle",
    "@baseType": "PricingLogicAlgorithmSpecification",
    "@schemaLocation": "https://{FusionAppsHost}/CatalogManagement/schema/oracle/PricingLogicAlgorithmSpecificationOracle.yml",
    "versionState": 0,
    "plaSpecCharacteristic": [
        {
            "name": "Colour",
            "description": "Phone Colour",
            "valueType": "STRING",
            "@type": "PLASpecCharacteristic",
            "extensible": false,
            "configurable": true,
            "isUnique": true,
            "minCardinality": 1,
            "maxCardinality": 1
        }
    ]
}