Get a Model Attribute Definition
get
/rest/v16/allProductFamilySetups/{varName}/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
-
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
-
varName(required): string
Variable Name of All Product Families '_allProductFamilies'
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
-
attributeType:
object Attribute Array Type
Title:
Attribute Array Type
Indicates if Attribute is Array Type -
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. -
description:
string
Title:
Description
Description of the Attribute -
displayType:
object Display Type
Title:
Display Type
Display Type of the Attribute -
id:
integer
Title:
Id
Primary Key Of The Resource -
label:
string
Title:
Attribute Name
Name of the Attribute - menuType: object Attribute Menu Type
-
orderNumber:
integer
Title:
Order Number
Order Number of the Attribute -
refType:
object Reference Type
Title:
Reference Type
Type of the Reference -
variableName:
string
Title:
Variable Name of All Product Families '_allProductFamilies'
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 : 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.