Jump to

• Request
• Response
• Examples

Get All Product Families Attributes

get

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

Use this endpoint to retrieve All Product Families attributes.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name

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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : configAttributeSetups-collection

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/configAttributeSetups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Attributes
  Title: Attributes

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/configAttributeSetups"
    }
}

Nested Schema : Attributes

Type: object

Title: Attributes

Show Source

• 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
  Title: Attribute Menu Type

  Indicates if Attribute is 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

  Variable Name of the Attribute

{
    "type":"object",
    "properties":{
        "attributeType":{
            "type":"object",
            "description":"Indicates if Attribute is Array Type",
            "title":"Attribute Array Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "category":{
            "type":"object",
            "description":"Category Attribute Belongs To",
            "title":"Attribute Category",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "dataType":{
            "type":"object",
            "description":"Data Type of the Attribute",
            "title":"Data Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "description":{
            "type":"string",
            "description":"Description of the Attribute",
            "title":"Description"
        },
        "displayType":{
            "type":"object",
            "description":"Display Type of the Attribute",
            "title":"Display Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "id":{
            "type":"integer",
            "description":"Primary Key Of The Resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Attribute",
            "title":"Attribute Name"
        },
        "menuType":{
            "type":"object",
            "description":"Indicates if Attribute is Menu Type",
            "title":"Attribute Menu Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order Number of the Attribute",
            "title":"Order Number"
        },
        "refType":{
            "type":"object",
            "description":"Type of the Reference",
            "title":"Reference Type",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Attribute",
            "title":"Variable Name"
        }
    },
    "title":"Attributes"
}

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.

{
    "type":"object",
    "description":"Indicates if Attribute is Array Type",
    "title":"Attribute Array Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Category Attribute Belongs To",
    "title":"Attribute Category",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Data Type of the Attribute",
    "title":"Data Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Display Type of the Attribute",
    "title":"Display Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Nested Schema : Attribute Menu Type

Type: object

Title: Attribute Menu Type

Indicates if Attribute is Menu 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.

{
    "type":"object",
    "description":"Indicates if Attribute is Menu Type",
    "title":"Attribute Menu Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Type of the Reference",
    "title":"Reference Type",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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