Jump to

• Request
• Response
• Examples

Create an All Product Families Attribute Menu Item

post

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

Use this endpoint to create a menu item for the specified All Product Families menu.

Request

Supported Media Types

• application/json

Path Parameters

• allProdFamsVarName(required): string
  Variable Name
• attributeVarName(required): string
  Variable Name of the Attribute

Body ()

Root 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
• 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"
        },
        "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

Response

Supported Media Types

• application/json

Default Response

Body ()

Root 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 add an All Product Families menu item by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems

Request Body Sample

{
  "orderNumber": 3,
  "itemValue": "thirdValue",
  "itemText": "Three."
}
  

Response Body Sample

{
  "orderNumber": 3,
  "itemValue": "thirdValue",
  "isOverride": "false",
  "dateModified": "2023-11-16T17:02:24.000Z",
  "id": 3023093373,
  "dateAdded": "2023-11-16T17:02:24.000Z",
  "itemText": "Three.",
  "links":
  [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/3023093373"
    }, {
      "kind": "",
      "rel": "child",
      "name": "images",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/3023093373/images"
    }, {
      "kind": "",
      "rel": "child",
      "name": "prices",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/3023093373/prices"
    }, {
      "kind": "",
      "rel": "child",
      "name": "translations",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1/menuItems/3023093373/translations"
    }, {
      "rel": "parent",
      "href": "http://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/attributes/aVPSSMDropdown1"
    }
  ]
}

Back to Top