Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/powerpacks/:powerpack_id",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loHttp.LastHeader
? "Failed."
release loHttp
release loSbResponseBody
release loJResp
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "attributes": {
// "group_widget": {
// "definition": {
// "widgets": [
// {
// "definition": {
// "aliquip_83": {}
// },
// "layout": {
// "x": "<long>",
// "y": "<long>",
// "width": "<long>",
// "height": "<long>"
// }
// },
// {
// "definition": {
// "etc": {},
// "ut_a6": {},
// "et5d": {}
// },
// "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"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcLayout_type = loJResp.StringOf("data.attributes.group_widget.definition.layout_type")
lcV_Type = loJResp.StringOf("data.attributes.group_widget.definition.type")
lcShow_title = loJResp.StringOf("data.attributes.group_widget.definition.show_title")
lcTitle = loJResp.StringOf("data.attributes.group_widget.definition.title")
X = loJResp.StringOf("data.attributes.group_widget.layout.x")
Y = loJResp.StringOf("data.attributes.group_widget.layout.y")
lcWidth = loJResp.StringOf("data.attributes.group_widget.layout.width")
lcHeight = loJResp.StringOf("data.attributes.group_widget.layout.height")
lcName = loJResp.StringOf("data.attributes.name")
lcDescription = loJResp.StringOf("data.attributes.description")
lcId = loJResp.StringOf("data.id")
lcV_Email = loJResp.StringOf("data.relationships.author.email")
lcHandle = loJResp.StringOf("data.relationships.author.handle")
lcAuthorName = loJResp.StringOf("data.relationships.author.name")
lcDataType = loJResp.StringOf("data.type")
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.group_widget.definition.widgets")
do while i < lnCount_i
loJResp.I = i
lcLayoutX = loJResp.StringOf("data.attributes.group_widget.definition.widgets[i].layout.x")
lcLayoutY = loJResp.StringOf("data.attributes.group_widget.definition.widgets[i].layout.y")
lcLayoutWidth = loJResp.StringOf("data.attributes.group_widget.definition.widgets[i].layout.width")
lcLayoutHeight = loJResp.StringOf("data.attributes.group_widget.definition.widgets[i].layout.height")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.tags")
do while i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("data.attributes.tags[i]")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.template_variables")
do while i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("data.attributes.template_variables[i].name")
j = 0
lnCount_j = loJResp.SizeOfArray("data.attributes.template_variables[i].defaults")
do while j < lnCount_j
loJResp.J = j
lcStrVal = loJResp.StringOf("data.attributes.template_variables[i].defaults[j]")
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")
lcDataId = 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 loSbResponseBody
release loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/powerpacks/:powerpack_id
Postman Collection Item JSON
{
"name": "Get a Powerpack",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/powerpacks/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id",
"value": "<string>"
}
]
},
"description": "Get a powerpack."
},
"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/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"group_widget\": {\n \"definition\": {\n \"widgets\": [\n {\n \"definition\": {\n \"aliquip_83\": {}\n },\n \"layout\": {\n \"x\": \"<long>\",\n \"y\": \"<long>\",\n \"width\": \"<long>\",\n \"height\": \"<long>\"\n }\n },\n {\n \"definition\": {\n \"etc\": {},\n \"ut_a6\": {},\n \"et5d\": {}\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 \"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}"
},
{
"name": "Powerpack Not Found.",
"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/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_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": "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/:powerpack_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"powerpacks",
":powerpack_id"
],
"variable": [
{
"key": "powerpack_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}"
}
]
}
