Jump to

• Request
• Response
• Examples

Get Mandatory Models

post

/rest/v19/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

Body ()

Root Schema : getMandatoryModelsRequest

Type: object

Show Source

• 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.

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : getMandatoryModelsResponse

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.
• items: 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: 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'.

{
    "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: string
• value: string

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

Back to Top

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 -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/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"
    }
  ]
}

Back to Top