Get Product Line Attributes Metadata
get
/rest/v16/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/attributes
This service returns the metadata for all attributes of a Product Line.
Request
Path Parameters
-
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.
Response
Supported Media Types
- application/json
Default Response
List of attributes defined at product line level.
Root Schema : attribute-collection
Type:
Show Source
object
-
items:
array Attributes
Title:
Attributes
List of attributes -
links:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
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:
href
URL to the related object -
rel:
string
Title:
Link
Link relationship to the current object
Nested Schema : attribute
Type:
Show Source
object
-
additional:
object Additional Properties
Title:
Additional Properties
Additional properties. -
ajaxSensitive:
boolean
Title:
Ajax Sensitive
Ajax Sensitivity of the attribute. -
array:
boolean
Title:
Array
Array. -
arrayControlAttr:
boolean
Title:
Array Control Attribute
Array control attribute. -
autoLock:
boolean
Title:
Auto Lock
Auto lock. -
category:
object category
-
constraintDisplayType:
object constraintDisplayType
-
defaultValue:
string
Title:
Default Value
Default value. -
description:
string
Title:
Description
Description. -
displayType:
object displayType
-
endDate:
string
Title:
End Date
End Date. -
hideInTrans:
boolean
Title:
Hide In Transaction
Hide in transaction. -
id:
integer
Title:
Id
Primary key of the attribute. -
inputTypeCode:
object Input Type Code
Title:
Input Type Code
Input type code. -
itemLevelProcess:
boolean
Title:
Item Level Process
Item level process. -
jetDisplayType:
object jetDisplayType
-
links:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable -
name:
string
Title:
Name
Name. -
orderNumber:
integer
Title:
Order
Order number. -
partComment:
string
Title:
Part Comment
Part Comment. -
partNumber:
string
Title:
Part Number
Part Number. -
potentialStates:
array Potential States
Title:
Potential States
Set of states for this attribute. -
priceItem:
object priceItem
-
required:
boolean
Title:
Required
Required. -
runFilter:
boolean
Title:
Run Filter
Run Filter. -
setType:
object setType
-
ssplProperties:
object ssplProperties
-
startDate:
string
Title:
Start Date
Start Date. -
status:
object status
-
type:
object type
-
validationMethod:
object validationMethod
-
VarName:
string
Title:
Variable Name
Variable name.
Nested Schema : Additional Properties
Type:
object
Title:
Additional Properties
Additional properties.
Show Source
Nested Schema : category
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : constraintDisplayType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : displayType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : Input Type Code
Type:
object
Title:
Input Type Code
Input type code.
Show Source
-
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : jetDisplayType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : Potential States
Type:
array
Title:
Potential States
Set of states for this attribute.
Show Source
Nested Schema : priceItem
Type:
Show Source
object
-
displayPriceAtBottom:
boolean
Title:
Display Price At Bottom
Display price at bottom. -
includeInTotalPrice:
boolean
Title:
Include In Total Price
Include in total price. -
pricingDisplayType:
object pricingDisplayType
-
pricingType:
object pricingType
Nested Schema : setType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : ssplProperties
Type:
Show Source
object
-
filterString:
string
Title:
Filter String
Filter string. -
id:
integer
Title:
Id
Identifier -
orderByCol:
string
Title:
Order By Column
Order by column. -
orderByDir:
object orderByDir
-
pickMaps:
array pickMaps
-
resAttrDisplayName:
string
Title:
Resource Attribute Display Name
Resource attribute display name. -
resAttrImage:
string
Title:
Resource Attribute Image
Resource attribute image. -
resAttrVarName:
string
Title:
Resource Attribute Variable Name.
Unique name to identify the resource attribute. -
resourceDomain:
string
Title:
Resource Domain
Resource domain. -
type:
object type
Nested Schema : status
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : type
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : validationMethod
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : pricingDisplayType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : pricingType
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : orderByDir
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
Nested Schema : type
Type:
Show Source
object
-
displayValue:
string
Title:
Display Value
Display value. -
lookupCode:
string
Title:
Lookup Code
Lookup code.
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/productLine/laptops/attributes
Response Body Sample
{ "items": [{ "id": 36637585, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/processor" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/processor/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/processor/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/processor/calculatorTabs" } ], "name": "Processor", "variableName": "processor", "orderNumber": 3, "required": true, "itemLevelProcess": true, "autoLock": false, "hideInTrans": false, "defaultValue": "Dual Core 2.8GHz", "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": "7", "displayValue": "Radio Button Vertical" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": true, "arrayControlAttr": false, "array": false }, { "id": 36637586, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/operatingSystem" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/operatingSystem/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/operatingSystem/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/operatingSystem/calculatorTabs" } ], "name": "Operating System", "description": "", "variableName": "operatingSystem", "orderNumber": 4, "required": true, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "Alliance 7 Pro", "startDate": "", "endDate": "", "additional": { "image_menu_size_type": "1", "image_menu_cols": "4", "image_menu_rows": "3", "image_menu_value": "2", "image_menu_size": "75", "image_menu_layout": "1" }, "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": "5", "displayValue": "Grid" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": true, "arrayControlAttr": false, "array": false }, { "id": 36637587, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/sizeRAM" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/sizeRAM/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/sizeRAM/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/sizeRAM/calculatorTabs" } ], "name": "Size", "description": "", "variableName": "sizeRAM", "orderNumber": 5, "required": false, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "1 GB", "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": "7", "displayValue": "Radio Button Vertical" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": true, "arrayControlAttr": false, "array": false }, { "id": 36637592, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/graphicsCard" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/graphicsCard/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/graphicsCard/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/graphicsCard/calculatorTabs" } ], "name": "Graphics Card", "description": "", "variableName": "graphicsCard", "orderNumber": 10, "required": false, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "Vision Standard - shared memory", "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": true, "arrayControlAttr": false, "array": false }, { "id": 36637611, "links": [{ "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/travelCase" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/travelCase/translations" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/travelCase/menuItems" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes/travelCase/calculatorTabs" } ], "name": "Travel Case", "description": "", "variableName": "travelCase", "orderNumber": 29, "required": true, "itemLevelProcess": false, "autoLock": false, "hideInTrans": false, "defaultValue": "None", "startDate": "", "endDate": "", "additional": { "image_menu_size_type": "1", "image_menu_cols": "4", "image_menu_rows": "3", "image_menu_value": "2", "image_menu_size": "75", "image_menu_layout": "1" }, "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": "5", "displayValue": "Grid" }, "priceItem": { "pricingType": { "lookupCode": "1", "displayValue": "None" }, "pricingDisplayType": { "lookupCode": "1", "displayValue": "None" }, "displayPriceAtBottom": true, "includeInTotalPrice": true }, "potentialStates": ["updatable"], "ajaxSensitive": true, "arrayControlAttr": false, "array": false } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/productFamilies/vision/productLines/laptops/attributes" } ] }