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 *strVal;
const wchar_t *id;
const wchar_t *v_type;
const wchar_t *Handle;
const wchar_t *Name;
const wchar_t *Avatar;
const wchar_t *Banner;
const wchar_t *Created_at;
const wchar_t *Description;
const wchar_t *Link_count;
const wchar_t *Modified_at;
const wchar_t *Summary;
const wchar_t *User_count;
const wchar_t *Id;
const wchar_t *v_Type;
const wchar_t *Related;
const wchar_t *DataId;
const wchar_t *DataType;
const wchar_t *LinksRelated;
int i;
int count_i;
// 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.
// {
// "data": {
// "attributes": {
// "handle": "<string>",
// "name": "<string>",
// "avatar": "<string>",
// "banner": "<long>",
// "description": "<string>",
// "hidden_modules": [
// "<string>",
// "<string>"
// ],
// "visible_modules": [
// "<string>",
// "<string>"
// ]
// },
// "type": "team",
// "relationships": {
// "users": {
// "data": [
// {
// "id": "<string>",
// "type": "users"
// },
// {
// "id": "<string>",
// "type": "users"
// }
// ]
// }
// }
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"data.attributes.handle",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.name",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.avatar",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.banner",L"<long>");
CkJsonObjectW_UpdateString(json,L"data.attributes.description",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.hidden_modules[0]",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.hidden_modules[1]",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.visible_modules[0]",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.attributes.visible_modules[1]",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.type",L"team");
CkJsonObjectW_UpdateString(json,L"data.relationships.users.data[0].id",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.relationships.users.data[0].type",L"users");
CkJsonObjectW_UpdateString(json,L"data.relationships.users.data[1].id",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.relationships.users.data[1].type",L"users");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_PostJson3(http,L"https://api.app.ddog-gov.com/api/v2/team",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)
// {
// "data": {
// "attributes": {
// "handle": "<string>",
// "name": "<string>",
// "avatar": "<string>",
// "banner": "<long>",
// "created_at": "<dateTime>",
// "description": "<string>",
// "hidden_modules": [
// "<string>",
// "<string>"
// ],
// "link_count": "<integer>",
// "modified_at": "<dateTime>",
// "summary": "<string>",
// "user_count": "<integer>",
// "visible_modules": [
// "<string>",
// "<string>"
// ]
// },
// "id": "<string>",
// "type": "team",
// "relationships": {
// "team_links": {
// "data": [
// {
// "id": "<string>",
// "type": "team_links"
// },
// {
// "id": "<string>",
// "type": "team_links"
// }
// ],
// "links": {
// "related": "<string>"
// }
// },
// "user_team_permissions": {
// "data": {
// "id": "<string>",
// "type": "user_team_permissions"
// },
// "links": {
// "related": "<string>"
// }
// }
// }
// }
// }
// 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.
Handle = CkJsonObjectW_stringOf(jResp,L"data.attributes.handle");
Name = CkJsonObjectW_stringOf(jResp,L"data.attributes.name");
Avatar = CkJsonObjectW_stringOf(jResp,L"data.attributes.avatar");
Banner = CkJsonObjectW_stringOf(jResp,L"data.attributes.banner");
Created_at = CkJsonObjectW_stringOf(jResp,L"data.attributes.created_at");
Description = CkJsonObjectW_stringOf(jResp,L"data.attributes.description");
Link_count = CkJsonObjectW_stringOf(jResp,L"data.attributes.link_count");
Modified_at = CkJsonObjectW_stringOf(jResp,L"data.attributes.modified_at");
Summary = CkJsonObjectW_stringOf(jResp,L"data.attributes.summary");
User_count = CkJsonObjectW_stringOf(jResp,L"data.attributes.user_count");
Id = CkJsonObjectW_stringOf(jResp,L"data.id");
v_Type = CkJsonObjectW_stringOf(jResp,L"data.type");
Related = CkJsonObjectW_stringOf(jResp,L"data.relationships.team_links.links.related");
DataId = CkJsonObjectW_stringOf(jResp,L"data.relationships.user_team_permissions.data.id");
DataType = CkJsonObjectW_stringOf(jResp,L"data.relationships.user_team_permissions.data.type");
LinksRelated = CkJsonObjectW_stringOf(jResp,L"data.relationships.user_team_permissions.links.related");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.attributes.hidden_modules");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"data.attributes.hidden_modules[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.attributes.visible_modules");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"data.attributes.visible_modules[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data.relationships.team_links.data");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
id = CkJsonObjectW_stringOf(jResp,L"data.relationships.team_links.data[i].id");
v_type = CkJsonObjectW_stringOf(jResp,L"data.relationships.team_links.data[i].type");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"handle": "<string>",
"name": "<string>",
"avatar": "<string>",
"banner": "<long>",
"description": "<string>",
"hidden_modules": [
"<string>",
"<string>"
],
"visible_modules": [
"<string>",
"<string>"
]
},
"type": "team",
"relationships": {
"users": {
"data": [
{
"id": "<string>",
"type": "users"
},
{
"id": "<string>",
"type": "users"
}
]
}
}
}
}'
https://api.app.ddog-gov.com/api/v2/team
Postman Collection Item JSON
{
"name": "Create a team",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
},
"description": "Create a new team.\nUser IDs passed through the `users` relationship field are added to the team."
},
"response": [
{
"name": "CREATED",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"link_count\": \"<integer>\",\n \"modified_at\": \"<dateTime>\",\n \"summary\": \"<string>\",\n \"user_count\": \"<integer>\",\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"id\": \"<string>\",\n \"type\": \"team\",\n \"relationships\": {\n \"team_links\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"team_links\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"team_links\"\n }\n ],\n \"links\": {\n \"related\": \"<string>\"\n }\n },\n \"user_team_permissions\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"user_team_permissions\"\n },\n \"links\": {\n \"related\": \"<string>\"\n }\n }\n }\n }\n}"
},
{
"name": "API error response.",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"handle\": \"<string>\",\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"banner\": \"<long>\",\n \"description\": \"<string>\",\n \"hidden_modules\": [\n \"<string>\",\n \"<string>\"\n ],\n \"visible_modules\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n }\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/team",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"team"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
