Get an All Product Families Attribute
get
/rest/v19/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}
Use this endpoint to retrieve the specified All Product Families attribute.
Request
Supported Media Types
- application/json
Path Parameters
-
allProdFamsVarName(required): string
Variable Name
-
attributeVarName(required): string
Variable Name of the Attribute
Query Parameters
-
expand: string
Allows expansion of relationships.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Attributes
Type:
objectTitle:
Show Source
Attributes-
attributeType:
object Attribute Array Type
Title:
Attribute Array TypeIndicates if Attribute is Array Type -
category:
object Attribute Category
Title:
Attribute CategoryCategory Attribute Belongs To -
dataType:
object Data Type
Title:
Data TypeData Type of the Attribute -
dateAdded:
string
Title:
Date AddedSystem field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date ModifiedSystem field indicating the date on which the Resource was last modified. -
description:
string
Title:
DescriptionDescription of the Attribute -
displayType:
object Display Type
Title:
Display TypeDisplay Type of the Attribute -
id:
integer
Title:
IdPrimary Key Of The Resource -
label:
string
Title:
Attribute NameName of the Attribute - menuType: object Attribute Menu Type
-
orderNumber:
integer
Title:
Order NumberOrder Number of the Attribute -
refType:
object Reference Type
Title:
Reference TypeType of the Reference -
variableName:
string
Title:
Variable NameVariable Name of the Attribute
Nested Schema : Attribute Array Type
Type:
objectTitle:
Attribute Array TypeIndicates if Attribute is Array Type
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Attribute Category
Type:
objectTitle:
Attribute CategoryCategory Attribute Belongs To
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Data Type
Type:
objectTitle:
Data TypeData Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Display Type
Type:
objectTitle:
Display TypeDisplay Type of the Attribute
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Nested Schema : Reference Type
Type:
objectTitle:
Reference TypeType of the Reference
Show Source
-
displayValue:
string
Title:
Display ValueTranslated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
IdPrimary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup CodeLanguage independent code of the fixed list of value.
Examples
The following example shows how to retrieve a catalog definition for the specified All Product Families 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/attributes/aPFSingleSelectMenu
Response Body Sample
{
"orderNumber": 1,
"refType": {
"lookupCode": "1",
"displayValue": "All Product Families",
"id": 38731825,
"links": [{
"rel": "domain",
"href": "https://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": "https://sitename.oracle.com/rest/v19/lookupValues/38731825"
}
]
},
"description": null,
"dateAdded": "2022-06-08T21:47:29.000Z",
"attributeType": {
"lookupCode": "0",
"displayValue": "Non Array Type",
"id": 38731846,
"links": [{
"rel": "domain",
"href": "https://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": "https://sitename.oracle.com/rest/v19/lookupValues/38731846"
}
]
},
"id": 38739196,
"variableName": "aPFSingleSelectMenu",
"dataType": {
"lookupCode": "1",
"displayValue": "Text",
"id": 38731810,
"links": [{
"rel": "domain",
"href": "https://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": "https://sitename.oracle.com/rest/v19/lookupValues/38731810"
}
]
},
"dateModified": "2022-06-08T21:53:28.000Z",
"label": "APF Single Select Menu",
"displayType": {
"lookupCode": "3",
"displayValue": "Single Select Menu",
"id": 38731834,
"links": [{
"rel": "domain",
"href": "https://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": "https://sitename.oracle.com/rest/v19/lookupValues/38731834"
}
]
},
"menuType": {
"lookupCode": "1",
"displayValue": "Menu",
"id": 38731822,
"links": [{
"rel": "domain",
"href": "https://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": "https://sitename.oracle.com/rest/v19/lookupValues/38731822"
}
]
},
"category": {
"lookupCode": "2",
"displayValue": "Configurable",
"id": 38731801,
"links": [{
"rel": "domain",
"href": "https://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": "https://sitename.oracle.com/rest/v19/lookupValues/38731801"
}
]
},
"links": [{
"rel": "self",
"href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aPFSingleSelectMenu"
}, {
"kind": "",
"rel": "child",
"name": "menuItems",
"href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aPFSingleSelectMenu/menuItems"
}, {
"rel": "parent",
"href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
}
]
}