Jump to

• Request
• Response
• Examples

Get Model Metadata

get

/rest/v19/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}

This endpoint returns definitions for a specific Model within a given Product Family and Product Line.

Request

Path Parameters

• modelVarName(required): string
  Model variable name.
• prodFamVarName(required): string
  Product family variable name.
• prodLineVarName(required): string
  Product line variable name.

Query Parameters

• excludeLinks: string
  Exclude links.
• expand: string
  Allows expansion of relationships.
• showParentAttrs: string
  Allows expansion of parent attributes.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Model details in a product line.

Body ()

Root 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 metadata for the specified Configuration item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/servers/models/ultraPowerSolutionsPackage

Response Body Sample

{
  "id": 36637530,
  "links": [{
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/servers"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/attributes"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/productLines/servers/models/ultraPowerSolutionPackage/arraySets"
    }
  ],
  "customProperties": {
    "_bm_model_ht_model_image": null,
    "_bm_model_ht_model_imageURL": "https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Vision/ultraPackage.png",
    "_bm_model_ht_model_basePrice": {
      "currency": "USD",
      "value": "$15,131.670000"
    },
    "_bm_model_ht_model_configurationLink": "&packagedSolutions=Ultra",
    "_bm_model_ht_model_operatingSystem": "Blue Hat Enterprise Premium",
    "_bm_model_ht_model_processor": "Vision E3-4870",
    "_bm_model_ht_model_sockets": 4,
    "_bm_model_ht_model_cores": 10,
    "_bm_model_ht_model_threads": 80,
    "_bm_model_ht_model_cpuSpeed": "2.4 GHz x 4",
    "_bm_model_ht_model_memory": "32 GB RAM/480 GB SSD",
    "_bm_model_ht_model_formFactor": "Blade",
    "_bm_model_ht_model_productDetailsLink": "",
    "_bm_model_ht_model_simpleDescription": "Perfect Solutions in Single Full-Height Blades",
    "_bm_model_ht_model_link1": "https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Data%20Sheets/AS86009.pdf",
    "_bm_model_ht_model_link2": "https://hitech-build.bigmachines.com/bmfsweb/hitech-build/image/Data%20Sheets/Comparing_Dual-Core_vs_Quad-Core_CPUs.pdf",
    "_bm_model_ht_model_link3": "https://www.oracle.com/us/solutions/oracle-opt-sols-cloud-inf-sol-brief-406108.pdf",
    "_bm_model_ready_for_self_service": false,
    "_bm_model_self_service_part_number": ""
  },
  "_bm_model_name": "Ultra Power Solution Package",
  "_bm_model_variable_name": "ultraPowerSolutionPackage",
  "_bm_model_description": "Vision's Ultra Power Solution is the perfect integration of compute, memory, and storage in a single full-height blade form actor for running both virtual and physical workloads. It’s easy to deploy, manage and provision."
}

Back to Top