Chilkat Online Tools

C# / Salesforce Platform APIs / Access Records

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    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

int locationColumn;
int locationLine;
string name;
string v_type;
int j;
int count_j;
string strVal;
string returnType;

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

    j = 0;
    count_j = jResp.SizeOfArray("SymbolTable.constructors[i].modifiers");
    while (j < count_j) {
        jResp.J = j;
        strVal = jResp.StringOf("SymbolTable.constructors[i].modifiers[j]");
        j = j + 1;
    }

    j = 0;
    count_j = jResp.SizeOfArray("SymbolTable.constructors[i].parameters");
    while (j < count_j) {
        jResp.J = j;
        name = jResp.StringOf("SymbolTable.constructors[i].parameters[j].name");
        v_type = jResp.StringOf("SymbolTable.constructors[i].parameters[j].type");
        j = j + 1;
    }

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

    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.externalReferences");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.innerClasses");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.interfaces");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("SymbolTable.interfaces[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.methods");
while (i < count_i) {
    jResp.I = i;
    locationColumn = jResp.IntOf("SymbolTable.methods[i].location.column");
    locationLine = jResp.IntOf("SymbolTable.methods[i].location.line");
    name = jResp.StringOf("SymbolTable.methods[i].name");
    returnType = jResp.StringOf("SymbolTable.methods[i].returnType");
    v_type = jResp.StringOf("SymbolTable.methods[i].type");
    j = 0;
    count_j = jResp.SizeOfArray("SymbolTable.methods[i].annotations");
    while (j < count_j) {
        jResp.J = j;
        j = j + 1;
    }

    j = 0;
    count_j = jResp.SizeOfArray("SymbolTable.methods[i].modifiers");
    while (j < count_j) {
        jResp.J = j;
        strVal = jResp.StringOf("SymbolTable.methods[i].modifiers[j]");
        j = j + 1;
    }

    j = 0;
    count_j = jResp.SizeOfArray("SymbolTable.methods[i].parameters");
    while (j < count_j) {
        jResp.J = j;
        name = jResp.StringOf("SymbolTable.methods[i].parameters[j].name");
        v_type = jResp.StringOf("SymbolTable.methods[i].parameters[j].type");
        j = j + 1;
    }

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

    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.properties");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.tableDeclaration.annotations");
while (i < count_i) {
    jResp.I = i;
    name = jResp.StringOf("SymbolTable.tableDeclaration.annotations[i].name");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.tableDeclaration.modifiers");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("SymbolTable.tableDeclaration.modifiers[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.tableDeclaration.references");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("SymbolTable.variables");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("Metadata.packageVersions");
while (i < count_i) {
    jResp.I = i;
    i = i + 1;
}

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