Android / Postman API / Create relations
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
// 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"
// ]
// }
CkJsonObject json = new CkJsonObject();
json.UpdateString("contracttest[0]","collection-uid-1");
json.UpdateString("testsuite[0]","collection-uid-1");
json.UpdateString("testsuite[1]","collection-uid-2");
json.UpdateString("documentation[0]","collection-uid-3");
json.UpdateString("mock[0]","mock-uid-1");
http.SetRequestHeader("Content-Type","application/json");
http.SetRequestHeader("X-API-Key","{{postman_api_key}}");
CkHttpResponse resp = http.PostJson3("https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations","application/json",json);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// 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
String strVal;
int i = 0;
int count_i = jResp.SizeOfArray("contracttest");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("contracttest[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("testsuite");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("testsuite[i]");
i = i + 1;
}
i = 0;
count_i = jResp.SizeOfArray("documentation");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("documentation[i]");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
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}"
}
]
}
