TCL / Postman API / Create Workspace
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "workspace": {
# "name": "New Workspace",
# "type": "personal",
# "description": "Some description",
# "collections": [
# {
# "id": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d",
# "name": "Straw hats",
# "uid": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d"
# }
# ],
# "environments": [
# {
# "id": "83a1aaa2-a204-4bd8-9b92-4d486918906b",
# "name": "env",
# "uid": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b"
# }
# ],
# "mocks": [
# {
# "id": "cda672ef-1375-40e9-baee-e20ece8d7b65"
# }
# ],
# "monitors": [
# {
# "id": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec"
# }
# ]
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "workspace.name" "New Workspace"
CkJsonObject_UpdateString $json "workspace.type" "personal"
CkJsonObject_UpdateString $json "workspace.description" "Some description"
CkJsonObject_UpdateString $json "workspace.collections[0].id" "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d"
CkJsonObject_UpdateString $json "workspace.collections[0].name" "Straw hats"
CkJsonObject_UpdateString $json "workspace.collections[0].uid" "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d"
CkJsonObject_UpdateString $json "workspace.environments[0].id" "83a1aaa2-a204-4bd8-9b92-4d486918906b"
CkJsonObject_UpdateString $json "workspace.environments[0].name" "env"
CkJsonObject_UpdateString $json "workspace.environments[0].uid" "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b"
CkJsonObject_UpdateString $json "workspace.mocks[0].id" "cda672ef-1375-40e9-baee-e20ece8d7b65"
CkJsonObject_UpdateString $json "workspace.monitors[0].id" "1e889bd2-3862-4be0-b2c2-9b1fe9673aec"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "X-API-Key" "{{postman_api_key}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.getpostman.com/workspaces" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "workspace": {
# "id": "cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f",
# "name": "New Workspace"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Id [CkJsonObject_stringOf $jResp "workspace.id"]
set Name [CkJsonObject_stringOf $jResp "workspace.name"]
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"workspace": {
"name": "New Workspace",
"type": "personal",
"description": "Some description",
"collections": [
{
"id": "e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d",
"name": "Straw hats",
"uid": "8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d"
}
],
"environments": [
{
"id": "83a1aaa2-a204-4bd8-9b92-4d486918906b",
"name": "env",
"uid": "8154-83a1aaa2-a204-4bd8-9b92-4d486918906b"
}
],
"mocks": [
{
"id": "cda672ef-1375-40e9-baee-e20ece8d7b65"
}
],
"monitors": [
{
"id": "1e889bd2-3862-4be0-b2c2-9b1fe9673aec"
}
]
}
}'
https://api.getpostman.com/workspaces
Postman Collection Item JSON
{
"name": "Create Workspace",
"request": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"workspace\": {\n \"name\": \"New Workspace\",\n \"type\": \"personal\",\n \"description\": \"Some description\",\n \"collections\": [\n {\n \"id\": \"e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d\",\n \"name\": \"Straw hats\",\n \"uid\": \"8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"83a1aaa2-a204-4bd8-9b92-4d486918906b\",\n \"name\": \"env\",\n \"uid\": \"8154-83a1aaa2-a204-4bd8-9b92-4d486918906b\"\n }\n ],\n \"mocks\": [\n {\n \"id\": \"cda672ef-1375-40e9-baee-e20ece8d7b65\"\n }\n ],\n \"monitors\": [\n {\n \"id\": \"1e889bd2-3862-4be0-b2c2-9b1fe9673aec\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.getpostman.com/workspaces",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"workspaces"
]
},
"description": "This endpoint allows you to create a workspace and populate it with entities like `collections`, `environments`, `mocks` and `monitors` using their `uid`.\n\nOn successful creation of the workspace, the response returns the workspcae `name` and `id`.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Successful Response",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"workspace\": {\n \"name\": \"New Workspace\",\n \"type\": \"personal\",\n \"description\": \"Some description\",\n \"collections\": [\n {\n \"id\": \"e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d\",\n \"name\": \"Straw hats\",\n \"uid\": \"8154-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"83a1aaa2-a204-4bd8-9b92-4d486918906b\",\n \"name\": \"env\",\n \"uid\": \"8154-83a1aaa2-a204-4bd8-9b92-4d486918906b\"\n }\n ],\n \"mocks\": [\n {\n \"id\": \"cda672ef-1375-40e9-baee-e20ece8d7b65\"\n }\n ],\n \"monitors\": [\n {\n \"id\": \"1e889bd2-3862-4be0-b2c2-9b1fe9673aec\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.getpostman.com/workspaces",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"workspaces"
]
}
},
"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\": \"cfbcd9bf-cc8b-4d6f-b8ef-440a3e49e29f\",\n \"name\": \"New Workspace\"\n }\n}"
},
{
"name": "Instance supplied not found",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"workspace\": {\n \"name\": \"New Workspace\",\n \"type\": \"personal\",\n \"description\": \"Some description\",\n \"collections\": [\n {\n \"id\": \"e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d\",\n \"name\": \"Straw hats\",\n \"uid\": \"8153-e1fc3c38-a0b8-44a3-bd44-d753a96b2e9d\"\n }\n ],\n \"environments\": [\n {\n \"id\": \"83a1aaa2-a204-4bd8-9b92-4d486918906b\",\n \"name\": \"env\",\n \"uid\": \"8153-83a1aaa2-a204-4bd8-9b92-4d486918906b\"\n }\n ],\n \"mocks\": [\n {\n \"id\": \"dda672ef-1375-40e9-baee-e20ece8d7b65\"\n }\n ],\n \"monitors\": [\n {\n \"id\": \"2e889bd2-3862-4be0-b2c2-9b1fe9673aec\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.getpostman.com/workspaces",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"workspaces"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"error\": {\n \"name\": \"instanceNotFoundError\",\n \"message\": \"Instance not found in the database.\"\n }\n}"
}
]
}
