PowerBuilder / Postman API / Get linked relations
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_UpdatedAt
string ls_V_521b0486_ab91_4d3a_9189_43c9380a0533Id
string ls_V_521b0486_ab91_4d3a_9189_43c9380a0533Name
string ls_V_521b0486_ab91_4d3a_9189_43c9380a0533UpdatedAt
string ls_A236b715_e682_460b_97b6_c1db24f7612eId
string ls_A236b715_e682_460b_97b6_c1db24f7612eName
string ls_A236b715_e682_460b_97b6_c1db24f7612eUpdatedAt
string ls_V_4ccd755f_2c80_481b_a262_49b55e12f5e1Id
string ls_V_4ccd755f_2c80_481b_a262_49b55e12f5e1Name
string ls_V_Url
string ls_V_4ccd755f_2c80_481b_a262_49b55e12f5e1UpdatedAt
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.SetRequestHeader("X-API-Key","{{postman_api_key}}")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/relations",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
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
ls_Id = loo_JResp.StringOf("relations.contracttest.2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2.id")
ls_Name = loo_JResp.StringOf("relations.contracttest.2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2.name")
ls_UpdatedAt = loo_JResp.StringOf("relations.contracttest.2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2.updatedAt")
ls_V_521b0486_ab91_4d3a_9189_43c9380a0533Id = loo_JResp.StringOf("relations.integrationtest.521b0486-ab91-4d3a-9189-43c9380a0533.id")
ls_V_521b0486_ab91_4d3a_9189_43c9380a0533Name = loo_JResp.StringOf("relations.integrationtest.521b0486-ab91-4d3a-9189-43c9380a0533.name")
ls_V_521b0486_ab91_4d3a_9189_43c9380a0533UpdatedAt = loo_JResp.StringOf("relations.integrationtest.521b0486-ab91-4d3a-9189-43c9380a0533.updatedAt")
ls_A236b715_e682_460b_97b6_c1db24f7612eId = loo_JResp.StringOf("relations.integrationtest.a236b715-e682-460b-97b6-c1db24f7612e.id")
ls_A236b715_e682_460b_97b6_c1db24f7612eName = loo_JResp.StringOf("relations.integrationtest.a236b715-e682-460b-97b6-c1db24f7612e.name")
ls_A236b715_e682_460b_97b6_c1db24f7612eUpdatedAt = loo_JResp.StringOf("relations.integrationtest.a236b715-e682-460b-97b6-c1db24f7612e.updatedAt")
ls_V_4ccd755f_2c80_481b_a262_49b55e12f5e1Id = loo_JResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.id")
ls_V_4ccd755f_2c80_481b_a262_49b55e12f5e1Name = loo_JResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.name")
ls_V_Url = loo_JResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.url")
ls_V_4ccd755f_2c80_481b_a262_49b55e12f5e1UpdatedAt = loo_JResp.StringOf("relations.mock.4ccd755f-2c80-481b-a262-49b55e12f5e1.updatedAt")
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
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}"
}
]
}
