Communications, Media, Energy and Utilities (CME) Developer Guide

Get Started with CME Developer Resources
Fields on Standard Objects
Standard Objects
Associated Objects
Platform Event Objects
REST Reference
Resources
Request Bodies
Additional Fields Input
Bulk Product Details Input
CME Asset Amend Input
Configuration Options Input
Configurator Added Node Input
Configurator Deleted Node Input
Configurator Input
Configurator Options Input
Configurator Preference Input
Configurator Updated Node Input
User Context Input
Context Data Input
Context Input
Execution Settings Input
Filter Criteria Input
Filter Input
Group Ramp Action Input
Manage Links Input
Manage Product Relationship Rules Request Input
Object Graph Input
Object Input Map
Object with Reference Input
Sales Transaction Bulk Operation Filter
Sales Transaction Bulk Operation Input
Sales Transaction Input
Product Data Input
Product Details Input
Product List Input
Related Object Filter Input
User Context Input
Recipient Group Input
Split Recipient Group Input
Response Bodies
Invocable Actions
PDF

Configurator Added Node Input

Input representation of the nodes to be added to a product configuration.

JSON Example

1{
2  "addedNodes": [
3    {
4      "path": [
5        "0Q0xx0000004EvcCAE",
6        "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589"
7      ],
8      "addedObject": {
9        "id": "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
10        "SalesTransactionItemSource": "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
11        "SalesTransactionItemParent": "0Q0xx0000004EvcCAE",
12        "PricebookEntry": "01uxx00000090VuAAI",
13        "ProductSellingModel": "0jPxx00000001KHEAY",
14        "UnitPrice": 15.26,
15        "Quantity": 1,
16        "Product": "01txx0000006lfHAAQ",
17        "businessObjectType": "QuoteLineItem"
18      }
19    },
20    {
21      "path": [
22        "0Q0xx0000004EvcCAE",
23        "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
24        "ref_d85b036d_d305_4bb6_aba8_a1dff645a664"
25      ],
26      "addedObject": {
27        "id": "ref_d85b036d_d305_4bb6_aba8_a1dff645a664",
28        "MainItem": "0QLxx0000004QdRGAU",
29        "AssociatedItem": "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
30        "ProductRelatedComponent": "0dSxx00000001p6EAA",
31        "ProductRelationshipType": null,
32        "AssociatedItemPricing": "NotIncludedInBundlePrice",
33        "AssociatedQuantScaleMethod": "Proportional",
34        "businessObjectType": "QuoteLineRelationship"
35      }
36    }
37  ]
38}
This example shows a sample request for orders.
1{
2  "addedNodes": [
3    {
4      "path": [
5        "0Q0xx0000004EvcCAE",
6        "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589"
7      ],
8      "addedObject": {
9        "id": "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
10        "SalesTransactionItemSource": "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
11        "SalesTransactionItemParent": "0Q0xx0000004EvcCAE",
12        "PricebookEntry": "01uxx00000090VuAAI",
13        "ProductSellingModel": "0jPxx00000001KHEAY",
14        "UnitPrice": 15.26,
15        "Quantity": 1,
16        "Product": "01txx0000006lfHAAQ",
17        "businessObjectType": "OrderItem"
18      }
19    },
20    {
21      "path": [
22        "0Q0xx0000004EvcCAE",
23        "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
24        "ref_d85b036d_d305_4bb6_aba8_a1dff645a664"
25      ],
26      "addedObject": {
27        "id": "ref_d85b036d_d305_4bb6_aba8_a1dff645a664",
28        "MainItem": "0QLxx0000004QdRGAU",
29        "AssociatedItem": "ref_d3a3f8d2_e031_4517_ae28_69ce16cb6589",
30        "ProductRelatedComponent": "0dSxx00000001p6EAA",
31        "ProductRelationshipType": null,
32        "AssociatedItemPricing": "NotIncludedInBundlePrice",
33        "AssociatedQuantScaleMethod": "Proportional",
34        "businessObjectType": "OrderItemRelationship"
35      }
36    }
37  ]
38}

Properties

Name Type Description Required or Optional Available Version
added​Object Map<String, Object> Details of the object that’s being added. This property supports fields of objects from the Sales Transaction context definition, including custom objects and fields in your extended context definition. Required 60.0
path String[]

Path to the node that’s being added. The path includes the unique ID of the context node in the data structure. This ID must match the ID of the sales transaction item source such as a quote line or an order line item.

Keep these considerations in mind when setting the path value.

  • If the businessObjectType property value is QuoteLineItem, the path must contain 2 IDs. The first ID is the quote ID, and the second ID is the quote line item ID.
  • If the businessObjectType property value is QuoteLineItem, the path must contain SalesTransactionItemSource and SalesTransactionItemParent.
  • If the businessObjectType property value is QuoteLineItemRelationship, the path must contain 3 IDs. The first ID is the quote ID. The second ID is the quote line item ID. The third ID is the quote line item relationship ID.
 Required 60.0