Ruby / Postman API / Single workspace
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.SetRequestHeader("X-API-Key","{{postman_api_key}}")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.getpostman.com/workspaces/{{workspace_id}}",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# 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 = jResp.stringOf("workspace.id")
Name = jResp.stringOf("workspace.name")
v_Type = jResp.stringOf("workspace.type")
Description = jResp.stringOf("workspace.description")
i = 0
count_i = jResp.SizeOfArray("workspace.collections")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("workspace.collections[i].id")
name = jResp.stringOf("workspace.collections[i].name")
uid = jResp.stringOf("workspace.collections[i].uid")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("workspace.environments")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("workspace.environments[i].id")
name = jResp.stringOf("workspace.environments[i].name")
uid = jResp.stringOf("workspace.environments[i].uid")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("workspace.mocks")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("workspace.mocks[i].id")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("workspace.monitors")
while i < count_i
jResp.put_I(i)
id = jResp.stringOf("workspace.monitors[i].id")
i = i + 1
end
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}"
}
]
}
