Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcV_type
LOCAL lcCreated_at
LOCAL lcModified_at
LOCAL lcName
LOCAL lcUser_count
LOCAL lcId
LOCAL j
LOCAL lnCount_j
LOCAL lcTotal_count
LOCAL lcTotal_filtered_count
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("page[size]",10)
loQueryParams.UpdateInt("page[number]",0)
loQueryParams.UpdateString("sort","name")
loQueryParams.UpdateString("filter","<string>")
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/roles",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcTotal_count = loJResp.StringOf("meta.page.total_count")
lcTotal_filtered_count = loJResp.StringOf("meta.page.total_filtered_count")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcV_type = loJResp.StringOf("data[i].type")
lcCreated_at = loJResp.StringOf("data[i].attributes.created_at")
lcModified_at = loJResp.StringOf("data[i].attributes.modified_at")
lcName = loJResp.StringOf("data[i].attributes.name")
lcUser_count = loJResp.StringOf("data[i].attributes.user_count")
lcId = loJResp.StringOf("data[i].id")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].relationships.permissions.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("data[i].relationships.permissions.data[j].id")
lcV_type = loJResp.StringOf("data[i].relationships.permissions.data[j].type")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
