Get Product Family Attributes Metadata
get
/rest/v19/productFamilies/{prodFamVarName}/attributes
This service returns the metadata for all attributes of a specific Product Family
Request
Path Parameters
-
prodFamVarName(required): string
Product family 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 family level.
Root Schema : attribute-collection
Type:
Show Source
object-
items:
array Attributes
Title:
AttributesList of attributes -
links:
object Reference Links
Title:
Reference LinksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : Reference Links
Type:
objectTitle:
Reference LinksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
hrefURL to the related object -
rel:
string
Title:
LinkLink relationship to the current object
Nested Schema : attribute
Type:
Show Source
object-
additional:
object Additional Properties
Title:
Additional PropertiesAdditional properties. -
ajaxSensitive:
boolean
Title:
Ajax SensitiveAjax Sensitivity of the attribute. -
array:
boolean
Title:
ArrayArray. -
arrayControlAttr:
boolean
Title:
Array Control AttributeArray control attribute. -
autoLock:
boolean
Title:
Auto LockAuto lock. -
category:
object category
-
constraintDisplayType:
object constraintDisplayType
-
defaultValue:
string
Title:
Default ValueDefault value. -
description:
string
Title:
DescriptionDescription. -
displayType:
object displayType
-
endDate:
string
Title:
End DateEnd Date. -
hideInTrans:
boolean
Title:
Hide In TransactionHide in transaction. -
id:
integer
Title:
IdPrimary key of the attribute. -
includeLinkedQuantity:
boolean
Title:
Include Linked QuantityIndicates if the attribute has a linked quantity attribute -
inputTypeCode:
object Input Type Code
Title:
Input Type CodeInput type code. -
itemLevelProcess:
boolean
Title:
Item Level ProcessItem level process. -
jetDisplayType:
object jetDisplayType
-
links:
object Reference Links
Title:
Reference LinksReference links for the Parent, Self, Children and Related as applicable -
name:
string
Title:
NameName. -
orderNumber:
integer
Title:
OrderOrder number. -
partComment:
string
Title:
Part CommentPart Comment. -
partNumber:
string
Title:
Part NumberPart Number. -
potentialStates:
array Potential States
Title:
Potential StatesSet of states for this attribute. -
priceItem:
object priceItem
-
propertyClass:
object propertyClass
-
quantityAttributeVarName:
string
Title:
Quantity Attribute VarNameLinked quantity attribute's variable name -
referencePartNumber:
string
Title:
Reference Part NumberPart number reference for the attribute -
required:
boolean
Title:
RequiredRequired. -
runFilter:
boolean
Title:
Run FilterRun Filter. -
setType:
object setType
-
ssplProperties:
object ssplProperties
-
startDate:
string
Title:
Start DateStart Date. -
status:
object status
-
type:
object type
-
validationMethod:
object validationMethod
-
variableName:
string
Title:
Variable NameVariable name.
Nested Schema : Additional Properties
Type:
objectTitle:
Additional PropertiesAdditional properties.
Show Source
Nested Schema : category
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : constraintDisplayType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : displayType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : Input Type Code
Type:
objectTitle:
Input Type CodeInput type code.
Show Source
-
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : jetDisplayType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : Potential States
Type:
arrayTitle:
Potential StatesSet of states for this attribute.
Show Source
Nested Schema : priceItem
Type:
Show Source
object-
displayPriceAtBottom:
boolean
Title:
Display Price At BottomDisplay price at bottom. -
includeInTotalPrice:
boolean
Title:
Include In Total PriceInclude in total price. -
pricingDisplayType:
object pricingDisplayType
-
pricingType:
object pricingType
Nested Schema : propertyClass
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : setType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : ssplProperties
Type:
Show Source
object-
filterString:
string
Title:
Filter StringFilter string. -
id:
integer
Title:
IdIdentifier -
orderByCol:
string
Title:
Order By ColumnOrder by column. -
orderByDir:
object orderByDir
-
pickMaps:
array pickMaps
-
resAttrDisplayName:
string
Title:
Resource Attribute Display NameResource attribute display name. -
resAttrImage:
string
Title:
Resource Attribute ImageResource attribute image. -
resAttrVarName:
string
Title:
Resource Attribute Variable Name.Unique name to identify the resource attribute. -
resourceDomain:
string
Title:
Resource DomainResource domain. -
type:
object type
Nested Schema : status
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : type
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : validationMethod
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : pricingDisplayType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : pricingType
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : orderByDir
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup code.
Nested Schema : type
Type:
Show Source
object-
displayValue:
string
Title:
Display ValueDisplay value. -
lookupCode:
string
Title:
Lookup CodeLookup 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 -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes
Response Body Sample
{
"items": [{
"id": 36673008,
"links": [{
"rel": "parent",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/operatingSystem_selector"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/operatingSystem_selector/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/operatingSystem_selector/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_name"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_name/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_name/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_pline_name"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_pline_name/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_pline_name/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/processors_selector"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/processors_selector/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/processors_selector/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_variable_name"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_variable_name/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_variable_name/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/serverChassis_selector"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/serverChassis_selector/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/serverChassis_selector/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_ht_model_basePrice"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_ht_model_basePrice/translations"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/productFamilies/vision/attributes/_bm_model_ht_model_basePrice/menuItems"
}, {
"rel": "child",
"href": "https://sitename.oracle.com/rest/v19/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/v19/productFamilies/vision/attributes"
}
]
}