Chilkat Online Tools

phpExt / Salesforce Platform APIs / Composite Graph

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

// 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"
//         }
//       ]
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('graphs[0].graphId','graph1');
$json->UpdateString('graphs[0].compositeRequest[0].method','POST');
$json->UpdateString('graphs[0].compositeRequest[0].url','/services/data/v{{version}}/sobjects/Account/');
$json->UpdateString('graphs[0].compositeRequest[0].referenceId','newAccount');
$json->UpdateString('graphs[0].compositeRequest[0].body.Name','ACME Inc.');
$json->UpdateString('graphs[0].compositeRequest[0].body.Custom__c','Hello world');
$json->UpdateString('graphs[0].compositeRequest[1].method','GET');
$json->UpdateString('graphs[0].compositeRequest[1].url','/services/data/v{{version}}/sobjects/Account/@{newAccount.id}');
$json->UpdateString('graphs[0].compositeRequest[1].referenceId','newAccountInfo');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/services/data/v{{version}}/composite/graph','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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

$i = 0;
$count_i = $jResp->SizeOfArray('graphs');
while ($i < $count_i) {
    $jResp->put_I($i);
    $graphId = $jResp->stringOf('graphs[i].graphId');
    $isSuccessful = $jResp->BoolOf('graphs[i].isSuccessful');
    $j = 0;
    $count_j = $jResp->SizeOfArray('graphs[i].graphResponse.compositeResponse');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $Id = $jResp->stringOf('graphs[i].graphResponse.compositeResponse[j].body.id');
        $Success = $jResp->BoolOf('graphs[i].graphResponse.compositeResponse[j].body.success');
        $Location = $jResp->stringOf('graphs[i].graphResponse.compositeResponse[j].httpHeaders.Location');
        $httpStatusCode = $jResp->IntOf('graphs[i].graphResponse.compositeResponse[j].httpStatusCode');
        $referenceId = $jResp->stringOf('graphs[i].graphResponse.compositeResponse[j].referenceId');
        $k = 0;
        $count_k = $jResp->SizeOfArray('graphs[i].graphResponse.compositeResponse[j].body.errors');
        while ($k < $count_k) {
            $jResp->put_K($k);
            $k = $k + 1;
        }

        $j = $j + 1;
    }

    $i = $i + 1;
}


?>

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}"
    }
  ]
}