Composite Graph
POST {{_endpoint}}/services/data/v{{version}}/composite/graph
Composite graphs provide an enhanced way to perform composite requests, which execute a series of REST API requests in a single call.
Regular composite requests allow you to execute a series of REST API requests in a single call. And you can use the output of one request as the input to a subsequent request. Composite graphs extend this by allowing you to assemble a more complicated and complete series of related objects and records. Composite graphs also enable you to ensure that the steps in a given set of operations are either all completed or all not completed. This avoids requiring you to check for a mix of successful and unsuccessful results. Regular composite requests have a limit of 25 subrequests. Composite graphs increase this limit to 500. This gives a single API call much greater power.
Body
PARAM
Key | Datatype | Required | Description |
HEADERS
Key | Datatype | Required | Description |
Content-Type
|
string |
RESPONSES
status OK
{
"graphs": [
{
"graphId": "graph1",
"graphResponse": {
"compositeResponse": [
{
"body": {
"id": "0014H00002x6HUhQAM",
"success": true,
"errors": []
},
"httpHeaders": {
"Location": "/services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM"
},
"httpStatusCode": 201,
"referenceId": "newAccount"
},
{
"body": {
"id": "0034H00002JsInQQAV",
"success": true,
"errors": []
},
"httpHeaders": {
"Location": "/services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV"
},
"httpStatusCode": 201,
"referenceId": "newContact"
}
]
},
"isSuccessful": true
}
]
} |
ENDPOINTS