Get a Model Attribute Definition
get
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models/{modelVarName}/attributes/{attributeVarName}
Use this endpoint to retrieve a catalog definition for the specified Model attribute.
Request
Supported Media Types
- application/json
Path Parameters
-
allProdFamsVarName(required): string
Variable Name of All Product Families '_allProductFamilies'
-
attributeVarName(required): string
Variable Name of the Attribute
-
modelVarName(required): string
Variable Name of the Model.
-
prodFamVarName(required): string
Variable Name of the Product Family.
-
prodLineVarName(required): string
Variable Name of the Product Line
Query Parameters
-
expand: string
Allows expansion of relationships.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Attributes
Type:
object
Title:
Show Source
Attributes
-
additional:
string
Title:
Additional
Additional information of Attribute -
array:
boolean
Title:
Array
value as true indicate its a Array Attribute -
arrayControlAttr:
boolean
Title:
Is Array Controlled Attribute
Value of true indicates that field is array controlled Attribute. -
attributeType:
object Attribute Array Type
Title:
Attribute Array Type
Indicates if Attribute is Array Type -
autoLock:
boolean
Title:
Auto Lock
Value of true indicates that auto lock is enabled. -
category:
object Attribute Category
Title:
Attribute Category
Category Attribute Belongs To -
dataType:
object Data Type
Title:
Data Type
Data Type of the Attribute -
dateAdded:
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
defaultValue:
string
Title:
Default Value
Dafault value of the Attribute -
description:
string
Title:
Description
Description of the Attribute -
displayPriceAtBottom:
boolean
Title:
Display Price At Bottom
Value as true indicate that display price at Bottom. -
displayType:
object Display Type
Title:
Display Type
Display Type of the Attribute -
displayTypeLookupValue:
string
Title:
Display Type Lookup Value
Display Type Lookup value for the Attribute -
endDate:
string
Title:
End Date
End Date of this Attribute - hidden: boolean
-
hideInTrans:
boolean
Title:
Hide In Trans
Value of true indicates that field is hidden in trans. -
id:
integer
Title:
Id
Primary Key Of The Resource -
includeInTotalPrice:
boolean
Title:
Include In Total Price
Value as true indicate that included in total price. -
inputTypeCode:
string
Title:
Input Type Code
Input Type Code of Attribute -
isAvp:
boolean
Title:
Is Image Menu
value as true indicate Attribute value pricing is enabled -
isImageMenu:
boolean
Title:
Is Image Menu
value as true indicate its a Image Menu Attribute -
itemLevelProcess:
boolean
Title:
Item Level Process
Value of true indicates that item level process is enabled. -
jetDisplayType:
object Jet Display Type
Title:
Jet Display Type
Jet Display Type of the Attribute -
jetDisplayTypeLookupValue:
string
Title:
Jet Display Type Lookup Value
Jet Display Type Lookup value for the Attribute -
label:
string
Title:
Attribute Name
Name of the Attribute - menuType: object Attribute Menu Type
-
orderNumber:
integer
Title:
Order Number
Order Number of the Attribute -
pricingDisplayType:
object Pricing Display Type
Title:
Pricing Display Type
Pricing Display Type of the Attribute -
pricingType:
object Pricing Type
Title:
Pricing Type
Pricing Type of the Attribute -
refType:
object Reference Type
Title:
Reference Type
Type of the Reference -
required:
boolean
Title:
Required
Value of true indicates that field is required. -
setType:
object Pricing Type
Title:
Pricing Type
Set Type of the Attribute -
startDate:
string
Title:
Start Date
Start Date of this Attribute -
variableName:
string
Title:
Variable Name
Variable Name of the Attribute
Nested Schema : Attribute Array Type
Type:
object
Title:
Attribute Array Type
Indicates if Attribute is Array Type
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Attribute Category
Type:
object
Title:
Attribute Category
Category Attribute Belongs To
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Data Type
Type:
object
Title:
Data Type
Data Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Display Type
Type:
object
Title:
Display Type
Display Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Jet Display Type
Type:
object
Title:
Jet Display Type
Jet Display Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Pricing Display Type
Type:
object
Title:
Pricing Display Type
Pricing Display Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Pricing Type
Type:
object
Title:
Pricing Type
Pricing Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Reference Type
Type:
object
Title:
Reference Type
Type of the Reference
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Pricing Type
Type:
object
Title:
Pricing Type
Set Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Examples
The following example shows how to retrieve a definition for the specified Model attribute 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 "Accept: application/json" https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/models/sUV/attributes/sPackages
Response Body Sample
{ "orderNumber": 1, "endDate": null, "defaultValue": null, "inputTypeCode": "SingleSelectMenu", "pricingDisplayType": { "lookupCode": "1", "displayValue": "None", "id": 3023488696, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_PRICING_DISPLAY%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3023488696" } ] }, "dateAdded": "2023-05-03T04:59:38.000Z", "required": false, "id": 3022993188, "displayPriceAtBottom": true, "jetDisplayTypeLookupValue": "Cards", "dataType": { "lookupCode": "1", "displayValue": "Text", "id": 3022799195, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_DATA_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3022799195" } ] }, "arrayControlAttr": false, "hideInTrans": false, "isAvp": false, "displayType": { "lookupCode": "5", "displayValue": "Radio Button Horizontal", "id": 3022799221, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_DISPLAY_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3022799221" } ] }, "isImageMenu": true, "menuType": { "lookupCode": "1", "displayValue": "Menu", "id": 3022799207, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_MENU_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3022799207" } ] }, "startDate": null, "hidden": false, "additional": "{image_menu_size_type:2,jet_constrained_display:1,text_area_rows:5,text_area_cols:20,image_menu_jet_height:350,image_menu_jet_value:2,image_menu_value:3,image_menu_cols:3,image_menu_rows:1,image_menu_size:300,image_menu_layout:1,image_menu_jet_width:300}", "autoLock": false, "refType": { "lookupCode": "4", "displayValue": "Model", "id": 3022799213, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_REF_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3022799213" } ] }, "description": null, "displayTypeLookupValue": "Grid", "array": false, "attributeType": { "lookupCode": "0", "displayValue": "Non Array Type", "id": 3022799231, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_ARRAY_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3022799231" } ] }, "jetDisplayType": { "lookupCode": "6", "displayValue": "Cards", "id": 3023488705, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_JETDISPLAY_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3023488705" } ] }, "itemLevelProcess": false, "variableName": "sPackages", "dateModified": "2023-05-03T04:59:39.000Z", "label": "Maintenance Packages", "setType": { "lookupCode": "1", "displayValue": "None", "id": 3023488688, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_SET_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3023488688" } ] }, "includeInTotalPrice": true, "category": { "lookupCode": "2", "displayValue": "Configurable", "id": 3022799186, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_CATEGORY%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3022799186" } ] }, "pricingType": { "lookupCode": "1", "displayValue": "None", "id": 3023488692, "links": [{ "rel": "domain", "href": "http://sitename.oracle.com/rest/v19/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_ATTR_PRICING_TYPE%22%7D%7D" }, { "rel": "canonical", "href": "http://sitename.oracle.com/rest/v19/lookupValues/3023488692" } ] }, "links": [{ "rel": "self", "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/models/sUV/attributes/sPackages" }, { "kind": "", "rel": "child", "name": "menuItems", "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/models/sUV/attributes/sPackages/menuItems" }, { "rel": "parent", "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines/consumerVehicles/models/sUV" } ] }