Get Mandatory Models
post
/rest/v16/config{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
Path Parameters
-
modelVarName(required): string
The variable name of a Model
-
prodFamVarName(required): string
The variable name of a Product Family
-
prodLineVarName(required): string
The variable name of a Product Line
Root Schema : getMandatoryModelsRequest
Type:
Show Source
object
-
cacheInstanceId(required):
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.
Response
Supported Media Types
- application/json
Default Response
Root Schema : getMandatoryModelsResponse
Type:
Show Source
object
-
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. -
items:
array items
Nested Schema : model
Type:
Show Source
object
-
comment:
string
Title:
Comment
Model's comment. -
description:
string
Title:
Description
Description of the model. -
id:
string
Title:
Model Identifier
It uniquely idenitfies the model. -
modelName:
string
Title:
Model Name
Model display name. -
modelVariableName:
string
Title:
Model Variable Name
Uniquely identifies the model. -
price:
object Price
Title:
Price
Model's price. -
quantity:
integer
Title:
Quantity
Quantity of model in the configuration. -
selected:
string
Title:
Selection
It represents selection of the item. Selection can be 'true', 'false' or 'missing'.
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/v16/configvarioTablets.tablets.customTablet/_mandatoryModels/actions/getMandatoryModels
Request Body Sample
{ "cacheInstanceId": "hzLOQoY2hFvGJccRd43b2mQQfYeQZizF0yp5JBnglukKILuFROAGzEWkCv12K0XrN" }
Response Body Sample
The following example shows the contents of the response body in JSON format:
{ "cacheInstanceId": "hzLOQoY2hFvGJccRd43b2mQQfYeQZizF0yp5JBnglukKILuFROAGzEWkCv12K0XrN", "items": [{ "modelName": "Tablet Support Services", "comment": "System recommended item", "price": { "value": "200", "currency": "USD" }, "modelVariableName": "tabletSupportServices", "quantity": 1, "description": "Tablet Support Services" } ] }