Related Records Input

Input representation of the request to retrieve related ProductRampSegment or ProductUsageGrant records for Product2 object.

JSON Example

1{
2  "recordIds": [
3    "01txx0000006i44AAA",
4    "01txx0000006i5gAAA"
5  ],
6  "relatedObjectNodes": [
7    {
8      "relatedObjectAPIName": "ProductRampSegment",
9      "pageSize": 20,
10      "offSet": 0
11    },
12    {
13      "relatedObjectAPIName": "ProductUsageGrant",
14      "pageSize": 10,
15      "offSet": 0,
16      "filter": {
17        "criteria": [
18          {
19            "property": "status",
20            "operator": "eq",
21            "value": "active"
22          },
23          {
24            "property": "effectivestartdate",
25            "operator": "lte",
26            "value": "2024-06-25"
27          },
28          {
29            "criteriaType": "CustomWhereCondition",
30            "value": "(effectiveenddate = null OR effectiveenddate >= 2024-06-25)"
31          }
32        ]
33      }
34    }
35  ]
36}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
correlation​IdStringUnique token to track and associate related events or transactions across different components of the application. If unspecified, a Universally Unique Identifier (UUID) is generated.Optional62.0
recordIdsString[]List of record IDs to return the relatedObjects records for. The maximum number of record IDs supported is 20.Required62.0
related​ObjectNodesRelated Object Node Input[]List of nodes for the related objects. The maximum number of related object nodes supported is two.Required62.0