delphiDll / Postman API / Get an API Version
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
Id: PWideChar;
Name: PWideChar;
Api: PWideChar;
CreatedBy: PWideChar;
UpdatedBy: PWideChar;
CreatedAt: PWideChar;
UpdatedAt: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
CkHttp_SetRequestHeader(http,'X-API-Key','{{postman_api_key}}');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
Exit;
end;
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "version": {
// "id": "03c17f53-7e2e-427d-b55a-006b244f29ff",
// "name": "0.1",
// "api": "06e41ca3-8bea-4bc5-a726-70338b9f1940",
// "schema": [
// "3484cd1e-e00d-4c39-aea4-539663afe898"
// ],
// "createdBy": "5665",
// "updatedBy": "5665",
// "createdAt": "2019-07-21T16:31:15.000Z",
// "updatedAt": "2019-07-21T16:31:15.000Z"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id := CkJsonObject__stringOf(jResp,'version.id');
Name := CkJsonObject__stringOf(jResp,'version.name');
Api := CkJsonObject__stringOf(jResp,'version.api');
CreatedBy := CkJsonObject__stringOf(jResp,'version.createdBy');
UpdatedBy := CkJsonObject__stringOf(jResp,'version.updatedBy');
CreatedAt := CkJsonObject__stringOf(jResp,'version.createdAt');
UpdatedAt := CkJsonObject__stringOf(jResp,'version.updatedAt');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'version.schema');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'version.schema[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}
Postman Collection Item JSON
{
"name": "Get an API Version",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions",
"{{apiVersionId}}"
]
},
"description": "This call fetches details about the specified API Version.\n\nThe response will contain a `version` object which would contain all the details of the API Version.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Get an API version",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{versionId}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions",
"{{versionId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n\t\"version\": {\n\t\t\"id\": \"03c17f53-7e2e-427d-b55a-006b244f29ff\",\n\t \"name\": \"0.1\",\n\t \"api\": \"06e41ca3-8bea-4bc5-a726-70338b9f1940\",\n\t \"schema\": [\n\t \"3484cd1e-e00d-4c39-aea4-539663afe898\"\n\t ],\n\t \"createdBy\": \"5665\",\n\t \"updatedBy\": \"5665\",\n\t \"createdAt\": \"2019-07-21T16:31:15.000Z\",\n\t \"updatedAt\": \"2019-07-21T16:31:15.000Z\"\n\t}\n}"
}
]
}