Chilkat Online Tools

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

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.SetRequestHeader("X-ANYPNT-ENV-ID","{{environment_id}}");
// Adds the "Authorization: Bearer {{token}}" header.
http.AuthToken = "{{token}}";
http.SetRequestHeader("X-ANYPNT-ORG-ID","{{organization_id}}");

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/organizations/{{organization_id}}/environments",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

// 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

string id;

int i = 0;
int count_i = jResp.SizeOfArray("resources");
while (i < count_i) {
    jResp.I = i;
    id = jResp.StringOf("resources[i].id");
    i = i + 1;
}

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": ""
    }
  ]
}