Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
json: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
href: WideString;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
// 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
// ]
// }
json := TChilkatJsonObject.Create(Self);
ERROR: Undefined variable(YOUR_SOBJECT_SELECTORS)
json.UpdateInt('resources[0]',YOUR_SOBJECT_SELECTORSERROR: Undefined variable(YOUR_SOBJECT_SELECTORS)
);
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken := '<access_token>';
resp := http.PostJson3('https://domain.com/services/data/v{{version}}/async/specifications/oas3','application/json',json.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
href := jResp.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}"
}
]
}