Get an All Product Families Attribute Definition

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/attributes/{attributeVarName}

Use this endpoint to retrieve a catalog definition for the specified All Product Families attribute.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Attributes
Type: object
Title: Attributes
Show Source
Nested Schema : Attribute Array Type
Type: object
Title: Attribute Array Type
Indicates if Attribute is Array Type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Nested Schema : Attribute Menu Type
Type: object
Title: Attribute Menu Type
Indicates if Attribute is Menu Type
Show Source
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • 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
  • Title: Display Value
    Translated display name of the type for which fixed list of values can be defined.
  • Title: Id
    Primary Key of the fixed list of value resource.
  • Title: Lookup Code
    Language independent code of the fixed list of value.
Back to Top

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"
    }
  ]
} 
Back to Top