autoit / Postman API / Single Collection
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.SetRequestHeader "X-API-Key","{{postman_api_key}}"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.getpostman.com/collections/{{collection_uid}}",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "collection": {
; "variables": [
; ],
; "info": {
; "name": "Sample Collection",
; "_postman_id": "f2e66c2e-5297-e4a5-739e-20cbb90900e3",
; "description": "This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.",
; "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json"
; },
; "item": [
; {
; "id": "82ee981b-e19f-962a-401e-ea34ebfb4848",
; "name": "Request Headers",
; "event": [
; {
; "listen": "test",
; "script": {
; "type": "text/javascript",
; "exec": "var responseJSON;\ntry {\n tests[\"Body contains headers\"] = responseBody.has(\"headers\");\n responseJSON = JSON.parse(responseBody);\n tests[\"Header contains host\"] = \"host\" in responseJSON.headers;\n tests[\"Header contains test parameter sent as part of request header\"] = \"my-sample-header\" in responseJSON.headers;\n}\ncatch (e) { }\n\n\n\n"
; }
; }
; ],
; "request": {
; "url": "https://echo.getpostman.com/headers",
; "method": "GET",
; "header": [
; {
; "key": "my-sample-header",
; "value": "Lorem ipsum dolor sit amet",
; "description": ""
; }
; ],
; "body": {
; "mode": "formdata",
; "formdata": [
; ]
; },
; "description": ""
; },
; "response": [
; ]
; }
; ]
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sId
Local $sName
Local $sV_Url
Local $sMethod
Local $sMode
Local $sRequestDescription
Local $iJ
Local $iCount_j
Local $sListen
Local $sV_Type
Local $sExec
Local $sKey
Local $sValue
Local $sDescription
Local $sName = $oJResp.StringOf("collection.info.name")
Local $sV_postman_id = $oJResp.StringOf("collection.info._postman_id")
Local $sDescription = $oJResp.StringOf("collection.info.description")
Local $sSchema = $oJResp.StringOf("collection.info.schema")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("collection.variables")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("collection.item")
While $i < $iCount_i
$oJResp.I = $i
$sId = $oJResp.StringOf("collection.item[i].id")
$sName = $oJResp.StringOf("collection.item[i].name")
$sV_Url = $oJResp.StringOf("collection.item[i].request.url")
$sMethod = $oJResp.StringOf("collection.item[i].request.method")
$sMode = $oJResp.StringOf("collection.item[i].request.body.mode")
$sRequestDescription = $oJResp.StringOf("collection.item[i].request.description")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("collection.item[i].event")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sListen = $oJResp.StringOf("collection.item[i].event[j].listen")
$sV_Type = $oJResp.StringOf("collection.item[i].event[j].script.type")
$sExec = $oJResp.StringOf("collection.item[i].event[j].script.exec")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("collection.item[i].request.header")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sKey = $oJResp.StringOf("collection.item[i].request.header[j].key")
$sValue = $oJResp.StringOf("collection.item[i].request.header[j].value")
$sDescription = $oJResp.StringOf("collection.item[i].request.header[j].description")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("collection.item[i].request.body.formdata")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("collection.item[i].response")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/collections/{{collection_uid}}
Postman Collection Item JSON
{
"name": "Single Collection ",
"event": [
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
"pm.test(\"response is ok\", function () {",
" pm.response.to.have.status(200);",
"});",
"",
"pm.test(\"response json data should not have errors\", function () {",
" pm.response.to.have.jsonBody();",
" pm.response.to.not.have.jsonBody('error');",
"});",
"",
"pm.test(\"response json should contain one collection\", function () {",
" pm.expect(pm.response.json()).to.have.property('collection').and.be.an('object');",
"});",
"",
"// additional tests to ensure that the relevant environment variables are present",
"pm.test('\"postman_api_key\" variable should be present', function () {",
" pm.expect(pm.variables.get('postman_api_key')).to.be.a('string');",
"});",
"",
"// you can unskip this test in case you want to have a stricter check on the selected",
"// environment.",
"pm.test.skip('\"collection_uid\" variable should be present', function () {",
" pm.expect(pm.variables.get('collection_uid')).to.be.a('string');",
"});"
]
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/collections/{{collection_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"collections",
"{{collection_uid}}"
]
},
"description": "Access the contents of a collection that is accessible to you using its unique id (`uid`).\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Valid Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/collections/{{collection_uid}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"collections",
"{{collection_uid}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"collection\": {\n \"variables\": [],\n \"info\": {\n \"name\": \"Sample Collection\",\n \"_postman_id\": \"f2e66c2e-5297-e4a5-739e-20cbb90900e3\",\n \"description\": \"This is a sample collection that makes a tiny request to Postman Echo service to get the list of request headers sent by a HTTP client.\",\n \"schema\": \"https://schema.getpostman.com/json/collection/v2.0.0/collection.json\"\n },\n \"item\": [\n {\n \"id\": \"82ee981b-e19f-962a-401e-ea34ebfb4848\",\n \"name\": \"Request Headers\",\n \"event\": [\n {\n \"listen\": \"test\",\n \"script\": {\n \"type\": \"text/javascript\",\n \"exec\": \"var responseJSON;\\ntry {\\n tests[\\\"Body contains headers\\\"] = responseBody.has(\\\"headers\\\");\\n responseJSON = JSON.parse(responseBody);\\n tests[\\\"Header contains host\\\"] = \\\"host\\\" in responseJSON.headers;\\n tests[\\\"Header contains test parameter sent as part of request header\\\"] = \\\"my-sample-header\\\" in responseJSON.headers;\\n}\\ncatch (e) { }\\n\\n\\n\\n\"\n }\n }\n ],\n \"request\": {\n \"url\": \"https://echo.getpostman.com/headers\",\n \"method\": \"GET\",\n \"header\": [\n {\n \"key\": \"my-sample-header\",\n \"value\": \"Lorem ipsum dolor sit amet\",\n \"description\": \"\"\n }\n ],\n \"body\": {\n \"mode\": \"formdata\",\n \"formdata\": []\n },\n \"description\": \"\"\n },\n \"response\": []\n }\n ]\n }\n}"
}
]
}
