Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcLayout_type
LOCAL lcDefinitionType
LOCAL lcShow_title
LOCAL lcTitle
LOCAL X
LOCAL Y
LOCAL lcWidth
LOCAL lcHeight
LOCAL lcName
LOCAL lcDescription
LOCAL lcId
LOCAL lcV_Email
LOCAL lcHandle
LOCAL lcAuthorName
LOCAL lcV_type
LOCAL j
LOCAL lnCount_j
LOCAL lcLayoutX
LOCAL lcLayoutY
LOCAL lcLayoutWidth
LOCAL lcLayoutHeight
LOCAL lcStrVal
LOCAL lcName
LOCAL k
LOCAL lnCount_k
LOCAL lcCreated_at
LOCAL lcDisabled
LOCAL lcAttributesEmail
LOCAL lcAttributesHandle
LOCAL lcIcon
LOCAL lcModified_at
LOCAL lcAttributesName
LOCAL lcService_account
LOCAL lcStatus
LOCAL lcAttributesTitle
LOCAL lcVerified
LOCAL lcId
LOCAL lcDataType
LOCAL lcFirst
LOCAL lcLast
LOCAL lcV_Next
LOCAL lcPrev
LOCAL lcV_Self
LOCAL lcFirst_offset
LOCAL lcLast_offset
LOCAL lcLimit
LOCAL lcNext_offset
LOCAL lcOffset
LOCAL lcPrev_offset
LOCAL lcTotal
LOCAL lcV_Type
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loQueryParams = CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams.UpdateInt("page[limit]",25)
loQueryParams.UpdateInt("page[offset]",0)
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/powerpacks",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat_9_5_0.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": [
* {
* "attributes": {
* "group_widget": {
* "definition": {
* "widgets": [
* {
* "definition": {
* "id4": {}
* },
* "layout": {
* "x": "<long>",
* "y": "<long>",
* "width": "<long>",
* "height": "<long>"
* }
* },
* {
* "definition": {
* "nullac41": {},
* "adipisicing9": {}
* },
* "layout": {
* "x": "<long>",
* "y": "<long>",
* "width": "<long>",
* "height": "<long>"
* }
* }
* ],
* "layout_type": "<string>",
* "type": "<string>",
* "show_title": "<boolean>",
* "title": "<string>"
* },
* "layout": {
* "x": "<long>",
* "y": "<long>",
* "width": "<long>",
* "height": "<long>"
* }
* },
* "name": "<string>",
* "description": "<string>",
* "tags": [
* "<string>",
* "<string>"
* ],
* "template_variables": [
* {
* "name": "<string>",
* "defaults": [
* "<string>",
* "<string>"
* ]
* },
* {
* "name": "<string>",
* "defaults": [
* "<string>",
* "<string>"
* ]
* }
* ]
* },
* "id": "<string>",
* "relationships": {
* "author": {
* "email": "<string>",
* "handle": "<string>",
* "name": "<string>"
* }
* },
* "type": "<string>"
* },
* {
* "attributes": {
* "group_widget": {
* "definition": {
* "widgets": [
* {
* "definition": {
* "ut9": {}
* },
* "layout": {
* "x": "<long>",
* "y": "<long>",
* "width": "<long>",
* "height": "<long>"
* }
* },
* {
* "definition": {
* "labore_391": {},
* "ullamco142": {}
* },
* "layout": {
* "x": "<long>",
* "y": "<long>",
* "width": "<long>",
* "height": "<long>"
* }
* }
* ],
* "layout_type": "<string>",
* "type": "<string>",
* "show_title": "<boolean>",
* "title": "<string>"
* },
* "layout": {
* "x": "<long>",
* "y": "<long>",
* "width": "<long>",
* "height": "<long>"
* }
* },
* "name": "<string>",
* "description": "<string>",
* "tags": [
* "<string>",
* "<string>"
* ],
* "template_variables": [
* {
* "name": "<string>",
* "defaults": [
* "<string>",
* "<string>"
* ]
* },
* {
* "name": "<string>",
* "defaults": [
* "<string>",
* "<string>"
* ]
* }
* ]
* },
* "id": "<string>",
* "relationships": {
* "author": {
* "email": "<string>",
* "handle": "<string>",
* "name": "<string>"
* }
* },
* "type": "<string>"
* }
* ],
* "included": [
* {
* "attributes": {
* "created_at": "<dateTime>",
* "disabled": "<boolean>",
* "email": "<string>",
* "handle": "<string>",
* "icon": "<string>",
* "modified_at": "<dateTime>",
* "name": "<string>",
* "service_account": "<boolean>",
* "status": "<string>",
* "title": "<string>",
* "verified": "<boolean>"
* },
* "id": "<string>",
* "relationships": {
* "org": {
* "data": {
* "id": "<string>",
* "type": "orgs"
* }
* },
* "other_orgs": {
* "data": [
* {
* "id": "<string>",
* "type": "orgs"
* },
* {
* "id": "<string>",
* "type": "orgs"
* }
* ]
* },
* "other_users": {
* "data": [
* {
* "id": "<string>",
* "type": "users"
* },
* {
* "id": "<string>",
* "type": "users"
* }
* ]
* },
* "roles": {
* "data": [
* {
* "id": "<string>",
* "type": "roles"
* },
* {
* "id": "<string>",
* "type": "roles"
* }
* ]
* }
* },
* "type": "users"
* },
* {
* "attributes": {
* "created_at": "<dateTime>",
* "disabled": "<boolean>",
* "email": "<string>",
* "handle": "<string>",
* "icon": "<string>",
* "modified_at": "<dateTime>",
* "name": "<string>",
* "service_account": "<boolean>",
* "status": "<string>",
* "title": "<string>",
* "verified": "<boolean>"
* },
* "id": "<string>",
* "relationships": {
* "org": {
* "data": {
* "id": "<string>",
* "type": "orgs"
* }
* },
* "other_orgs": {
* "data": [
* {
* "id": "<string>",
* "type": "orgs"
* },
* {
* "id": "<string>",
* "type": "orgs"
* }
* ]
* },
* "other_users": {
* "data": [
* {
* "id": "<string>",
* "type": "users"
* },
* {
* "id": "<string>",
* "type": "users"
* }
* ]
* },
* "roles": {
* "data": [
* {
* "id": "<string>",
* "type": "roles"
* },
* {
* "id": "<string>",
* "type": "roles"
* }
* ]
* }
* },
* "type": "users"
* }
* ],
* "links": {
* "first": "<string>",
* "last": "<string>",
* "next": "<string>",
* "prev": "<string>",
* "self": "<string>"
* },
* "meta": {
* "pagination": {
* "first_offset": "<long>",
* "last_offset": "<long>",
* "limit": "<long>",
* "next_offset": "<long>",
* "offset": "<long>",
* "prev_offset": "<long>",
* "total": "<long>",
* "type": "<string>"
* }
* }
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcFirst = loJResp.StringOf("links.first")
lcLast = loJResp.StringOf("links.last")
lcV_Next = loJResp.StringOf("links.next")
lcPrev = loJResp.StringOf("links.prev")
lcV_Self = loJResp.StringOf("links.self")
lcFirst_offset = loJResp.StringOf("meta.pagination.first_offset")
lcLast_offset = loJResp.StringOf("meta.pagination.last_offset")
lcLimit = loJResp.StringOf("meta.pagination.limit")
lcNext_offset = loJResp.StringOf("meta.pagination.next_offset")
lcOffset = loJResp.StringOf("meta.pagination.offset")
lcPrev_offset = loJResp.StringOf("meta.pagination.prev_offset")
lcTotal = loJResp.StringOf("meta.pagination.total")
lcV_Type = loJResp.StringOf("meta.pagination.type")
i = 0
lnCount_i = loJResp.SizeOfArray("data")
DO WHILE i < lnCount_i
loJResp.I = i
lcLayout_type = loJResp.StringOf("data[i].attributes.group_widget.definition.layout_type")
lcDefinitionType = loJResp.StringOf("data[i].attributes.group_widget.definition.type")
lcShow_title = loJResp.StringOf("data[i].attributes.group_widget.definition.show_title")
lcTitle = loJResp.StringOf("data[i].attributes.group_widget.definition.title")
X = loJResp.StringOf("data[i].attributes.group_widget.layout.x")
Y = loJResp.StringOf("data[i].attributes.group_widget.layout.y")
lcWidth = loJResp.StringOf("data[i].attributes.group_widget.layout.width")
lcHeight = loJResp.StringOf("data[i].attributes.group_widget.layout.height")
lcName = loJResp.StringOf("data[i].attributes.name")
lcDescription = loJResp.StringOf("data[i].attributes.description")
lcId = loJResp.StringOf("data[i].id")
lcV_Email = loJResp.StringOf("data[i].relationships.author.email")
lcHandle = loJResp.StringOf("data[i].relationships.author.handle")
lcAuthorName = loJResp.StringOf("data[i].relationships.author.name")
lcV_type = loJResp.StringOf("data[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attributes.group_widget.definition.widgets")
DO WHILE j < lnCount_j
loJResp.J = j
lcLayoutX = loJResp.StringOf("data[i].attributes.group_widget.definition.widgets[j].layout.x")
lcLayoutY = loJResp.StringOf("data[i].attributes.group_widget.definition.widgets[j].layout.y")
lcLayoutWidth = loJResp.StringOf("data[i].attributes.group_widget.definition.widgets[j].layout.width")
lcLayoutHeight = loJResp.StringOf("data[i].attributes.group_widget.definition.widgets[j].layout.height")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attributes.tags")
DO WHILE j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("data[i].attributes.tags[j]")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("data[i].attributes.template_variables")
DO WHILE j < lnCount_j
loJResp.J = j
lcName = loJResp.StringOf("data[i].attributes.template_variables[j].name")
k = 0
lnCount_k = loJResp.SizeOfArray("data[i].attributes.template_variables[j].defaults")
DO WHILE k < lnCount_k
loJResp.K = k
lcStrVal = loJResp.StringOf("data[i].attributes.template_variables[j].defaults[k]")
k = k + 1
ENDDO
j = j + 1
ENDDO
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("included")
DO WHILE i < lnCount_i
loJResp.I = i
lcCreated_at = loJResp.StringOf("included[i].attributes.created_at")
lcDisabled = loJResp.StringOf("included[i].attributes.disabled")
lcAttributesEmail = loJResp.StringOf("included[i].attributes.email")
lcAttributesHandle = loJResp.StringOf("included[i].attributes.handle")
lcIcon = loJResp.StringOf("included[i].attributes.icon")
lcModified_at = loJResp.StringOf("included[i].attributes.modified_at")
lcAttributesName = loJResp.StringOf("included[i].attributes.name")
lcService_account = loJResp.StringOf("included[i].attributes.service_account")
lcStatus = loJResp.StringOf("included[i].attributes.status")
lcAttributesTitle = loJResp.StringOf("included[i].attributes.title")
lcVerified = loJResp.StringOf("included[i].attributes.verified")
lcId = loJResp.StringOf("included[i].id")
lcId = loJResp.StringOf("included[i].relationships.org.data.id")
lcDataType = loJResp.StringOf("included[i].relationships.org.data.type")
lcV_type = loJResp.StringOf("included[i].type")
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].relationships.other_orgs.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("included[i].relationships.other_orgs.data[j].id")
lcV_type = loJResp.StringOf("included[i].relationships.other_orgs.data[j].type")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].relationships.other_users.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("included[i].relationships.other_users.data[j].id")
lcV_type = loJResp.StringOf("included[i].relationships.other_users.data[j].type")
j = j + 1
ENDDO
j = 0
lnCount_j = loJResp.SizeOfArray("included[i].relationships.roles.data")
DO WHILE j < lnCount_j
loJResp.J = j
lcId = loJResp.StringOf("included[i].relationships.roles.data[j].id")
lcV_type = loJResp.StringOf("included[i].relationships.roles.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[limit]=25"
-d "page[offset]=0"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/powerpacks
Postman Collection Item JSON
{
"name": "Get all powerpacks",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks?page[limit]=25&page[offset]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
}
]
},
"description": "Get a list of all powerpacks."
},
"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/powerpacks?page[limit]=25&page[offset]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"id4\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n {\n \"definition\": {\n \"nullac41\": {},\n \"adipisicing9\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n }\n ],\n \"layout_type\": \"<string>\",\n \"type\": \"<string>\",\n \"show_title\": \"<boolean>\",\n \"title\": \"<string>\"\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"template_variables\": [\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n },\n {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"ut9\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n {\n \"definition\": {\n \"labore_391\": {},\n \"ullamco142\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n }\n ],\n \"layout_type\": \"<string>\",\n \"type\": \"<string>\",\n \"show_title\": \"<boolean>\",\n \"title\": \"<string>\"\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ],\n \"template_variables\": [\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n },\n {\n \"name\": \"<string>\",\n \"defaults\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"author\": {\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"name\": \"<string>\"\n }\n },\n \"type\": \"<string>\"\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n },\n {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"disabled\": \"<boolean>\",\n \"email\": \"<string>\",\n \"handle\": \"<string>\",\n \"icon\": \"<string>\",\n \"modified_at\": \"<dateTime>\",\n \"name\": \"<string>\",\n \"service_account\": \"<boolean>\",\n \"status\": \"<string>\",\n \"title\": \"<string>\",\n \"verified\": \"<boolean>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"org\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n },\n \"other_orgs\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"orgs\"\n }\n ]\n },\n \"other_users\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n ]\n },\n \"roles\": {\n \"data\": [\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n },\n {\n \"id\": \"<string>\",\n \"type\": \"roles\"\n }\n ]\n }\n },\n \"type\": \"users\"\n }\n ],\n \"links\": {\n \"first\": \"<string>\",\n \"last\": \"<string>\",\n \"next\": \"<string>\",\n \"prev\": \"<string>\",\n \"self\": \"<string>\"\n },\n \"meta\": {\n \"pagination\": {\n \"first_offset\": \"<long>\",\n \"last_offset\": \"<long>\",\n \"limit\": \"<long>\",\n \"next_offset\": \"<long>\",\n \"offset\": \"<long>\",\n \"prev_offset\": \"<long>\",\n \"total\": \"<long>\",\n \"type\": \"<string>\"\n }\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/powerpacks?page[limit]=25&page[offset]=0",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks"
],
"query": [
{
"key": "page[limit]",
"value": "25",
"description": "Maximum number of powerpacks in the response."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
}
]
}
},
"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}"
}
]
}
