Request Body Objects

Overview

When query REST calls need to be more specific, Oracle CPQ can interpret several request parameters for applicable REST APIs. Refer to the following topics for CPQ objects and parameters:

• Criteria Objects - These objects can be used to retrieve specific and decrease the size of the response.
• Interact Parameters (Cache Instance Id, Interact, Delta) These parameters can result in less overall delay when using CPQ web services.
• Line Item Grid Parameters - Request attributes, objects and parameters that are specific to transaction Line Item Grids. It includes information for the following items: Item Grid Composite Attribute, Hierarchy Parameters, and Selection Parameter usage specific to transaction lines.
• REST Parameters - This topic provides additional information for the following parameters: Destination URL, Partner Information, Revision Id, Selection, Skip Integration, and Skip Rules.
• State Object - This object allows filtering of state data in responses based on the query object provided for action APIs.

Request body data must be written in JSON and adhere to standard JSON syntax rules.

JSON Syntax for Request Body Objects

{
  "documents": {
     "_price_quantity":"74"
  }
}

{
  "documents": {
     "_price_quantity": "74"
  }
}

{
   "lineItem":{
     "items": [
        {
           "_part_number": "part10",
           "_price_quantity": "1",
           "_price_book_var_name": "pb1"
        }
     ]
  }
}

{
  "lineItem": {
     "items": [
       {
           "_part_number": "part10",
           "_price_quantity": "1",
           "_price_book_var_name": "pb1"
        },
        {
           "_part_number": "part1",
           "_price_quantity": "5",
           "_price_book_var_name": "pb1"
        }
     ]

   }
}

Related Topics

See Also