Chilkat Online Tools

C / Salesforce Platform APIs / Access Records

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkStringBuilder sbResponseBody;
    HCkJsonObject jResp;
    int respStatusCode;
    int locationColumn;
    int locationLine;
    const char *name;
    const char *v_type;
    int j;
    int count_j;
    const char *strVal;
    const char *returnType;
    const char *v_Type;
    const char *v_Url;
    const char *Id;
    const char *NamespacePrefix;
    const char *Name;
    int ApiVersion;
    const char *Status;
    BOOL IsValid;
    int BodyCrc;
    const char *Body;
    int LengthWithoutComments;
    const char *CreatedDate;
    const char *CreatedById;
    const char *LastModifiedDate;
    const char *LastModifiedById;
    const char *SystemModstamp;
    const char *ManageableState;
    const char *SymbolTableId;
    const char *Key;
    const char *SymbolTableName;
    const char *Namespace;
    const char *ParentClass;
    int Column;
    int Line;
    const char *TableDeclarationName;
    const char *TableDeclarationType;
    int MetadataApiVersion;
    const char *MetadataStatus;
    const char *Urls;
    const char *FullName;
    int i;
    int count_i;

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

    http = CkHttp_Create();

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttp_putAuthToken(http,"<access_token>");

    sbResponseBody = CkStringBuilder_Create();
    success = CkHttp_QuickGetSb(http,"https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID",sbResponseBody);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObject_Create();
    CkJsonObject_LoadSb(jResp,sbResponseBody);
    CkJsonObject_putEmitCompact(jResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonObject_emit(jResp));

    respStatusCode = CkHttp_getLastStatus(http);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttp_lastHeader(http));
        printf("Failed.\n");
        CkHttp_Dispose(http);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonObject_Dispose(jResp);
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "attributes": {
    //     "type": "ApexClass",
    //     "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfqQAB"
    //   },
    //   "Id": "01p4H00000A4kfqQAB",
    //   "NamespacePrefix": "smon",
    //   "Name": "GenericEventPostMock",
    //   "ApiVersion": 59,
    //   "Status": "Active",
    //   "IsValid": false,
    //   "BodyCrc": -1,
    //   "Body": "/*\nThis file is generated and isn't the actual source code for this\nmanaged global class.\nThis read-only file shows the class's global constructors,\nmethods, variables, and properties.\nTo enable code to compile, all methods return null.\n*/\nglobal class GenericEventPostMock implements System.HttpCalloutMock {\n    global GenericEventPostMock(Integer statusCode) {\n\n    }\n    global System.HttpResponse respond(System.HttpRequest req) {\n        return null;\n    }\n}\n",
    //   "LengthWithoutComments": -1,
    //   "CreatedDate": "2023-11-20T08:03:40.000+0000",
    //   "CreatedById": "00558000000yFyDAAU",
    //   "LastModifiedDate": "2023-11-20T08:03:40.000+0000",
    //   "LastModifiedById": "00558000000yFyDAAU",
    //   "SystemModstamp": "2023-11-26T14:10:11.000+0000",
    //   "ManageableState": "installed",
    //   "SymbolTable": {
    //     "constructors": [
    //       {
    //         "annotations": [
    //         ],
    //         "location": {
    //           "column": 12,
    //           "line": 5
    //         },
    //         "modifiers": [
    //           "global"
    //         ],
    //         "name": "GenericEventPostMock",
    //         "parameters": [
    //           {
    //             "name": "statusCode",
    //             "type": "Integer"
    //           }
    //         ],
    //         "references": [
    //         ],
    //         "type": null
    //       }
    //     ],
    //     "externalReferences": [
    //     ],
    //     "id": "smon.GenericEventPostMock",
    //     "innerClasses": [
    //     ],
    //     "interfaces": [
    //       "System.HttpCalloutMock"
    //     ],
    //     "key": "smon.GenericEventPostMock",
    //     "methods": [
    //       {
    //         "annotations": [
    //         ],
    //         "location": {
    //           "column": 25,
    //           "line": 9
    //         },
    //         "modifiers": [
    //           "global"
    //         ],
    //         "name": "respond",
    //         "parameters": [
    //           {
    //             "name": "req",
    //             "type": "System.HttpRequest"
    //           }
    //         ],
    //         "references": [
    //         ],
    //         "returnType": "System.HttpResponse",
    //         "type": null
    //       }
    //     ],
    //     "name": "GenericEventPostMock",
    //     "namespace": "smon",
    //     "parentClass": "",
    //     "properties": [
    //     ],
    //     "tableDeclaration": {
    //       "annotations": [
    //         {
    //           "name": "IsTest"
    //         }
    //       ],
    //       "location": {
    //         "column": 14,
    //         "line": 2
    //       },
    //       "modifiers": [
    //         "testMethod",
    //         "global"
    //       ],
    //       "name": "GenericEventPostMock",
    //       "references": [
    //       ],
    //       "type": "smon.GenericEventPostMock"
    //     },
    //     "variables": [
    //     ]
    //   },
    //   "Metadata": {
    //     "apiVersion": 59,
    //     "packageVersions": [
    //     ],
    //     "status": "Active",
    //     "urls": null
    //   },
    //   "FullName": "smon__GenericEventPostMock"
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    v_Type = CkJsonObject_stringOf(jResp,"attributes.type");
    v_Url = CkJsonObject_stringOf(jResp,"attributes.url");
    Id = CkJsonObject_stringOf(jResp,"Id");
    NamespacePrefix = CkJsonObject_stringOf(jResp,"NamespacePrefix");
    Name = CkJsonObject_stringOf(jResp,"Name");
    ApiVersion = CkJsonObject_IntOf(jResp,"ApiVersion");
    Status = CkJsonObject_stringOf(jResp,"Status");
    IsValid = CkJsonObject_BoolOf(jResp,"IsValid");
    BodyCrc = CkJsonObject_IntOf(jResp,"BodyCrc");
    Body = CkJsonObject_stringOf(jResp,"Body");
    LengthWithoutComments = CkJsonObject_IntOf(jResp,"LengthWithoutComments");
    CreatedDate = CkJsonObject_stringOf(jResp,"CreatedDate");
    CreatedById = CkJsonObject_stringOf(jResp,"CreatedById");
    LastModifiedDate = CkJsonObject_stringOf(jResp,"LastModifiedDate");
    LastModifiedById = CkJsonObject_stringOf(jResp,"LastModifiedById");
    SystemModstamp = CkJsonObject_stringOf(jResp,"SystemModstamp");
    ManageableState = CkJsonObject_stringOf(jResp,"ManageableState");
    SymbolTableId = CkJsonObject_stringOf(jResp,"SymbolTable.id");
    Key = CkJsonObject_stringOf(jResp,"SymbolTable.key");
    SymbolTableName = CkJsonObject_stringOf(jResp,"SymbolTable.name");
    Namespace = CkJsonObject_stringOf(jResp,"SymbolTable.namespace");
    ParentClass = CkJsonObject_stringOf(jResp,"SymbolTable.parentClass");
    Column = CkJsonObject_IntOf(jResp,"SymbolTable.tableDeclaration.location.column");
    Line = CkJsonObject_IntOf(jResp,"SymbolTable.tableDeclaration.location.line");
    TableDeclarationName = CkJsonObject_stringOf(jResp,"SymbolTable.tableDeclaration.name");
    TableDeclarationType = CkJsonObject_stringOf(jResp,"SymbolTable.tableDeclaration.type");
    MetadataApiVersion = CkJsonObject_IntOf(jResp,"Metadata.apiVersion");
    MetadataStatus = CkJsonObject_stringOf(jResp,"Metadata.status");
    Urls = CkJsonObject_stringOf(jResp,"Metadata.urls");
    FullName = CkJsonObject_stringOf(jResp,"FullName");
    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.constructors");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        locationColumn = CkJsonObject_IntOf(jResp,"SymbolTable.constructors[i].location.column");
        locationLine = CkJsonObject_IntOf(jResp,"SymbolTable.constructors[i].location.line");
        name = CkJsonObject_stringOf(jResp,"SymbolTable.constructors[i].name");
        v_type = CkJsonObject_stringOf(jResp,"SymbolTable.constructors[i].type");
        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.constructors[i].annotations");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.constructors[i].modifiers");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            strVal = CkJsonObject_stringOf(jResp,"SymbolTable.constructors[i].modifiers[j]");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.constructors[i].parameters");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            name = CkJsonObject_stringOf(jResp,"SymbolTable.constructors[i].parameters[j].name");
            v_type = CkJsonObject_stringOf(jResp,"SymbolTable.constructors[i].parameters[j].type");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.constructors[i].references");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.externalReferences");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.innerClasses");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.interfaces");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"SymbolTable.interfaces[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.methods");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        locationColumn = CkJsonObject_IntOf(jResp,"SymbolTable.methods[i].location.column");
        locationLine = CkJsonObject_IntOf(jResp,"SymbolTable.methods[i].location.line");
        name = CkJsonObject_stringOf(jResp,"SymbolTable.methods[i].name");
        returnType = CkJsonObject_stringOf(jResp,"SymbolTable.methods[i].returnType");
        v_type = CkJsonObject_stringOf(jResp,"SymbolTable.methods[i].type");
        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.methods[i].annotations");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.methods[i].modifiers");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            strVal = CkJsonObject_stringOf(jResp,"SymbolTable.methods[i].modifiers[j]");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.methods[i].parameters");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            name = CkJsonObject_stringOf(jResp,"SymbolTable.methods[i].parameters[j].name");
            v_type = CkJsonObject_stringOf(jResp,"SymbolTable.methods[i].parameters[j].type");
            j = j + 1;
        }

        j = 0;
        count_j = CkJsonObject_SizeOfArray(jResp,"SymbolTable.methods[i].references");
        while (j < count_j) {
            CkJsonObject_putJ(jResp,j);
            j = j + 1;
        }

        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.properties");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.tableDeclaration.annotations");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        name = CkJsonObject_stringOf(jResp,"SymbolTable.tableDeclaration.annotations[i].name");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.tableDeclaration.modifiers");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        strVal = CkJsonObject_stringOf(jResp,"SymbolTable.tableDeclaration.modifiers[i]");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.tableDeclaration.references");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"SymbolTable.variables");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObject_SizeOfArray(jResp,"Metadata.packageVersions");
    while (i < count_i) {
        CkJsonObject_putI(jResp,i);
        i = i + 1;
    }



    CkHttp_Dispose(http);
    CkStringBuilder_Dispose(sbResponseBody);
    CkJsonObject_Dispose(jResp);

    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID

