Get List of All Product Families Attribute Definitions

get

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

Use this endpoint to retrieve a list of definitions for All Product Families attributes.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Allows expansion of relationships.
  • Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
  • The requested page size, which limits the number of elements the collection should max return.
  • The offset of the page. By default, offset is 0, which means first page will be returned.
  • Specifies a comma-separated list of pairs to order the response by.
  • Allows to specify one or more filtering criteria. By default, no filtering is applied.
  • Specifies that the total count of records should be included in the response when doing pagination.
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : configAttributeSetups-collection
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested 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 list of definitions for All Product Families attributes 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

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes"
    }
  ],
  "items": [{
      "orderNumber": 6,
      "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": "Registered Item User Language",
      "dateAdded": "2004-07-06T19:19:36.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": 4121699,
      "variableName": "_BM_USER_LANGUAGE",
      "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": "2019-04-02T09:31:47.000Z",
      "label": "User Language",
      "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": "6",
        "displayValue": "User",
        "id": 38731804,
        "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/38731804"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/_BM_USER_LANGUAGE"
        }, {
          "kind": "",
          "rel": "child",
          "name": "menuItems",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/_BM_USER_LANGUAGE/menuItems"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
        }
      ]
    }, {
      "orderNumber": 8,
      "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": "Registered Item User Exchange Rate",
      "dateAdded": "2006-06-12T19:42:46.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": 4125768,
      "variableName": "_BM_USER_EXCHANGE_RATE",
      "dataType": {
        "lookupCode": "2",
        "displayValue": "Float",
        "id": 38731811,
        "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/38731811"
          }
        ]
      },
      "dateModified": "2019-04-02T09:31:47.000Z",
      "label": "User Exchange Rate",
      "displayType": {
        "lookupCode": "1",
        "displayValue": "Text",
        "id": 38731832,
        "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/38731832"
          }
        ]
      },
      "menuType": {
        "lookupCode": "0",
        "displayValue": "Standard",
        "id": 38731821,
        "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/38731821"
          }
        ]
      },
      "category": {
        "lookupCode": "6",
        "displayValue": "User",
        "id": 38731804,
        "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/38731804"
          }
        ]
      },
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/_BM_USER_EXCHANGE_RATE"
        }, {
          "kind": "",
          "rel": "child",
          "name": "menuItems",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/_BM_USER_EXCHANGE_RATE/menuItems"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
        }
      ]
    }, {
      ...
    }
  ]
}
Back to Top