Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sDescription
String sName
Boolean iSecure
String sValue
String sId
String sV_Type
String sField
String sLocalVariableName
String sParserType
String sParserValue
String sParse_test_public_id
Integer j
Integer iCount_j
String sStrVal
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://api.app.ddog-gov.com/api/v1/synthetics/variables" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Move 0 To i
Get ComSizeOfArray Of hoJResp "variables" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "variables[i].description" To sDescription
Get ComStringOf Of hoJResp "variables[i].name" To sName
Get ComBoolOf Of hoJResp "variables[i].value.secure" To iSecure
Get ComStringOf Of hoJResp "variables[i].value.value" To sValue
Get ComStringOf Of hoJResp "variables[i].id" To sId
Get ComStringOf Of hoJResp "variables[i].parse_test_options.type" To sV_Type
Get ComStringOf Of hoJResp "variables[i].parse_test_options.field" To sField
Get ComStringOf Of hoJResp "variables[i].parse_test_options.localVariableName" To sLocalVariableName
Get ComStringOf Of hoJResp "variables[i].parse_test_options.parser.type" To sParserType
Get ComStringOf Of hoJResp "variables[i].parse_test_options.parser.value" To sParserValue
Get ComStringOf Of hoJResp "variables[i].parse_test_public_id" To sParse_test_public_id
Move 0 To j
Get ComSizeOfArray Of hoJResp "variables[i].tags" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "variables[i].tags[j]" To sStrVal
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "variables[i].attributes.restricted_roles" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "variables[i].attributes.restricted_roles[j]" To sStrVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
