Chilkat Online Tools

lianja / Salesforce Platform APIs / Composite Graph

Back to Collection Items

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

loHttp = createobject("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"
//         }
//       ]
//     }
//   ]
// }

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

// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loHttp.SetRequestHeader("Content-Type","application/json")

loResp = loHttp.PostJson3("https://domain.com/services/data/v{{version}}/composite/graph","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    release loResp
    release loHttp
    release loJson
    release loSbResponseBody
    release loJResp
    return
endif

release loResp

// 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
lnCount_i = loJResp.SizeOfArray("graphs")
do while i < lnCount_i
    loJResp.I = i
    lcGraphId = loJResp.StringOf("graphs[i].graphId")
    llIsSuccessful = loJResp.BoolOf("graphs[i].isSuccessful")
    j = 0
    lnCount_j = loJResp.SizeOfArray("graphs[i].graphResponse.compositeResponse")
    do while j < lnCount_j
        loJResp.J = j
        lcId = loJResp.StringOf("graphs[i].graphResponse.compositeResponse[j].body.id")
        llSuccess = loJResp.BoolOf("graphs[i].graphResponse.compositeResponse[j].body.success")
        lcLocation = loJResp.StringOf("graphs[i].graphResponse.compositeResponse[j].httpHeaders.Location")
        lnHttpStatusCode = loJResp.IntOf("graphs[i].graphResponse.compositeResponse[j].httpStatusCode")
        lcReferenceId = loJResp.StringOf("graphs[i].graphResponse.compositeResponse[j].referenceId")
        k = 0
        lnCount_k = loJResp.SizeOfArray("graphs[i].graphResponse.compositeResponse[j].body.errors")
        do while k < lnCount_k
            loJResp.K = k
            k = k + 1
        enddo
        j = j + 1
    enddo
    i = i + 1
enddo


release loHttp
release loJson
release loSbResponseBody
release loJResp

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