Chilkat Online Tools

Foxpro / Salesforce Platform APIs / Tooling Search

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_Type
LOCAL lcV_Url
LOCAL lcName
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')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("q","")
loQueryParams.UpdateString('[    {        "className": "YourClassName",        "testMethods": [            "testMethod1",            "testMethod2",            "testMethod3"        ]    },    {        "maxFailedTests": "2"    }]or[    {        "classId": "01pD0000000Fhy9IAC",        "testMethods": [            "testMethod1",            "testMethod2",            "testMethod3"        ]    },    {        "maxFailedTests": "2"    }]',"")

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

loResp = loHttp.QuickRequestParams("GET","https://domain.com/services/data/v{{version}}/tooling/search",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* 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 = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

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

* {
*   "searchRecords": [
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA"
*       },
*       "Name": "LightningSelfRegisterController"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA"
*       },
*       "Name": "LightningSelfRegisterControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA"
*       },
*       "Name": "SiteRegisterControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ"
*       },
*       "Name": "PrepareSandboxTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ"
*       },
*       "Name": "CommunitiesSelfRegControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE"
*       },
*       "Name": "MicrobatchSelfRegControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4"
*       },
*       "Name": "PrepareSandbox"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ"
*       },
*       "Name": "CommunitiesLandingControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ"
*       },
*       "Name": "MyProfilePageControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ"
*       },
*       "Name": "ForgotPasswordControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA"
*       },
*       "Name": "SiteLoginControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD"
*       },
*       "Name": "AccountTriggerHelperTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA"
*       },
*       "Name": "LightningForgotPasswordControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA"
*       },
*       "Name": "LightningLoginFormControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA"
*       },
*       "Name": "LightningLoginFormController"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ"
*       },
*       "Name": "CommunitiesSelfRegConfirmControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ"
*       },
*       "Name": "CommunitiesLoginControllerTest"
*     },
*     {
*       "attributes": {
*         "type": "ApexClass",
*         "url": "/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ"
*       },
*       "Name": "ChangePasswordControllerTest"
*     }
*   ]
* }

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

i = 0
lnCount_i = loJResp.SizeOfArray("searchRecords")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcV_Type = loJResp.StringOf("searchRecords[i].attributes.type")
    lcV_Url = loJResp.StringOf("searchRecords[i].attributes.url")
    lcName = loJResp.StringOf("searchRecords[i].Name")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

curl -G -d "q="
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '[
    {
        "className": "YourClassName",
        "testMethods": [
            "testMethod1",
            "testMethod2",
            "testMethod3"
        ]
    },
    {
        "maxFailedTests": "2"
    }
]

or

[
    {
        "classId": "01pD0000000Fhy9IAC",
        "testMethods": [
            "testMethod1",
            "testMethod2",
            "testMethod3"
        ]
    },
    {
        "maxFailedTests": "2"
    }
]'
https://domain.com/services/data/v{{version}}/tooling/search

Postman Collection Item JSON

{
  "name": "Tooling Search",
  "protocolProfileBehavior": {
    "disableBodyPruning": true
  },
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "[\n    {\n        \"className\": \"YourClassName\",\n        \"testMethods\": [\n            \"testMethod1\",\n            \"testMethod2\",\n            \"testMethod3\"\n        ]\n    },\n    {\n        \"maxFailedTests\": \"2\"\n    }\n]\n\nor\n\n[\n    {\n        \"classId\": \"01pD0000000Fhy9IAC\",\n        \"testMethods\": [\n            \"testMethod1\",\n            \"testMethod2\",\n            \"testMethod3\"\n        ]\n    },\n    {\n        \"maxFailedTests\": \"2\"\n    }\n]",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/search?q=",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "tooling",
        "search"
      ],
      "query": [
        {
          "key": "q",
          "value": "",
          "description": "SOSL search statement"
        }
      ]
    },
    "description": "Runs one or more methods within one or more Apex classes, using the asynchronous test execution mechanism. In the request body, you can specify test class names and IDs, suite names and IDs, the maximum number of failed tests to allow, and the test level, as comma-separated lists or as an array. You can also indicate whether to opt out of collecting code coverage information during the test run (available in API version 43.0 and later)."
  },
  "response": [
    {
      "name": "Tooling Search",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "[\n    {\n        \"className\": \"YourClassName\",\n        \"testMethods\": [\n            \"testMethod1\",\n            \"testMethod2\",\n            \"testMethod3\"\n        ]\n    },\n    {\n        \"maxFailedTests\": \"2\"\n    }\n]\n\nor\n\n[\n    {\n        \"classId\": \"01pD0000000Fhy9IAC\",\n        \"testMethods\": [\n            \"testMethod1\",\n            \"testMethod2\",\n            \"testMethod3\"\n        ]\n    },\n    {\n        \"maxFailedTests\": \"2\"\n    }\n]",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/tooling/search?q=FIND {test*} IN ALL FIELDS RETURNING ApexClass (Name)",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "tooling",
            "search"
          ],
          "query": [
            {
              "key": "q",
              "value": "FIND {test*} IN ALL FIELDS RETURNING ApexClass (Name)",
              "description": "SOSL_Search_Statement"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 11 Dec 2023 10:34:10 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=294/15000"
        },
        {
          "key": "queryId",
          "value": "-mxbcxdoqukvy"
        },
        {
          "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    \"searchRecords\": [\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqcAAA\"\n            },\n            \"Name\": \"LightningSelfRegisterController\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqhAAA\"\n            },\n            \"Name\": \"LightningSelfRegisterControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq9AAA\"\n            },\n            \"Name\": \"SiteRegisterControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000A0zYxQAJ\"\n            },\n            \"Name\": \"PrepareSandboxTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqTAAQ\"\n            },\n            \"Name\": \"CommunitiesSelfRegControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009aIwvQAE\"\n            },\n            \"Name\": \"MicrobatchSelfRegControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H000009PEFIQA4\"\n            },\n            \"Name\": \"PrepareSandbox\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqRAAQ\"\n            },\n            \"Name\": \"CommunitiesLandingControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqFAAQ\"\n            },\n            \"Name\": \"MyProfilePageControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqDAAQ\"\n            },\n            \"Name\": \"ForgotPasswordControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wq7AAA\"\n            },\n            \"Name\": \"SiteLoginControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p4H00000ANdnqQAD\"\n            },\n            \"Name\": \"AccountTriggerHelperTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqgAAA\"\n            },\n            \"Name\": \"LightningForgotPasswordControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqfAAA\"\n            },\n            \"Name\": \"LightningLoginFormControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqeAAA\"\n            },\n            \"Name\": \"LightningLoginFormController\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqVAAQ\"\n            },\n            \"Name\": \"CommunitiesSelfRegConfirmControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqPAAQ\"\n            },\n            \"Name\": \"CommunitiesLoginControllerTest\"\n        },\n        {\n            \"attributes\": {\n                \"type\": \"ApexClass\",\n                \"url\": \"/services/data/v59.0/tooling/sobjects/ApexClass/01p580000090wqBAAQ\"\n            },\n            \"Name\": \"ChangePasswordControllerTest\"\n        }\n    ]\n}"
    }
  ]
}