1. REST API Services for Oracle CPQ
  2. Tasks
  3. BOM Item Setups

Upsert BOM Item List

post

/rest/v19/bomItemSetups/actions/upsertBomItemList

Use this endpoint create, update, or delete CPQ BOM hierarchies. This endpoint uses a list format, instead of the hierarchical JSON format.

Request

Supported Media Types
Body ()
Root Schema : BOM Item Setup Upsert BOM Item Tree Collection Request Definitions
Type: object
Title: BOM Item Setup Upsert BOM Item Tree Collection Request Definitions
Show Source
Nested Schema : BOM Item List BOM Item Request Definitions
Type: object
Title: BOM Item List BOM Item Request Definitions
BOM Item definition for BOM item list upsert requests
Show Source
Nested Schema : BOM Item List BOM Item Request Collection Definitions
Type: object
Title: BOM Item List BOM Item Request Collection Definitions
BOM Item collection definition for BOM item list upsert requests
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : BOM Item List BOM Item Upsert Request Instance Definitions
Type: object
Title: BOM Item List BOM Item Upsert Request Instance Definitions
BOM item instance definition for BOM item list upsert requests
Show Source
Nested Schema : BOM Item List BOM Item Mapping Request Collection Definitions
Type: object
Title: BOM Item List BOM Item Mapping Request Collection Definitions
BOM item mapping collection definition for BOM item list upsert requests
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : BOM Item List BOM Item Mapping Request Instance Definitions
Type: object
Title: BOM Item List BOM Item Mapping Request Instance Definitions
BOM item mapping instance definition for BOM item list upsert requests
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : BOM Item Setup Upsert BOM Item Tree Collection Response Definitions
Type: object
Title: BOM Item Setup Upsert BOM Item Tree Collection Response Definitions
Back to Top

Examples

The following examples show how to Use this endpoint create, update, or delete CPQ BOM hierarchies by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL. This endpoint uses a list format, instead of the hierarchical JSON format. 

curl - X POST -H "Authorization: Bearer <token>" -H "Prefer: respond-async" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/bomItemSetups/actions/upsertMomItemList

Request Body Sample

{
   "documents":{
      "deleteMissingItems":true,
      "bomItem":{
         "items":[// entries can be in any order
            {
               "<root bom>"
            },
            {
               "<child bom>"
            }
         ]
      }
   }
}

Response Body Sample

{
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/bomItemSetups/actions/upsertBomItemList"
    }, {
      "rel": "related",
      "href": "http://sitename.oracle.com/rest/v19/asyncTasks/3022899700/status"
    }
  ]
}

Get Async Task Status Examples

URI Endpoint Sample

http://sitename.oracle.com/rest/v19/asyncTasks/3022899700/status

Sample In Progress Task Response Body

{
  "progress": "processing",
  "links": [{
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v19/asyncTasks/3022899700/status"
    }
  ],
  "completed": false,
  "requestStatus": "202"
}

Sample Completed Task Response Body

{
  "progress": "succeeded",
  "links": [{
      "rel": "related",
      "href": "http://sitename.oracle.com/rest/v14/asyncTasks/3022899700/response"
    }, {
      "rel": "self",
      "href": "http://sitename.oracle.com/rest/v14/asyncTasks/3022899700/status"
    }
  ],
  "completed": true,
  "requestStatus": 200
}
Back to Top