Back to Collection Items
var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_type: PWideChar;
Created_at: PWideChar;
Modified_at: PWideChar;
Name: PWideChar;
User_count: PWideChar;
id: PWideChar;
j: Integer;
count_j: Integer;
Total_count: PWideChar;
Total_filtered_count: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
queryParams := CkJsonObject_Create();
CkJsonObject_UpdateInt(queryParams,'page[size]',10);
CkJsonObject_UpdateInt(queryParams,'page[number]',0);
CkJsonObject_UpdateString(queryParams,'sort','name');
CkJsonObject_UpdateString(queryParams,'filter','<string>');
CkHttp_SetRequestHeader(http,'Accept','application/json');
resp := CkHttp_QuickRequestParams(http,'GET','https://api.app.ddog-gov.com/api/v2/roles',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "type": "roles",
// "attributes": {
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "user_count": "<long>"
// },
// "id": "<string>",
// "relationships": {
// "permissions": {
// "data": [
// {
// "id": "<string>",
// "type": "permissions"
// },
// {
// "id": "<string>",
// "type": "permissions"
// }
// ]
// }
// }
// },
// {
// "type": "roles",
// "attributes": {
// "created_at": "<dateTime>",
// "modified_at": "<dateTime>",
// "name": "<string>",
// "user_count": "<long>"
// },
// "id": "<string>",
// "relationships": {
// "permissions": {
// "data": [
// {
// "id": "<string>",
// "type": "permissions"
// },
// {
// "id": "<string>",
// "type": "permissions"
// }
// ]
// }
// }
// }
// ],
// "meta": {
// "page": {
// "total_count": "<long>",
// "total_filtered_count": "<long>"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Total_count := CkJsonObject__stringOf(jResp,'meta.page.total_count');
Total_filtered_count := CkJsonObject__stringOf(jResp,'meta.page.total_filtered_count');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
v_type := CkJsonObject__stringOf(jResp,'data[i].type');
Created_at := CkJsonObject__stringOf(jResp,'data[i].attributes.created_at');
Modified_at := CkJsonObject__stringOf(jResp,'data[i].attributes.modified_at');
Name := CkJsonObject__stringOf(jResp,'data[i].attributes.name');
User_count := CkJsonObject__stringOf(jResp,'data[i].attributes.user_count');
id := CkJsonObject__stringOf(jResp,'data[i].id');
j := 0;
count_j := CkJsonObject_SizeOfArray(jResp,'data[i].relationships.permissions.data');
while j < count_j do
begin
CkJsonObject_putJ(jResp,j);
id := CkJsonObject__stringOf(jResp,'data[i].relationships.permissions.data[j].id');
v_type := CkJsonObject__stringOf(jResp,'data[i].relationships.permissions.data[j].type');
j := j + 1;
end;
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
Curl Command
curl -G -d "page[size]=10"
-d "page[number]=0"
-d "sort=name"
-d "filter=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/roles
Postman Collection Item JSON
{
"name": "List roles",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
},
"description": "Returns all roles, including their names and their unique identifiers."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"user_count\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n },\n {\n \"type\": \"roles\",\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"user_count\": \"<long>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"permissions\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"permissions\"\n }\n ]\n }\n }\n }\n ],\n \"meta\": {\n \"page\": {\n \"total_count\": \"<long>\",\n \"total_filtered_count\": \"<long>\"\n }\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
}
},
"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": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/roles?page[size]=10&page[number]=0&sort=name&filter=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"roles"
],
"query": [
{
"key": "page[size]",
"value": "10",
"description": "Size for a given page. The maximum allowed value is 100."
},
{
"key": "page[number]",
"value": "0",
"description": "Specific page number to return."
},
{
"key": "sort",
"value": "name",
"description": "Sort roles depending on the given field. Sort order is **ascending** by default.\nSort order is **descending** if the field is prefixed by a negative sign, for example:\n`sort=-name`."
},
{
"key": "filter",
"value": "<string>",
"description": "Filter all roles by the given string."
}
]
}
},
"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}"
}
]
}
