Jump to

• Request
• Response
• Examples

Get List of All Product Families Menu Item Definitions

get

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

Use this endpoint to retrieve a list of definitions for All Product Families attribute menu items.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name of All Product Families '_allProductFamilies'
• attributeVarName(required): string
  Variable Name of the Attribute

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 : configMenuItems-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/configMenuItems"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Config Menu Items
  Title: Config Menu Items

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

Nested Schema : Config Menu Items

Type: object

Title: Config Menu Items

Show Source

• 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.
• id: integer
  Title: Id

  Primary Key of the Resource
• isOverride: string
  Title: Is Override

  Menu Item is on an overridden Config Attribute
• itemText: string
  Title: Menu Item Text

  Text of the Menu Item
• itemValue: string
  Title: Menu Item Value

  Value of the Menu Item
• orderNumber: integer
  Title: Order Number

  Order Number of Config Menu Item

{
    "type":"object",
    "properties":{
        "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"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the Resource",
            "title":"Id"
        },
        "isOverride":{
            "type":"string",
            "description":"Menu Item is on an overridden Config Attribute",
            "title":"Is Override"
        },
        "itemText":{
            "type":"string",
            "description":"Text of the Menu Item",
            "title":"Menu Item Text"
        },
        "itemValue":{
            "type":"string",
            "description":"Value of the Menu Item",
            "title":"Menu Item Value"
        },
        "orderNumber":{
            "type":"integer",
            "description":"Order Number of Config Menu Item",
            "title":"Order Number"
        }
    },
    "title":"Config Menu Items"
}

Back to Top

Examples

The following example shows how to retrieve a list of menu items 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 "Content-type: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems

Response Body Sample

{
  "hasMore": false,
  "links":
  [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems"
    }
  ],
  "items":
  [{
      "orderNumber": 1,
      "itemValue": "Value 1",
      "isOverride": "false",
      "dateModified": "2022-03-02T17:26:58.000Z",
      "id": 16305677,
      "dateAdded": "2014-02-24T18:07:51.000Z",
      "itemText": "Value 1",
      "links":
      [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305677"
        }, {
          "kind": "",
          "rel": "child",
          "name": "images",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305677/images"
        }, {
          "kind": "",
          "rel": "child",
          "name": "prices",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305677/prices"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305677/translations"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1"
        }
      ]
    }, {
      "orderNumber": 2,
      "itemValue": "Value 2",
      "isOverride": "false",
      "dateModified": "2022-03-02T17:26:58.000Z",
      "id": 16305680,
      "dateAdded": "2014-02-24T18:07:51.000Z",
      "itemText": "Value 2",
      "links":
      [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305680"
        }, {
          "kind": "",
          "rel": "child",
          "name": "images",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305680/images"
        }, {
          "kind": "",
          "rel": "child",
          "name": "prices",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305680/prices"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305680/translations"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1"
        }
      ]
    }, {
      "orderNumber": 3,
      "itemValue": "Value 3",
      "isOverride": "false",
      "dateModified": "2022-03-02T17:26:58.000Z",
      "id": 16305683,
      "dateAdded": "2014-02-24T18:07:51.000Z",
      "itemText": "Value 3",
      "links":
      [{
          "rel": "self",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305683"
        }, {
          "kind": "",
          "rel": "child",
          "name": "images",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305683/images"
        }, {
          "kind": "",
          "rel": "child",
          "name": "prices",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305683/prices"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/16305683/translations"
        }, {
          "rel": "parent",
          "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1"
        }
      ]
    }
  ]
}

Back to Top