PureBasic / Postman API / Single workspace
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"X-API-Key","{{postman_api_key}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.getpostman.com/workspaces/{{workspace_id}}",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "workspace": {
; "id": "f8801e9e-03a4-4c7b-b31e-5db5cd771696",
; "name": "Demo workspace",
; "type": "personal",
; "description": "Demos.",
; "collections": [
; {
; "id": "7c31b469-bd43-4411-9283-6d397855ee0e",
; "name": "Mock demo - collection",
; "uid": "1234-7c31b469-bd43-4411-9283-6d397855ee0e"
; },
; {
; "id": "356fe068-a0f8-4f31-b34d-d12149eac681",
; "name": "Mock demo - response code",
; "uid": "1234-356fe068-a0f8-4f31-b34d-d12149eac681"
; }
; ],
; "environments": [
; {
; "id": "423fd955-a9c8-47cd-9ab0-09a6a575c4be",
; "name": "Mock demo - CNX",
; "uid": "1234-423fd955-a9c8-47cd-9ab0-09a6a575c4be"
; },
; {
; "id": "24c45c84-5147-4c15-bb9a-c3186b81d3cc",
; "name": "Mock Demo - response code",
; "uid": "1234-24c45c84-5147-4c15-bb9a-c3186b81d3cc"
; }
; ],
; "mocks": [
; {
; "id": "77aaeba0-0f94-4aa4-a60d-200f4e1ef2fb"
; },
; {
; "id": "52a5d86f-73d4-4f86-baec-4b19983d6896"
; }
; ],
; "monitors": [
; {
; "id": "efa46ba3-90da-4a84-b924-2962266c3db1"
; },
; {
; "id": "24915c49-b33e-4da1-ac20-535f82e34626"
; }
; ]
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
name.s
uid.s
Id.s = CkJsonObject::ckStringOf(jResp,"workspace.id")
Name.s = CkJsonObject::ckStringOf(jResp,"workspace.name")
v_Type.s = CkJsonObject::ckStringOf(jResp,"workspace.type")
Description.s = CkJsonObject::ckStringOf(jResp,"workspace.description")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"workspace.collections")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"workspace.collections[i].id")
name = CkJsonObject::ckStringOf(jResp,"workspace.collections[i].name")
uid = CkJsonObject::ckStringOf(jResp,"workspace.collections[i].uid")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"workspace.environments")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"workspace.environments[i].id")
name = CkJsonObject::ckStringOf(jResp,"workspace.environments[i].name")
uid = CkJsonObject::ckStringOf(jResp,"workspace.environments[i].uid")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"workspace.mocks")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"workspace.mocks[i].id")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"workspace.monitors")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"workspace.monitors[i].id")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "X-API-Key: {{postman_api_key}}"
https://api.getpostman.com/workspaces/{{workspace_id}}
Postman Collection Item JSON
{
"name": "Single workspace",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/workspaces/{{workspace_id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"workspaces",
"{{workspace_id}}"
]
},
"description": "Access the contents of a workspace that is accessible to you using its id (`id`). Includes the collections, environments, mocks and monitors of that workspace.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Workspace Not Found",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/workspaces/{{workspace_id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"workspaces",
"{{workspace_id}}"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "The mime type of this content",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"error\": {\n \"name\": \"instanceNotFoundError\",\n \"message\": \"Instance not found in the database.\"\n }\n}"
},
{
"name": "Valid Response",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.getpostman.com/workspaces/{{workspace_id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"workspaces",
"{{workspace_id}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"workspace\": {\n \"id\": \"f8801e9e-03a4-4c7b-b31e-5db5cd771696\",\n \"name\": \"Demo workspace\",\n \"type\": \"personal\",\n \"description\": \"Demos.\",\n \"collections\": [\n {\n \"id\": \"7c31b469-bd43-4411-9283-6d397855ee0e\",\n \"name\": \"Mock demo - collection\",\n \"uid\": \"1234-7c31b469-bd43-4411-9283-6d397855ee0e\"\n },\n {\n \"id\": \"356fe068-a0f8-4f31-b34d-d12149eac681\",\n \"name\": \"Mock demo - response code\",\n \"uid\": \"1234-356fe068-a0f8-4f31-b34d-d12149eac681\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"423fd955-a9c8-47cd-9ab0-09a6a575c4be\",\n \"name\": \"Mock demo - CNX\",\n \"uid\": \"1234-423fd955-a9c8-47cd-9ab0-09a6a575c4be\"\n },\n {\n \"id\": \"24c45c84-5147-4c15-bb9a-c3186b81d3cc\",\n \"name\": \"Mock Demo - response code\",\n \"uid\": \"1234-24c45c84-5147-4c15-bb9a-c3186b81d3cc\"\n }\n ],\n \"mocks\": [\n { \n \"id\": \"77aaeba0-0f94-4aa4-a60d-200f4e1ef2fb\"\n },\n { \n \"id\": \"52a5d86f-73d4-4f86-baec-4b19983d6896\"\n }\n ],\n \"monitors\": [\n {\n \"id\": \"efa46ba3-90da-4a84-b924-2962266c3db1\"\n },\n {\n \"id\": \"24915c49-b33e-4da1-ac20-535f82e34626\"\n }\n ]\n }\n}"
}
]
}
