REST API Services for CPQ Cloud

Get Mandatory Models

post

/rest/v7/prodFamVarName.prodLineVarName.modelVarName/_mandatoryModels/actions/getMandatoryModels

This action retrieves the mandatory Models of the configuration. This action does not run recommended items rules.

Request

Supported Media Types

application/json

Root Schema : _mandatoryModels-getMandatoryModelsRequest

Type: object

Show Source

cacheInstanceId: string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        }
    }
}

Response

Supported Media Types

application/json

Default Response

Root Schema : _mandatoryModels-getMandatoryModelsResponse

Type: object

Show Source

cacheInstanceId(optional): string

Title: Cache Instance Id

The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
items(optional): array items

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/model"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/model"
    }
}

Nested Schema : model

Type: object

Show Source

comment(optional): string

Title: Comment

Model's comment.
description(optional): string

Title: Description

Description of the model.
id(optional): string

Title: Model Identifier

It uniquely idenitfies the model.
modelName(optional): string

Title: Model Name

Model display name.
modelVariableName(optional): string

Title: Model Variable Name

Uniquely identifies the model.
price(optional): object Price

Title: Price

Model's price.
quantity(optional): integer

Title: Quantity

Quantity of model in the configuration.
selected(optional): string

Title: Selection

It represents selection of the item. Selection can be 'true', 'false' or 'missing'.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"It uniquely idenitfies the model.",
            "title":"Model Identifier"
        },
        "selected":{
            "type":"string",
            "description":"It represents selection of the item. Selection can be 'true', 'false' or 'missing'.",
            "title":"Selection"
        },
        "modelName":{
            "type":"string",
            "description":"Model display name.",
            "title":"Model Name"
        },
        "comment":{
            "type":"string",
            "description":"Model's comment.",
            "title":"Comment"
        },
        "price":{
            "type":"object",
            "description":"Model's price.",
            "title":"Price",
            "properties":{
                "value":{
                    "type":"string"
                },
                "currency":{
                    "type":"string"
                }
            }
        },
        "modelVariableName":{
            "type":"string",
            "description":"Uniquely identifies the model.",
            "title":"Model Variable Name"
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity of model in the configuration.",
            "title":"Quantity"
        },
        "description":{
            "type":"string",
            "description":"Description of the model.",
            "title":"Description"
        }
    }
}

Nested Schema : Price

Type: object

Title: Price

Model's price.

Show Source

currency(optional): string
value(optional): string

{
    "type":"object",
    "description":"Model's price.",
    "title":"Price",
    "properties":{
        "value":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        }
    }
}

Examples

The following example shows how to retrieve the mandatory Models of a configuration by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v7/configvarioTablets.tablets.customTablet/_mandatoryModels/actions/getMandatoryModels

Request Body Sample

{
  "cacheInstanceId": "hzLOQoY2hFvGJccRd43b2mQQfYeQZizF0yp5JBnglukKILuFROAGzEWkCV8K0XrN"
}

Response Body Sample

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

{
  "cacheInstanceId": "hzLOQoY2hFvGJccRd43b2mQQfYeQZizF0yp5JBnglukKILuFROAGzEWkCV8K0XrN",
  "items": [{
      "modelName": "Tablet Support Services",
      "comment": "System recommended item",
      "price": {
        "value": "200",
        "currency": "USD"
      },
      "modelVariableName": "tabletSupportServices",
      "quantity": 1,
      "description": "Tablet Support Services"
    }
  ]
}