Chilkat Online Tools

Swift / Salesforce Platform APIs / Composite

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.

    // {
    //   "compositeRequest": [
    //     {
    //       "method": "POST",
    //       "url": "/services/data/v{{version}}/sobjects/Account",
    //       "referenceId": "refAccount",
    //       "body": {
    //         "Name": "Sample Account"
    //       }
    //     },
    //     {
    //       "method": "POST",
    //       "url": "/services/data/v{{version}}/sobjects/Contact",
    //       "referenceId": "refContact",
    //       "body": {
    //         "LastName": "Sample Contact",
    //         "AccountId": "@{refAccount.id}"
    //       }
    //     }
    //   ]
    // }

    let json = CkoJsonObject()
    json.UpdateString("compositeRequest[0].method", value: "POST")
    json.UpdateString("compositeRequest[0].url", value: "/services/data/v{{version}}/sobjects/Account")
    json.UpdateString("compositeRequest[0].referenceId", value: "refAccount")
    json.UpdateString("compositeRequest[0].body.Name", value: "Sample Account")
    json.UpdateString("compositeRequest[1].method", value: "POST")
    json.UpdateString("compositeRequest[1].url", value: "/services/data/v{{version}}/sobjects/Contact")
    json.UpdateString("compositeRequest[1].referenceId", value: "refContact")
    json.UpdateString("compositeRequest[1].body.LastName", value: "Sample Contact")
    json.UpdateString("compositeRequest[1].body.AccountId", value: "@{refAccount.id}")

    // 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/", 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)

    // {
    //   "compositeResponse": [
    //     {
    //       "body": {
    //         "id": "001...",
    //         "success": true,
    //         "errors": [
    //         ]
    //       },
    //       "httpHeaders": {
    //         "Location": "/services/data/v53.0/sobjects/Account/001..."
    //       },
    //       "httpStatusCode": 201,
    //       "referenceId": "refAccount"
    //     },
    //     {
    //       "body": {
    //         "id": "0032o00003WauzJAAR",
    //         "success": true,
    //         "errors": [
    //         ]
    //       },
    //       "httpHeaders": {
    //         "Location": "/services/data/v53.0/sobjects/Contact/003..."
    //       },
    //       "httpStatusCode": 201,
    //       "referenceId": "refContact"
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var Id: String?
    var Success: Bool
    var Location: String?
    var httpStatusCode: Int
    var referenceId: String?
    var j: Int
    var count_j: Int

    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("compositeResponse").intValue
    while i < count_i {
        jResp.I = i
        Id = jResp.StringOf("compositeResponse[i].body.id")
        Success = jResp.BoolOf("compositeResponse[i].body.success")
        Location = jResp.StringOf("compositeResponse[i].httpHeaders.Location")
        httpStatusCode = jResp.IntOf("compositeResponse[i].httpStatusCode").intValue
        referenceId = jResp.StringOf("compositeResponse[i].referenceId")
        j = 0
        count_j = jResp.SizeOfArray("compositeResponse[i].body.errors").intValue
        while j < count_j {
            jResp.J = j
            j = j + 1
        }

        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "compositeRequest": [
        {
            "method": "POST",
            "url": "/services/data/v{{version}}/sobjects/Account",
            "referenceId": "refAccount",
            "body": {
                "Name": "Sample Account"
            }
        },
        {
            "method": "POST",
            "url": "/services/data/v{{version}}/sobjects/Contact",
            "referenceId": "refContact",
            "body": {
                "LastName": "Sample Contact",
                "AccountId": "@{refAccount.id}"
            }
        }
    ]
}'
https://domain.com/services/data/v{{version}}/composite/

Postman Collection Item JSON

{
  "name": "Composite",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"compositeRequest\": [\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v{{version}}/sobjects/Account\",\n            \"referenceId\": \"refAccount\",\n            \"body\": {\n                \"Name\": \"Sample Account\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v{{version}}/sobjects/Contact\",\n            \"referenceId\": \"refContact\",\n            \"body\": {\n                \"LastName\": \"Sample Contact\",\n                \"AccountId\": \"@{refAccount.id}\"\n            }\n        }\n    ]\n}"
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/composite/",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "composite",
        ""
      ]
    },
    "description": "Executes a series of REST API requests in a single call. You can use the output of one request as the input to a subsequent request. The response bodies and HTTP statuses of the requests are returned in a single response body. The entire request counts as a single call toward your API limits.\nThe requests in a composite call are called subrequests. All subrequests are executed in the context of the same user. In a subrequest’s body, you specify a reference ID that maps to the subrequest’s response. You can then refer to the ID in the url or body fields of later subrequests by using a JavaScript-like reference notation.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm"
  },
  "response": [
    {
      "name": "Successful Composite",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "value": "application/json",
            "type": "text"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"compositeRequest\": [\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v53.0/sobjects/Account\",\n            \"referenceId\": \"refAccount\",\n            \"body\": {\n                \"Name\": \"Sample Account\"\n            }\n        },\n        {\n            \"method\": \"POST\",\n            \"url\": \"/services/data/v53.0/sobjects/Contact\",\n            \"referenceId\": \"refContact\",\n            \"body\": {\n                \"LastName\": \"Sample Contact\",\n                \"AccountId\": \"@{refAccount.id}\"\n            }\n        }\n    ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/composite/",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "composite",
            ""
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 15:18:26 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=33/15000"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"compositeResponse\": [\n        {\n            \"body\": {\n                \"id\": \"001...\",\n                \"success\": true,\n                \"errors\": []\n            },\n            \"httpHeaders\": {\n                \"Location\": \"/services/data/v53.0/sobjects/Account/001...\"\n            },\n            \"httpStatusCode\": 201,\n            \"referenceId\": \"refAccount\"\n        },\n        {\n            \"body\": {\n                \"id\": \"0032o00003WauzJAAR\",\n                \"success\": true,\n                \"errors\": []\n            },\n            \"httpHeaders\": {\n                \"Location\": \"/services/data/v53.0/sobjects/Contact/003...\"\n            },\n            \"httpStatusCode\": 201,\n            \"referenceId\": \"refContact\"\n        }\n    ]\n}"
    }
  ]
}