Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Access Records

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnLocationColumn
LOCAL lnLocationLine
LOCAL lcName
LOCAL lcV_type
LOCAL j
LOCAL lnCount_j
LOCAL lcStrVal
LOCAL lcReturnType
LOCAL lcV_Type
LOCAL lcV_Url
LOCAL lcId
LOCAL lcNamespacePrefix
LOCAL lcName
LOCAL lnApiVersion
LOCAL lcStatus
LOCAL lnIsValid
LOCAL lnBodyCrc
LOCAL lcBody
LOCAL lnLengthWithoutComments
LOCAL lcCreatedDate
LOCAL lcCreatedById
LOCAL lcLastModifiedDate
LOCAL lcLastModifiedById
LOCAL lcSystemModstamp
LOCAL lcManageableState
LOCAL lcSymbolTableId
LOCAL lcKey
LOCAL lcSymbolTableName
LOCAL lcNamespace
LOCAL lcParentClass
LOCAL lnColumn
LOCAL lnLine
LOCAL lcTableDeclarationName
LOCAL lcTableDeclarationType
LOCAL lnMetadataApiVersion
LOCAL lcMetadataStatus
LOCAL lcUrls
LOCAL lcFullName
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://domain.com/services/data/v{{version}}/tooling/sobjects/:SOBJECT_API_NAME/:RECORD_ID",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

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

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    RELEASE loHttp
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

* 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

lcV_Type = loJResp.StringOf("attributes.type")
lcV_Url = loJResp.StringOf("attributes.url")
lcId = loJResp.StringOf("Id")
lcNamespacePrefix = loJResp.StringOf("NamespacePrefix")
lcName = loJResp.StringOf("Name")
lnApiVersion = loJResp.IntOf("ApiVersion")
lcStatus = loJResp.StringOf("Status")
lnIsValid = loJResp.BoolOf("IsValid")
lnBodyCrc = loJResp.IntOf("BodyCrc")
lcBody = loJResp.StringOf("Body")
lnLengthWithoutComments = loJResp.IntOf("LengthWithoutComments")
lcCreatedDate = loJResp.StringOf("CreatedDate")
lcCreatedById = loJResp.StringOf("CreatedById")
lcLastModifiedDate = loJResp.StringOf("LastModifiedDate")
lcLastModifiedById = loJResp.StringOf("LastModifiedById")
lcSystemModstamp = loJResp.StringOf("SystemModstamp")
lcManageableState = loJResp.StringOf("ManageableState")
lcSymbolTableId = loJResp.StringOf("SymbolTable.id")
lcKey = loJResp.StringOf("SymbolTable.key")
lcSymbolTableName = loJResp.StringOf("SymbolTable.name")
lcNamespace = loJResp.StringOf("SymbolTable.namespace")
lcParentClass = loJResp.StringOf("SymbolTable.parentClass")
lnColumn = loJResp.IntOf("SymbolTable.tableDeclaration.location.column")
lnLine = loJResp.IntOf("SymbolTable.tableDeclaration.location.line")
lcTableDeclarationName = loJResp.StringOf("SymbolTable.tableDeclaration.name")
lcTableDeclarationType = loJResp.StringOf("SymbolTable.tableDeclaration.type")
lnMetadataApiVersion = loJResp.IntOf("Metadata.apiVersion")
lcMetadataStatus = loJResp.StringOf("Metadata.status")
lcUrls = loJResp.StringOf("Metadata.urls")
lcFullName = loJResp.StringOf("FullName")
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.constructors")
DO WHILE i < lnCount_i
    loJResp.I = i
    lnLocationColumn = loJResp.IntOf("SymbolTable.constructors[i].location.column")
    lnLocationLine = loJResp.IntOf("SymbolTable.constructors[i].location.line")
    lcName = loJResp.StringOf("SymbolTable.constructors[i].name")
    lcV_type = loJResp.StringOf("SymbolTable.constructors[i].type")
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.constructors[i].annotations")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.constructors[i].modifiers")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcStrVal = loJResp.StringOf("SymbolTable.constructors[i].modifiers[j]")
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.constructors[i].parameters")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcName = loJResp.StringOf("SymbolTable.constructors[i].parameters[j].name")
        lcV_type = loJResp.StringOf("SymbolTable.constructors[i].parameters[j].type")
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.constructors[i].references")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.externalReferences")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.innerClasses")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.interfaces")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("SymbolTable.interfaces[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.methods")
DO WHILE i < lnCount_i
    loJResp.I = i
    lnLocationColumn = loJResp.IntOf("SymbolTable.methods[i].location.column")
    lnLocationLine = loJResp.IntOf("SymbolTable.methods[i].location.line")
    lcName = loJResp.StringOf("SymbolTable.methods[i].name")
    lcReturnType = loJResp.StringOf("SymbolTable.methods[i].returnType")
    lcV_type = loJResp.StringOf("SymbolTable.methods[i].type")
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.methods[i].annotations")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.methods[i].modifiers")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcStrVal = loJResp.StringOf("SymbolTable.methods[i].modifiers[j]")
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.methods[i].parameters")
    DO WHILE j < lnCount_j
        loJResp.J = j
        lcName = loJResp.StringOf("SymbolTable.methods[i].parameters[j].name")
        lcV_type = loJResp.StringOf("SymbolTable.methods[i].parameters[j].type")
        j = j + 1
    ENDDO
    j = 0
    lnCount_j = loJResp.SizeOfArray("SymbolTable.methods[i].references")
    DO WHILE j < lnCount_j
        loJResp.J = j
        j = j + 1
    ENDDO
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.properties")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.tableDeclaration.annotations")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcName = loJResp.StringOf("SymbolTable.tableDeclaration.annotations[i].name")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.tableDeclaration.modifiers")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcStrVal = loJResp.StringOf("SymbolTable.tableDeclaration.modifiers[i]")
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.tableDeclaration.references")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("SymbolTable.variables")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("Metadata.packageVersions")
DO WHILE i < lnCount_i
    loJResp.I = i
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp

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