Jump to

• Request
• Response
• Examples

Get Recommended Models

post

/rest/v19/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_recmdModels/actions/getRecmdModels

This action retrieves the recommended 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 : getRecmdModelsRequest

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 : getRecmdModelsResponse

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

• _bm_model_description: string
  Title: Product Model Description

  Product model description.
• _bm_model_name: string
  Title: Product Model Name

  Product model display name.
• _bm_model_variable_name: string
  Title: Product Model Variable Name

  Unique variable name to identify the product model.
• customProperties: object Custom Properties
  Title: Custom Properties

  Custom properties of the product model.
• id: integer
  Title: Id

  Primary key of the product model.
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary key of the product model.",
            "title":"Id"
        },
        "customProperties":{
            "type":"object",
            "description":"Custom properties of the product model.",
            "title":"Custom Properties",
            "properties":{
            }
        },
        "_bm_model_name":{
            "type":"string",
            "description":"Product model display name.",
            "title":"Product Model Name"
        },
        "_bm_model_variable_name":{
            "type":"string",
            "description":"Unique variable name to identify the product model.",
            "title":"Product Model Variable Name"
        },
        "_bm_model_description":{
            "type":"string",
            "description":"Product model description.",
            "title":"Product Model Description"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Custom Properties

Type: object

Title: Custom Properties

Custom properties of the product model.

Show Source

{
    "type":"object",
    "description":"Custom properties of the product model.",
    "title":"Custom Properties",
    "properties":{
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

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

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

Examples

The following example shows how to retrieve the recommended 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/_recmdModels/actions/getRecmdModels

Request Body Sample

{
  "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ"
}
         

Response Body Sample

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

{
  "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ",
  "items": [{
      "id": "model~samsungPhablet~recommendedModelPhablet",
      "selected": "true",
      "modelName": "Samsung Phablet",
      "comment": "System recommended item",
      "price": {
        "value": "300",
        "currency": "USD"
      },
      "modelVariableName": "samsungPhablet",
      "quantity": 1,
      "description": "Samsung phablet"
    }, {
      "id": "model~tabletSupportServices~recommendedModelTabletSupportServices",
      "selected": "true",
      "modelName": "Tablet Support Services",
      "comment": "System recommended item",
      "price": {
        "value": "200",
        "currency": "USD"
      },
      "modelVariableName": "tabletSupportServices",
      "quantity": 1,
      "description": "Tablet Support Services"
    }
  ]
}

Back to Top