Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW json;
HCkStringBuilderW sbRequestBody;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *v_type;
const wchar_t *Created;
const wchar_t *Description;
const wchar_t *Display_name;
const wchar_t *Display_type;
const wchar_t *Group_name;
const wchar_t *Name;
const wchar_t *Restricted;
const wchar_t *id;
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": {
// "id": "<string>",
// "type": "permissions"
// }
// }
json = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(json,L"data.id",L"<string>");
CkJsonObjectW_UpdateString(json,L"data.type",L"permissions");
CkHttpW_SetRequestHeader(http,L"Content-Type",L"application/json");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
sbRequestBody = CkStringBuilderW_Create();
CkJsonObjectW_EmitSb(json,sbRequestBody);
resp = CkHttpW_PTextSb(http,L"DELETE",L"https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions",sbRequestBody,L"utf-8",L"application/json",FALSE,FALSE);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
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(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "type": "permissions",
// "attributes": {
// "created": "<dateTime>",
// "description": "<string>",
// "display_name": "<string>",
// "display_type": "<string>",
// "group_name": "<string>",
// "name": "<string>",
// "restricted": "<boolean>"
// },
// "id": "<string>"
// },
// {
// "type": "permissions",
// "attributes": {
// "created": "<dateTime>",
// "description": "<string>",
// "display_name": "<string>",
// "display_type": "<string>",
// "group_name": "<string>",
// "name": "<string>",
// "restricted": "<boolean>"
// },
// "id": "<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.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"data");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
v_type = CkJsonObjectW_stringOf(jResp,L"data[i].type");
Created = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.created");
Description = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.description");
Display_name = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.display_name");
Display_type = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.display_type");
Group_name = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.group_name");
Name = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.name");
Restricted = CkJsonObjectW_stringOf(jResp,L"data[i].attributes.restricted");
id = CkJsonObjectW_stringOf(jResp,L"data[i].id");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbRequestBody);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X DELETE
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"id": "<string>",
"type": "permissions"
}
}'
https://api.app.ddog-gov.com/api/v2/roles/:role_id/permissions
Postman Collection Item JSON
{
"name": "Revoke permission",
"request": {
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id",
"value": "<string>"
}
]
},
"description": "Removes a permission from a role."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "DELETE",
"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 \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"display_type\": \"<string>\",\n \"group_name\": \"<string>\",\n \"name\": \"<string>\",\n \"restricted\": \"<boolean>\"\n },\n \"id\": \"<string>\"\n },\n {\n \"type\": \"permissions\",\n \"attributes\": {\n \"created\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"display_name\": \"<string>\",\n \"display_type\": \"<string>\",\n \"group_name\": \"<string>\",\n \"name\": \"<string>\",\n \"restricted\": \"<boolean>\"\n },\n \"id\": \"<string>\"\n }\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "DELETE",
"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 \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "DELETE",
"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 \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "DELETE",
"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 \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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": "DELETE",
"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 \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/roles/:role_id/permissions",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles",
":role_id",
"permissions"
],
"variable": [
{
"key": "role_id"
}
]
}
},
"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}"
}
]
}
