Classic ASP / Postman API / Create relations
Back to Collection Items
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<%
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Http")
set http = Server.CreateObject("Chilkat.Http")
' 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"
' ]
' }
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set json = Server.CreateObject("Chilkat.JsonObject")
success = json.UpdateString("contracttest[0]","collection-uid-1")
success = json.UpdateString("testsuite[0]","collection-uid-1")
success = json.UpdateString("testsuite[1]","collection-uid-2")
success = json.UpdateString("documentation[0]","collection-uid-3")
success = json.UpdateString("mock[0]","mock-uid-1")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "X-API-Key","{{postman_api_key}}"
' resp is a Chilkat.HttpResponse
Set resp = http.PostJson3("https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations","application/json",json)
If (http.LastMethodSuccess = 0) Then
Response.Write "<pre>" & Server.HTMLEncode( http.LastErrorText) & "</pre>"
Response.End
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = Server.CreateObject("Chilkat.StringBuilder")
success = resp.GetBodySb(sbResponseBody)
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = Server.CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Response.Write "<pre>" & Server.HTMLEncode( "Response Body:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( jResp.Emit()) & "</pre>"
respStatusCode = resp.StatusCode
Response.Write "<pre>" & Server.HTMLEncode( "Response Status Code = " & respStatusCode) & "</pre>"
If (respStatusCode >= 400) Then
Response.Write "<pre>" & Server.HTMLEncode( "Response Header:") & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( resp.Header) & "</pre>"
Response.Write "<pre>" & Server.HTMLEncode( "Failed.") & "</pre>"
Response.End
End If
' 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 = jResp.SizeOfArray("contracttest")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("contracttest[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("testsuite")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("testsuite[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("documentation")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("documentation[i]")
i = i + 1
Loop
%>
</body>
</html>
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}"
}
]
}
