Get Product Family Attributes Metadata

get

/rest/v16/productFamilies/{prodFamVarName}/attributes

This service returns the metadata for all attributes of a specific Product Family

Request

Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

Default Response

List of attributes defined at product family level.
Body ()
Root Schema : attribute-collection
Type: object
Show Source
Nested Schema : Attributes
Type: array
Title: Attributes
List of attributes
Show Source
Nested Schema : attribute
Type: object
Show Source
Nested Schema : Additional Properties
Type: object
Title: Additional Properties
Additional properties.
Show Source
Nested Schema : category
Type: object
Show Source
Nested Schema : constraintDisplayType
Type: object
Show Source
Nested Schema : displayType
Type: object
Show Source
Nested Schema : Input Type Code
Type: object
Title: Input Type Code
Input type code.
Show Source
Nested Schema : jetDisplayType
Type: object
Show Source
Nested Schema : Potential States
Type: array
Title: Potential States
Set of states for this attribute.
Show Source
Nested Schema : priceItem
Type: object
Show Source
Nested Schema : setType
Type: object
Show Source
Nested Schema : ssplProperties
Type: object
Show Source
Nested Schema : status
Type: object
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : validationMethod
Type: object
Show Source
Nested Schema : pricingDisplayType
Type: object
Show Source
Nested Schema : pricingType
Type: object
Show Source
Nested Schema : orderByDir
Type: object
Show Source
Nested Schema : pickMaps
Type: array
Show Source
Nested Schema : type
Type: object
Show Source
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 - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes

Response Body Sample

{
  "items": [{
      "id": 36673008,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/operatingSystem_selector/calculatorTabs"
        }
      ],
      "name": "Operating System",
      "description": "",
      "variableName": "operatingSystem_selector",
      "orderNumber": 1,
      "required": true,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "All Operating Systems",
      "startDate": "",
      "endDate": "",
      "additional": {
        "image_menu_layout": "0"
      },
      "type": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "category": {
        "lookupCode": "2",
        "displayValue": "Configurable Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "1",
        "displayValue": "Marked"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "3",
        "displayValue": "Single Select Menu"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": ["updatable"],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }, {
      "id": 36637517,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_name"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_name/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_name/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_name/calculatorTabs"
        }
      ],
      "name": "Name",
      "description": "Registered catalog item.",
      "variableName": "_bm_model_name",
      "orderNumber": 1,
      "required": false,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "",
      "startDate": "",
      "endDate": "",
      "additional": {},
      "type": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "category": {
        "lookupCode": "1",
        "displayValue": "Regular Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "1",
        "displayValue": "Marked"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": [],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }, {
      "id": 36637499,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_pline_name"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_pline_name/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_pline_name/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_pline_name/calculatorTabs"
        }
      ],
      "name": "Name",
      "description": "Registered catalog item.",
      "variableName": "_bm_pline_name",
      "orderNumber": 1,
      "required": false,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "",
      "startDate": "",
      "endDate": "",
      "additional": {},
      "type": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "category": {
        "lookupCode": "1",
        "displayValue": "Regular Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "1",
        "displayValue": "Marked"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": [],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }, {
      "id": 36673009,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/processors_selector"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/processors_selector/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/processors_selector/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/processors_selector/calculatorTabs"
        }
      ],
      "name": "Processor",
      "description": "",
      "variableName": "processors_selector",
      "orderNumber": 2,
      "required": true,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "All Processors",
      "startDate": "",
      "endDate": "",
      "additional": {
        "image_menu_layout": "0"
      },
      "type": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "category": {
        "lookupCode": "2",
        "displayValue": "Configurable Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "2",
        "displayValue": "Removed"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "3",
        "displayValue": "Single Select Menu"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": ["updatable"],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }, {
      "id": 36637511,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_variable_name"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_variable_name/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_variable_name/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_variable_name/calculatorTabs"
        }
      ],
      "name": "Variable Name",
      "description": "Registered catalog item.",
      "variableName": "_bm_model_variable_name",
      "orderNumber": 2,
      "required": false,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "",
      "startDate": "",
      "endDate": "",
      "additional": {},
      "type": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "category": {
        "lookupCode": "1",
        "displayValue": "Regular Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "1",
        "displayValue": "Marked"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": [],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }, {
      "id": 36673010,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/serverChassis_selector"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/serverChassis_selector/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/serverChassis_selector/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/serverChassis_selector/calculatorTabs"
        }
      ],
      "name": "System",
      "description": "",
      "variableName": "serverChassis_selector",
      "orderNumber": 3,
      "required": true,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "All Systems",
      "startDate": "",
      "endDate": "",
      "additional": {
        "image_menu_layout": "0"
      },
      "type": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "category": {
        "lookupCode": "2",
        "displayValue": "Configurable Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "2",
        "displayValue": "Removed"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "3",
        "displayValue": "Single Select Menu"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": ["updatable"],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }, {
      "id": 36637513,
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_ht_model_basePrice"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_ht_model_basePrice/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_ht_model_basePrice/menuItems"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes/_bm_model_ht_model_basePrice/calculatorTabs"
        }
      ],
      "name": "Base Price",
      "description": "Registered catalog item.",
      "variableName": "_bm_model_ht_model_basePrice",
      "orderNumber": 6,
      "required": false,
      "itemLevelProcess": false,
      "autoLock": false,
      "hideInTrans": false,
      "defaultValue": "",
      "startDate": "",
      "endDate": "",
      "additional": {},
      "type": {
        "lookupCode": "7",
        "displayValue": "Currency"
      },
      "category": {
        "lookupCode": "1",
        "displayValue": "Regular Attributes"
      },
      "status": {
        "lookupCode": "1",
        "displayValue": "Active"
      },
      "constraintDisplayType": {
        "lookupCode": "1",
        "displayValue": "Marked"
      },
      "setType": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "displayType": {
        "lookupCode": "1",
        "displayValue": "Text"
      },
      "validationMethod": {
        "lookupCode": "1",
        "displayValue": "None"
      },
      "priceItem": {
        "pricingType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "pricingDisplayType": {
          "lookupCode": "1",
          "displayValue": "None"
        },
        "displayPriceAtBottom": true,
        "includeInTotalPrice": true
      },
      "potentialStates": [],
      "ajaxSensitive": false,
      "arrayControlAttr": false,
      "array": false
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/attributes"
    }
  ]
}
Back to Top