unicodeC / Postman API / Create Environment
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *Id;
const wchar_t *Name;
const wchar_t *Uid;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "environment": {
// "name": "Sample Environment Name (required)",
// "values": [
// {
// "key": "variable_name_1",
// "value": "The value of the variable"
// },
// {
// "key": "variable_name_2",
// "value": ""
// }
// ]
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"environment.name",L"Sample Environment Name (required)");
CkJsonObjectW_UpdateString(json,L"environment.values[0].key",L"variable_name_1");
CkJsonObjectW_UpdateString(json,L"environment.values[0].value",L"The value of the variable");
CkJsonObjectW_UpdateString(json,L"environment.values[1].key",L"variable_name_2");
CkJsonObjectW_UpdateString(json,L"environment.values[1].value",L"");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"X-API-Key",L"{{postman_api_key}}");
resp = CkHttpW_PostJson3(http,L"https://api.getpostman.com/environments",L"application/json",json);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "environment": {
// "id": "f158266e-306b-4702-a2b9-e4ede7878b7a",
// "name": "Sample Environment Name (required)",
// "uid": "5665-f158266e-306b-4702-a2b9-e4ede7878b7a"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Id = CkJsonObjectW_stringOf(jResp,L"environment.id");
Name = CkJsonObjectW_stringOf(jResp,L"environment.name");
Uid = CkJsonObjectW_stringOf(jResp,L"environment.uid");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X POST
-H "X-API-Key: {{postman_api_key}}"
-H "Content-Type: application/json"
-d '{
"environment": {
"name": "Sample Environment Name (required)",
"values": [
{
"key": "variable_name_1",
"value": "The value of the variable"
},
{
"key": "variable_name_2",
"value": ""
}
]
}
}'
https://api.getpostman.com/environments
Postman Collection Item JSON
{
"name": "Create Environment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"environment\": {\n \"name\": \"Sample Environment Name (required)\",\n \"values\": [\n {\n \"key\": \"variable_name_1\",\n \"value\": \"The value of the variable\"\n },\n {\n \"key\": \"variable_name_2\",\n \"value\": \"\"\n }\n ]\n }\n}"
},
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
},
"description": "A sample body is added to the request that conforms to the following JSON schema:\n\n```json\n{\n \"type\": \"object\",\n \"properties\": {\n \"environment\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 254,\n \"minLength\": 1\n },\n \"values\": {\n \"type\": \"array\",\n \"maxItems\": 100,\n \"additionalItems\": false,\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"key\": {\n \"type\": \"string\",\n \"maxLength\": 254\n \"minLength\": 1\n },\n \"value\": { \"type\": \"string\" },\n \"enabled\": { \"type\": \"boolean\" }\n },\n \"required\": [\"key\", \"value\"]\n }\n }\n },\n \"required\": [\"name\"]\n }\n },\n \"required\": [\"environment\"]\n}\n```\n\nOn successful creation of the environment, the API returns the environment name and `id`.\n\nYou can also specify the context of a workspace to create an environment in directly by passing the `workspace` as a query param.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter."
},
"response": [
{
"name": "Create Environment in a Workspace",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"environment\": {\n \"name\": \"Sample Environment Name (required)\",\n \"values\": [\n {\n \"key\": \"variable_name_1\",\n \"value\": \"The value of the variable\"\n },\n {\n \"key\": \"variable_name_2\",\n \"value\": \"\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/environments?workspace={{workspace_id}}",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
],
"query": [
{
"key": "workspace",
"value": "{{workspace_id}}",
"description": "The workspace ID in which the environment will be created"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"environment\": {\n \"id\": \"f158266e-306b-4702-a2b9-e4ede7878b7a\",\n \"name\": \"Sample Environment Name (required)\",\n \"uid\": \"5665-f158266e-306b-4702-a2b9-e4ede7878b7a\"\n }\n}"
},
{
"name": "Successful Response",
"originalRequest": {
"method": "POST",
"header": [
{
"name": "Content-Type",
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"environment\": {\n \"name\": \"Sample Environment Name (required)\",\n \"values\": [\n {\"key\": \"variable_name_1\", \"value\": \"The value of the variable\"},\n {\"key\": \"variable_name_2\", \"value\": \"\"}\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"name": "Content-Type",
"description": {
"content": "",
"type": "text/plain"
}
}
],
"cookie": [
],
"body": "{\n \"environment\": {\n \"id\": \"f158266e-306b-4702-a2b9-e4ede7878b7a\",\n \"name\": \"Sample Environment Name (required)\",\n \"uid\": \"5665-f158266e-306b-4702-a2b9-e4ede7878b7a\"\n }\n}"
},
{
"name": "Failure Response",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \n}"
},
"url": {
"raw": "https://api.getpostman.com/environments",
"protocol": "https",
"host": [
"api",
"getpostman",
"com"
],
"path": [
"environments"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
}
],
"cookie": [
],
"body": "{\n \"error\": {\n \"name\": \"malformedRequestError\",\n \"message\": \"Found 1 errors with the supplied environment.\",\n \"details\": [\n \": must have required property 'environment'\"\n ]\n }\n}"
}
]
}
