VBScript / Postman API / Get linked relations
Back to Collection Items
Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)
' 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 = CreateObject("Chilkat.Http")
http.SetRequestHeader "X-API-Key","{{postman_api_key}}"
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.StringBuilder")
set sbResponseBody = CreateObject("Chilkat.StringBuilder")
success = http.QuickGetSb("https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations",sbResponseBody)
If (success = 0) Then
outFile.WriteLine(http.LastErrorText)
WScript.Quit
End If
' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.JsonObject")
set jResp = CreateObject("Chilkat.JsonObject")
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
outFile.WriteLine("Response Body:")
outFile.WriteLine(jResp.Emit())
respStatusCode = http.LastStatus
outFile.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
outFile.WriteLine("Response Header:")
outFile.WriteLine(http.LastHeader)
outFile.WriteLine("Failed.")
WScript.Quit
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "relations": {
' "contracttest": {
' "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2": {
' "id": "2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2",
' "name": "C test",
' "updatedAt": "2019-08-29T10:18:11.000Z"
' }
' },
' "integrationtest": {
' "521b0486-ab91-4d3a-9189-43c9380a0533": {
' "id": "521b0486-ab91-4d3a-9189-43c9380a0533",
' "name": "C1",
' "updatedAt": "2019-08-29T11:40:39.000Z"
' },
' "a236b715-e682-460b-97b6-c1db24f7612e": {
' "id": "a236b715-e682-460b-97b6-c1db24f7612e",
' "name": "C test",
' "updatedAt": "2019-08-29T10:18:11.000Z"
' }
' },
' "mock": {
' "4ccd755f-2c80-481b-a262-49b55e12f5e1": {
' "id": "4ccd755f-2c80-481b-a262-49b55e12f5e1",
' "name": "Mock",
' "url": "https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io",
' "updatedAt": "2019-08-20T10:18:13.000Z"
' }
' }
' }
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Id = jResp.StringOf("relations.contracttest.2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2.id")
Name = jResp.StringOf("relations.contracttest.2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2.name")
UpdatedAt = jResp.StringOf("relations.contracttest.2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2.updatedAt")
v_521b0486_ab91_4d3a_9189_43c9380a0533Id = jResp.StringOf("relations.integrationtest.521b0486-ab91-4d3a-9189-43c9380a0533.id")
v_521b0486_ab91_4d3a_9189_43c9380a0533Name = jResp.StringOf("relations.integrationtest.521b0486-ab91-4d3a-9189-43c9380a0533.name")
v_521b0486_ab91_4d3a_9189_43c9380a0533UpdatedAt = jResp.StringOf("relations.integrationtest.521b0486-ab91-4d3a-9189-43c9380a0533.updatedAt")
A236b715_e682_460b_97b6_c1db24f7612eId = jResp.StringOf("relations.integrationtest.a236b715-e682-460b-97b6-c1db24f7612e.id")
A236b715_e682_460b_97b6_c1db24f7612eName = jResp.StringOf("relations.integrationtest.a236b715-e682-460b-97b6-c1db24f7612e.name")
A236b715_e682_460b_97b6_c1db24f7612eUpdatedAt = jResp.StringOf("relations.integrationtest.a236b715-e682-460b-97b6-c1db24f7612e.updatedAt")
v_4ccd755f_2c80_481b_a262_49b55e12f5e1Id = jResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.id")
v_4ccd755f_2c80_481b_a262_49b55e12f5e1Name = jResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.name")
v_Url = jResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.url")
v_4ccd755f_2c80_481b_a262_49b55e12f5e1UpdatedAt = jResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.updatedAt")
outFile.Close
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations
Postman Collection Item JSON
{
"name": "Get linked relations",
"request": {
"method": "GET",
"header": [
],
"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 fetches all the relations which are linked to the specified API version along with their details.\n\nThe response will contain a `relations` object which lists all the relation types which are linked to the API version. Each of the relation type will be an object which details the relations of this type. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Get linked relations for an API version",
"originalRequest": {
"method": "GET",
"header": [
],
"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",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n\t\"relations\": {\n\t\t\"contracttest\": {\n \"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2\": {\n \"id\": \"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2\",\n \"name\": \"C test\",\n \"updatedAt\": \"2019-08-29T10:18:11.000Z\"\n }\n },\n \"integrationtest\": {\n \"521b0486-ab91-4d3a-9189-43c9380a0533\": {\n \"id\": \"521b0486-ab91-4d3a-9189-43c9380a0533\",\n \"name\": \"C1\",\n \"updatedAt\": \"2019-08-29T11:40:39.000Z\"\n },\n \"a236b715-e682-460b-97b6-c1db24f7612e\": {\n \"id\": \"a236b715-e682-460b-97b6-c1db24f7612e\",\n \"name\": \"C test\",\n \"updatedAt\": \"2019-08-29T10:18:11.000Z\"\n }\n },\n \"mock\": {\n \"4ccd755f-2c80-481b-a262-49b55e12f5e1\": {\n \"id\": \"4ccd755f-2c80-481b-a262-49b55e12f5e1\",\n \"name\": \"Mock\",\n \"url\": \"https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io\",\n \"updatedAt\": \"2019-08-20T10:18:13.000Z\"\n }\n }\n\t}\n}"
}
]
}
