Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.app.ddog-gov.com/api/v1/synthetics/variables",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "variables": [
; {
; "description": "Example description",
; "name": "MY_VARIABLE",
; "tags": [
; "team:front",
; "test:workflow-1"
; ],
; "value": {
; "secure": true,
; "value": "value"
; },
; "attributes": {
; "restricted_roles": [
; "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
; ]
; },
; "id": "id Ut Excepteur commodo consectetur",
; "parse_test_options": {
; "type": "http_body",
; "field": "content-type",
; "localVariableName": "LOCAL_VARIABLE",
; "parser": {
; "type": "regex",
; "value": ".*"
; }
; },
; "parse_test_public_id": "abc-def-123"
; },
; {
; "description": "Example description",
; "name": "MY_VARIABLE",
; "tags": [
; "team:front",
; "test:workflow-1"
; ],
; "value": {
; "secure": true,
; "value": "value"
; },
; "attributes": {
; "restricted_roles": [
; "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
; ]
; },
; "id": "consectetur enim magna",
; "parse_test_options": {
; "type": "http_body",
; "field": "content-type",
; "localVariableName": "LOCAL_VARIABLE",
; "parser": {
; "type": "regex",
; "value": ".*"
; }
; },
; "parse_test_public_id": "abc-def-123"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
description.s
name.s
Secure.i
Value.s
id.s
v_Type.s
Field.s
LocalVariableName.s
ParserType.s
ParserValue.s
parse_test_public_id.s
j.i
count_j.i
strVal.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"variables")
While i < count_i
CkJsonObject::setCkI(jResp, i)
description = CkJsonObject::ckStringOf(jResp,"variables[i].description")
name = CkJsonObject::ckStringOf(jResp,"variables[i].name")
Secure = CkJsonObject::ckBoolOf(jResp,"variables[i].value.secure")
Value = CkJsonObject::ckStringOf(jResp,"variables[i].value.value")
id = CkJsonObject::ckStringOf(jResp,"variables[i].id")
v_Type = CkJsonObject::ckStringOf(jResp,"variables[i].parse_test_options.type")
Field = CkJsonObject::ckStringOf(jResp,"variables[i].parse_test_options.field")
LocalVariableName = CkJsonObject::ckStringOf(jResp,"variables[i].parse_test_options.localVariableName")
ParserType = CkJsonObject::ckStringOf(jResp,"variables[i].parse_test_options.parser.type")
ParserValue = CkJsonObject::ckStringOf(jResp,"variables[i].parse_test_options.parser.value")
parse_test_public_id = CkJsonObject::ckStringOf(jResp,"variables[i].parse_test_public_id")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"variables[i].tags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"variables[i].tags[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"variables[i].attributes.restricted_roles")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"variables[i].attributes.restricted_roles[j]")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/synthetics/variables
Postman Collection Item JSON
{
"name": "Get all global variables",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
},
"description": "Get the list of all Synthetic global variables."
},
"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/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"variables\": [\n {\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"id Ut Excepteur commodo consectetur\",\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n },\n {\n \"description\": \"Example description\",\n \"name\": \"MY_VARIABLE\",\n \"tags\": [\n \"team:front\",\n \"test:workflow-1\"\n ],\n \"value\": {\n \"secure\": true,\n \"value\": \"value\"\n },\n \"attributes\": {\n \"restricted_roles\": [\n \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n ]\n },\n \"id\": \"consectetur enim magna\",\n \"parse_test_options\": {\n \"type\": \"http_body\",\n \"field\": \"content-type\",\n \"localVariableName\": \"LOCAL_VARIABLE\",\n \"parser\": {\n \"type\": \"regex\",\n \"value\": \".*\"\n }\n },\n \"parse_test_public_id\": \"abc-def-123\"\n }\n ]\n}"
},
{
"name": "Forbidden",
"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/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\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/v1/synthetics/variables",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"variables"
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"Bad Request\",\n \"Bad Request\"\n ]\n}"
}
]
}