Postman Collection Item JSON

{
  "name": "Access Records",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "sobjects",
        ":SOBJECT_API_NAME",
        ":RECORD_ID"
      ],
      "variable": [
        {
          "key": "SOBJECT_API_NAME",
          "value": ""
        },
        {
          "key": "RECORD_ID",
          "value": ""
        }
      ]
    }
  },
  "response": [
    {
      "name": "Access Records",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "sobjects",
            ":SOBJECT_API_NAME",
            ":RECORD_ID"
          ],
          "variable": [
            {
              "key": "SOBJECT_API_NAME",
              "value": "ApexClass"
            },
            {
              "key": "RECORD_ID",
              "value": "01p4H00000A4kfqQAB"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 11 Dec 2023 10:38:26 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "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=308/15000"
        },
        {
          "key": "Last-Modified",
          "value": "Sun, 26 Nov 2023 14:10:11 GMT"
        },
        {
          "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    \"attributes\": {\n        \"type\": \"ApexClass\",\n        \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A4kfqQAB\"\n    },\n    \"Id\": \"01p4H00000A4kfqQAB\",\n    \"NamespacePrefix\": \"smon\",\n    \"Name\": \"GenericEventPostMock\",\n    \"ApiVersion\": 59,\n    \"Status\": \"Active\",\n    \"IsValid\": false,\n    \"BodyCrc\": -1,\n    \"Body\": \"/*\\nThis file is generated and isn't the actual source code for this\\nmanaged global class.\\nThis read-only file shows the class's global constructors,\\nmethods, variables, and properties.\\nTo enable code to compile, all methods return null.\\n*/\\nglobal class GenericEventPostMock implements System.HttpCalloutMock {\\n    global GenericEventPostMock(Integer statusCode) {\\n\\n    }\\n    global System.HttpResponse respond(System.HttpRequest req) {\\n        return null;\\n    }\\n}\\n\",\n    \"LengthWithoutComments\": -1,\n    \"CreatedDate\": \"2023-11-20T08:03:40.000+0000\",\n    \"CreatedById\": \"00558000000yFyDAAU\",\n    \"LastModifiedDate\": \"2023-11-20T08:03:40.000+0000\",\n    \"LastModifiedById\": \"00558000000yFyDAAU\",\n    \"SystemModstamp\": \"2023-11-26T14:10:11.000+0000\",\n    \"ManageableState\": \"installed\",\n    \"SymbolTable\": {\n        \"constructors\": [\n            {\n                \"annotations\": [],\n                \"location\": {\n                    \"column\": 12,\n                    \"line\": 5\n                },\n                \"modifiers\": [\n                    \"global\"\n                ],\n                \"name\": \"GenericEventPostMock\",\n                \"parameters\": [\n                    {\n                        \"name\": \"statusCode\",\n                        \"type\": \"Integer\"\n                    }\n                ],\n                \"references\": [],\n                \"type\": null\n            }\n        ],\n        \"externalReferences\": [],\n        \"id\": \"smon.GenericEventPostMock\",\n        \"innerClasses\": [],\n        \"interfaces\": [\n            \"System.HttpCalloutMock\"\n        ],\n        \"key\": \"smon.GenericEventPostMock\",\n        \"methods\": [\n            {\n                \"annotations\": [],\n                \"location\": {\n                    \"column\": 25,\n                    \"line\": 9\n                },\n                \"modifiers\": [\n                    \"global\"\n                ],\n                \"name\": \"respond\",\n                \"parameters\": [\n                    {\n                        \"name\": \"req\",\n                        \"type\": \"System.HttpRequest\"\n                    }\n                ],\n                \"references\": [],\n                \"returnType\": \"System.HttpResponse\",\n                \"type\": null\n            }\n        ],\n        \"name\": \"GenericEventPostMock\",\n        \"namespace\": \"smon\",\n        \"parentClass\": \"\",\n        \"properties\": [],\n        \"tableDeclaration\": {\n            \"annotations\": [\n                {\n                    \"name\": \"IsTest\"\n                }\n            ],\n            \"location\": {\n                \"column\": 14,\n                \"line\": 2\n            },\n            \"modifiers\": [\n                \"testMethod\",\n                \"global\"\n            ],\n            \"name\": \"GenericEventPostMock\",\n            \"references\": [],\n            \"type\": \"smon.GenericEventPostMock\"\n        },\n        \"variables\": []\n    },\n    \"Metadata\": {\n        \"apiVersion\": 59,\n        \"packageVersions\": [],\n        \"status\": \"Active\",\n        \"urls\": null\n    },\n    \"FullName\": \"smon__GenericEventPostMock\"\n}"
    }
  ]
}