delphiDll / Postman API / Create relations
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: 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();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "contracttest": [
// "collection-uid-1"
// ],
// "testsuite": [
// "collection-uid-1",
// "collection-uid-2"
// ],
// "documentation": [
// "collection-uid-3"
// ],
// "mock": [
// "mock-uid-1"
// ]
// }
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'contracttest[0]','collection-uid-1');
CkJsonObject_UpdateString(json,'testsuite[0]','collection-uid-1');
CkJsonObject_UpdateString(json,'testsuite[1]','collection-uid-2');
CkJsonObject_UpdateString(json,'documentation[0]','collection-uid-3');
CkJsonObject_UpdateString(json,'mock[0]','mock-uid-1');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
CkHttp_SetRequestHeader(http,'X-API-Key','{{postman_api_key}}');
resp := CkHttp_PostJson3(http,'https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "contracttest": [
// "5bcece87-ca4b-4e75-a967-2a6845626164"
// ],
// "testsuite": [
// "e525fa71-035e-4620-acda-ce878524f1e7",
// "17a974b2-ce79-4b95-9d3f-217d6ff7e979"
// ],
// "documentation": [
// "2084eba6-a17b-4751-8f03-ea60f30ba19c"
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'contracttest');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'contracttest[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'testsuite');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'testsuite[i]');
i := i + 1;
end;
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'documentation');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
strVal := CkJsonObject__stringOf(jResp,'documentation[i]');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"contracttest": ["collection-uid-1"],
"testsuite": ["collection-uid-1", "collection-uid-2"],
"documentation": ["collection-uid-3"],
"mock": ["mock-uid-1"]
}'
https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations
Postman Collection Item JSON
{
"name": "Create relations",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"contracttest\": [\"collection-uid-1\"],\n\t\"testsuite\": [\"collection-uid-1\", \"collection-uid-2\"],\n\t\"documentation\": [\"collection-uid-3\"],\n\t\"mock\": [\"mock-uid-1\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions",
"{{apiVersionId}}",
"relations"
]
},
"description": "This call allows you to add existing Postman entities as new relations to an API. The request body should contain the relations to be created along with an array of entity IDs. \n\n<table>\n <tr>\n <th>Relation</th>\n <th>Entity ID type</th>\n <tr>\n <tr>\n <td>contracttest</td>\n <td>Collection UIDs</td>\n </tr>\n <tr>\n <td>integrationtest</td>\n <td>Collection UIDs</td>\n </tr>\n <tr>\n <td>documentation</td>\n <td>Collection UIDs</td>\n </tr>\n <tr>\n <td>testsuite</td>\n <td>Collection UIDs</td>\n </tr>\n <tr>\n <td>environment</td>\n <td>Environment UIDs</td>\n </tr>\n <tr>\n <td>mock</td>\n <td>Mock IDs</td>\n </tr>\n <tr>\n <td>monitor</td>\n <td>Monitor IDs</td>\n </tr>\n</table>\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Create multiple relations from existing collections",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\t\"contracttest\": [\"112098-a173931c-3340-4c14-b30f-ae62e5fbeb52\"],\n\t\"testsuite\": [\"112098-a173931c-3340-4c14-b30f-ae62e5fbeb52\", \"112098-47958a5a-a2a5-4330-9c9d-60c5166115f2\"],\n\t\"documentation\": [\"112098-47958a5a-a2a5-4330-9c9d-60c5166115f2\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"apis",
"{{apiId}}",
"versions",
"{{apiVersionId}}",
"relations"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"contracttest\": [\n \"5bcece87-ca4b-4e75-a967-2a6845626164\"\n ],\n \"testsuite\": [\n \"e525fa71-035e-4620-acda-ce878524f1e7\",\n \"17a974b2-ce79-4b95-9d3f-217d6ff7e979\"\n ],\n \"documentation\": [\n \"2084eba6-a17b-4751-8f03-ea60f30ba19c\"\n ]\n}"
}
]
}
