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

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