Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "resources": [
; YOUR_SOBJECT_SELECTORS
; ]
; }
$oJson = ObjCreate("Chilkat.JsonObject")
ERROR: Undefined variable(YOUR_SOBJECT_SELECTORS)
$oJson.UpdateInt("resources[0]",ERROR: Undefined variable(YOUR_SOBJECT_SELECTORS)
)
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.PostJson3("https://domain.com/services/data/v{{version}}/async/specifications/oas3","application/json",$oJson)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "href": "/v59.0/async/specifications/oas3/NTByNEgwMDAwMDAwMDAx"
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sHref = $oJResp.StringOf("href")
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"resources": [
YOUR_SOBJECT_SELECTORS
]
}'
https://domain.com/services/data/v{{version}}/async/specifications/oas3
Postman Collection Item JSON
{
"name": "Request OpenAPI Schema",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"resources\": [\n YOUR_SOBJECT_SELECTORS\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/async/specifications/oas3",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"async",
"specifications",
"oas3"
]
},
"description": "Requests an Open API document for the selected SObject REST API resources."
},
"response": [
{
"name": "Generate OpenAPI Schema",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"resources\": [\n \"/services/data/v60.0/sobjects/Contact\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/async/specifications/oas3",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"async",
"specifications",
"oas3"
]
}
},
"status": "Accepted",
"code": 202,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Mon, 26 Feb 2024 13:50:18 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=9/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 \"href\": \"/v59.0/async/specifications/oas3/NTByNEgwMDAwMDAwMDAx\"\n}"
}
]
}