Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "graphs": [
; {
; "graphId": "graph1",
; "compositeRequest": [
; {
; "method": "POST",
; "url": "/services/data/v{{version}}/sobjects/Account/",
; "referenceId": "newAccount",
; "body": {
; "Name": "ACME Inc.",
; "Custom__c": "Hello world"
; }
; },
; {
; "method": "GET",
; "url": "/services/data/v{{version}}/sobjects/Account/@{newAccount.id}",
; "referenceId": "newAccountInfo"
; }
; ]
; }
; ]
; }
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("graphs[0].graphId","graph1")
$oJson.UpdateString("graphs[0].compositeRequest[0].method","POST")
$oJson.UpdateString("graphs[0].compositeRequest[0].url","/services/data/v{{version}}/sobjects/Account/")
$oJson.UpdateString("graphs[0].compositeRequest[0].referenceId","newAccount")
$oJson.UpdateString("graphs[0].compositeRequest[0].body.Name","ACME Inc.")
$oJson.UpdateString("graphs[0].compositeRequest[0].body.Custom__c","Hello world")
$oJson.UpdateString("graphs[0].compositeRequest[1].method","GET")
$oJson.UpdateString("graphs[0].compositeRequest[1].url","/services/data/v{{version}}/sobjects/Account/@{newAccount.id}")
$oJson.UpdateString("graphs[0].compositeRequest[1].referenceId","newAccountInfo")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oHttp.SetRequestHeader "Content-Type","application/json"
$oResp = ObjCreate("Chilkat.HttpResponse")
$bSuccess = $oHttp.HttpJson("POST","https://domain.com/services/data/v{{version}}/composite/graph",$oJson,"application/json",$oResp)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "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
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sGraphId
Local $bIsSuccessful
Local $iJ
Local $iCount_j
Local $sId
Local $bSuccess
Local $sLocation
Local $iHttpStatusCode
Local $sReferenceId
Local $iK
Local $iCount_k
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("graphs")
While $i < $iCount_i
$oJResp.I = $i
$sGraphId = $oJResp.StringOf("graphs[i].graphId")
$bIsSuccessful = $oJResp.BoolOf("graphs[i].isSuccessful")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("graphs[i].graphResponse.compositeResponse")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sId = $oJResp.StringOf("graphs[i].graphResponse.compositeResponse[j].body.id")
$bSuccess = $oJResp.BoolOf("graphs[i].graphResponse.compositeResponse[j].body.success")
$sLocation = $oJResp.StringOf("graphs[i].graphResponse.compositeResponse[j].httpHeaders.Location")
$iHttpStatusCode = $oJResp.IntOf("graphs[i].graphResponse.compositeResponse[j].httpStatusCode")
$sReferenceId = $oJResp.StringOf("graphs[i].graphResponse.compositeResponse[j].referenceId")
$iK = 0
$iCount_k = $oJResp.SizeOfArray("graphs[i].graphResponse.compositeResponse[j].body.errors")
While $iK < $iCount_k
$oJResp.K = $iK
$iK = $iK + 1
Wend
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
-d '{
"graphs": [
{
"graphId": "graph1",
"compositeRequest": [
{
"method": "POST",
"url": "/services/data/v{{version}}/sobjects/Account/",
"referenceId": "newAccount",
"body": {
"Name": "ACME Inc.",
"Custom__c": "Hello world"
}
},
{
"method": "GET",
"url": "/services/data/v{{version}}/sobjects/Account/@{newAccount.id}",
"referenceId": "newAccountInfo"
}
]
}
]
}'
https://domain.com/services/data/v{{version}}/composite/graph
Postman Collection Item JSON
{
"name": "Composite Graph",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graphs\": [\n {\n \"graphId\": \"graph1\",\n \"compositeRequest\": [\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v{{version}}/sobjects/Account/\",\n \"referenceId\": \"newAccount\",\n \"body\": {\n \"Name\": \"ACME Inc.\",\n \"Custom__c\": \"Hello world\"\n }\n },\n {\n \"method\": \"GET\",\n \"url\": \"/services/data/v{{version}}/sobjects/Account/@{newAccount.id}\",\n \"referenceId\": \"newAccountInfo\"\n }\n ]\n }\n ]\n}"
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/graph",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"graph"
]
},
"description": "Composite graphs provide an enhanced way to perform composite requests, which execute a series of REST API requests in a single call.\nRegular 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.\n\nComposite graphs extend this by allowing you to assemble a more complicated and complete series of related objects and records.\n\nComposite 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.\n\nRegular composite requests have a limit of 25 subrequests. Composite graphs increase this limit to 500. This gives a single API call much greater power.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_graph_introduction.htm"
},
"response": [
{
"name": "Successful Composite Graph",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"graphs\": [\n {\n \"graphId\": \"graph1\",\n \"compositeRequest\": [\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v{{version}}/sobjects/Account/\",\n \"referenceId\": \"newAccount\",\n \"body\": {\n \"Name\": \"ACME Inc.\"\n }\n },\n {\n \"method\": \"POST\",\n \"url\": \"/services/data/v{{version}}/sobjects/Contact/\",\n \"referenceId\": \"newContact\",\n \"body\": {\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"AccountId\": \"@{newAccount.id}\"\n }\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/composite/graph",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"composite",
"graph"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "cache-control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "content-type",
"value": "application/json;charset=UTF-8"
}
],
"cookie": [
],
"body": "{\n \"graphs\": [\n {\n \"graphId\": \"graph1\",\n \"graphResponse\": {\n \"compositeResponse\": [\n {\n \"body\": {\n \"id\": \"0014H00002x6HUhQAM\",\n \"success\": true,\n \"errors\": []\n },\n \"httpHeaders\": {\n \"Location\": \"/services/data/v50.0/sobjects/Account/0014H00002x6HUhQAM\"\n },\n \"httpStatusCode\": 201,\n \"referenceId\": \"newAccount\"\n },\n {\n \"body\": {\n \"id\": \"0034H00002JsInQQAV\",\n \"success\": true,\n \"errors\": []\n },\n \"httpHeaders\": {\n \"Location\": \"/services/data/v50.0/sobjects/Contact/0034H00002JsInQQAV\"\n },\n \"httpStatusCode\": 201,\n \"referenceId\": \"newContact\"\n }\n ]\n },\n \"isSuccessful\": true\n }\n ]\n}"
}
]
}
