Get List of All Product Families Attribute Definitions
get
/rest/v16/allProductFamilySetups/{varName}/attributes
Use this endpoint to retrieve a list of definitions for All Product Families attributes.
Request
Supported Media Types
- application/json
Path Parameters
-
varName(required): string
Variable Name of All Product Families '_allProductFamilies'
Query Parameters
-
expand: string
Allows expansion of relationships.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
Root Schema : configAttributeSetups-collection
Type:
Show Source
object
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested 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.