Chilkat Online Tools

Swift / Salesforce Platform APIs / Composite Graph

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

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

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

    var resp: CkoHttpResponse? = http.PostJson3("https://domain.com/services/data/v{{version}}/composite/graph", contentType: "application/json", json: json)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    let sbResponseBody = CkoStringBuilder()
    resp!.GetBodySb(sbResponseBody)

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = resp!.StatusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.Header)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    var graphId: String?
    var isSuccessful: Bool
    var j: Int
    var count_j: Int
    var Id: String?
    var Success: Bool
    var Location: String?
    var httpStatusCode: Int
    var referenceId: String?
    var k: Int
    var count_k: Int

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("graphs").intValue
    while i < count_i {
        jResp.I = i
        graphId = jResp.StringOf("graphs[i].graphId")
        isSuccessful = jResp.BoolOf("graphs[i].isSuccessful")
        j = 0
        count_j = jResp.SizeOfArray("graphs[i].graphResponse.compositeResponse").intValue
        while j < count_j {
            jResp.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").intValue
            referenceId = jResp.StringOf("graphs[i].graphResponse.compositeResponse[j].referenceId")
            k = 0
            count_k = jResp.SizeOfArray("graphs[i].graphResponse.compositeResponse[j].body.errors").intValue
            while k < count_k {
                jResp.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}"
    }
  ]
}