Chilkat Online Tools

TCL / Anypoint Platform APIs / /organizations/:organization/environments

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]

CkHttp_SetRequestHeader $http "X-ANYPNT-ENV-ID" "{{environment_id}}"
# Adds the "Authorization: Bearer {{token}}" header.
CkHttp_put_AuthToken $http "{{token}}"
CkHttp_SetRequestHeader $http "X-ANYPNT-ORG-ID" "{{organization_id}}"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/organizations/{{organization_id}}/environments" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttp_lastHeader $http]
    puts "Failed."
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "resources": [
#     {
#       "id": "proident aute"
#     },
#     {
#       "id": "in nisi adipisicing enim"
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "resources"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set id [CkJsonObject_stringOf $jResp "resources[i].id"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X GET
	-H "Authorization: Bearer {{token}}"
	-H "X-ANYPNT-ORG-ID: {{organization_id}}"
	-H "X-ANYPNT-ENV-ID: {{environment_id}}"
https://domain.com/organizations/{{organization_id}}/environments

Postman Collection Item JSON

{
  "name": "/organizations/:organization/environments",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "X-ANYPNT-ORG-ID",
        "value": "{{organization_id}}",
        "type": "text"
      },
      {
        "key": "X-ANYPNT-ENV-ID",
        "value": "{{environment_id}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{url}}/organizations/{{organization_id}}/environments",
      "host": [
        "{{url}}"
      ],
      "path": [
        "organizations",
        "{{organization_id}}",
        "environments"
      ]
    },
    "description": "Returns a list of environment identifiers for the environments that have archived data.  If this path contains no\ndata, then an empty list is returned.\n"
  },
  "response": [
    {
      "name": "Untitled Example",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/organizations/:organization/environments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "organizations",
            ":organization",
            "environments"
          ],
          "variable": [
            {
              "key": "organization"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"resources\": [\n  {\n   \"id\": \"proident aute\"\n  },\n  {\n   \"id\": \"in nisi adipisicing enim\"\n  }\n ]\n}"
    },
    {
      "name": "The client is sending more than the allowed number of requests per unit time",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/organizations/:organization/environments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "organizations",
            ":organization",
            "environments"
          ],
          "variable": [
            {
              "key": "organization"
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "The API service is temporarily unreachable.  Please try again later.  Contact support if problem persists.",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/organizations/:organization/environments",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "organizations",
            ":organization",
            "environments"
          ],
          "variable": [
            {
              "key": "organization"
            }
          ]
        }
      },
      "status": "Gateway Timeout",
      "code": 504,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}