Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "tests": [
; {
; "public_id": "aaa-aaa-aaa",
; "metadata": {
; "ci": {
; "pipeline": {
; "url": "aliquip in ex do"
; },
; "provider": {
; "name": "nostrud culpa"
; }
; },
; "git": {
; "branch": "esse",
; "commitSha": "occaecat incididunt aute exercitation"
; }
; }
; },
; {
; "public_id": "aaa-aaa-aaa",
; "metadata": {
; "ci": {
; "pipeline": {
; "url": "pariatur ullamco sed"
; },
; "provider": {
; "name": "adipisicing exercitation laborum non"
; }
; },
; "git": {
; "branch": "tempor fugiat consequat Lorem",
; "commitSha": "esse aliqua"
; }
; }
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"tests[0].public_id","aaa-aaa-aaa")
CkJsonObject::ckUpdateString(json,"tests[0].metadata.ci.pipeline.url","aliquip in ex do")
CkJsonObject::ckUpdateString(json,"tests[0].metadata.ci.provider.name","nostrud culpa")
CkJsonObject::ckUpdateString(json,"tests[0].metadata.git.branch","esse")
CkJsonObject::ckUpdateString(json,"tests[0].metadata.git.commitSha","occaecat incididunt aute exercitation")
CkJsonObject::ckUpdateString(json,"tests[1].public_id","aaa-aaa-aaa")
CkJsonObject::ckUpdateString(json,"tests[1].metadata.ci.pipeline.url","pariatur ullamco sed")
CkJsonObject::ckUpdateString(json,"tests[1].metadata.ci.provider.name","adipisicing exercitation laborum non")
CkJsonObject::ckUpdateString(json,"tests[1].metadata.git.branch","tempor fugiat consequat Lorem")
CkJsonObject::ckUpdateString(json,"tests[1].metadata.git.commitSha","esse aliqua")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.app.ddog-gov.com/api/v1/synthetics/tests/trigger","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "batch_id": "anim quis",
; "locations": [
; {
; "id": -79104764,
; "name": "laborum"
; },
; {
; "id": -12473023,
; "name": "ullamco eu"
; }
; ],
; "results": [
; {
; "device": "laptop_large",
; "location": -53475818,
; "public_id": "Excepteur et",
; "result_id": "in"
; },
; {
; "device": "laptop_large",
; "location": 59458053,
; "public_id": "ut labore",
; "result_id": "quis tempor cillum est eu"
; }
; ],
; "triggered_check_ids": [
; "in irure culpa",
; "sit ad do Ut esse"
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.i
name.s
device.s
location.i
public_id.s
result_id.s
strVal.s
batch_id.s = CkJsonObject::ckStringOf(jResp,"batch_id")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"locations")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckIntOf(jResp,"locations[i].id")
name = CkJsonObject::ckStringOf(jResp,"locations[i].name")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"results")
While i < count_i
CkJsonObject::setCkI(jResp, i)
device = CkJsonObject::ckStringOf(jResp,"results[i].device")
location = CkJsonObject::ckIntOf(jResp,"results[i].location")
public_id = CkJsonObject::ckStringOf(jResp,"results[i].public_id")
result_id = CkJsonObject::ckStringOf(jResp,"results[i].result_id")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"triggered_check_ids")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"triggered_check_ids[i]")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"tests": [
{
"public_id": "aaa-aaa-aaa",
"metadata": {
"ci": {
"pipeline": {
"url": "aliquip in ex do"
},
"provider": {
"name": "nostrud culpa"
}
},
"git": {
"branch": "esse",
"commitSha": "occaecat incididunt aute exercitation"
}
}
},
{
"public_id": "aaa-aaa-aaa",
"metadata": {
"ci": {
"pipeline": {
"url": "pariatur ullamco sed"
},
"provider": {
"name": "adipisicing exercitation laborum non"
}
},
"git": {
"branch": "tempor fugiat consequat Lorem",
"commitSha": "esse aliqua"
}
}
}
]
}'
https://api.app.ddog-gov.com/api/v1/synthetics/tests/trigger
Postman Collection Item JSON
{
"name": "Trigger Synthetic tests",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"aliquip in ex do\"\n },\n \"provider\": {\n \"name\": \"nostrud culpa\"\n }\n },\n \"git\": {\n \"branch\": \"esse\",\n \"commitSha\": \"occaecat incididunt aute exercitation\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur ullamco sed\"\n },\n \"provider\": {\n \"name\": \"adipisicing exercitation laborum non\"\n }\n },\n \"git\": {\n \"branch\": \"tempor fugiat consequat Lorem\",\n \"commitSha\": \"esse aliqua\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
},
"description": "Trigger a set of Synthetic tests."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"aliquip in ex do\"\n },\n \"provider\": {\n \"name\": \"nostrud culpa\"\n }\n },\n \"git\": {\n \"branch\": \"esse\",\n \"commitSha\": \"occaecat incididunt aute exercitation\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur ullamco sed\"\n },\n \"provider\": {\n \"name\": \"adipisicing exercitation laborum non\"\n }\n },\n \"git\": {\n \"branch\": \"tempor fugiat consequat Lorem\",\n \"commitSha\": \"esse aliqua\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"batch_id\": \"anim quis\",\n \"locations\": [\n {\n \"id\": -79104764,\n \"name\": \"laborum\"\n },\n {\n \"id\": -12473023,\n \"name\": \"ullamco eu\"\n }\n ],\n \"results\": [\n {\n \"device\": \"laptop_large\",\n \"location\": -53475818,\n \"public_id\": \"Excepteur et\",\n \"result_id\": \"in\"\n },\n {\n \"device\": \"laptop_large\",\n \"location\": 59458053,\n \"public_id\": \"ut labore\",\n \"result_id\": \"quis tempor cillum est eu\"\n }\n ],\n \"triggered_check_ids\": [\n \"in irure culpa\",\n \"sit ad do Ut esse\"\n ]\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"aliquip in ex do\"\n },\n \"provider\": {\n \"name\": \"nostrud culpa\"\n }\n },\n \"git\": {\n \"branch\": \"esse\",\n \"commitSha\": \"occaecat incididunt aute exercitation\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur ullamco sed\"\n },\n \"provider\": {\n \"name\": \"adipisicing exercitation laborum non\"\n }\n },\n \"git\": {\n \"branch\": \"tempor fugiat consequat Lorem\",\n \"commitSha\": \"esse aliqua\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
}
},
"status": "Bad Request",
"code": 400,
"_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": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"tests\": [\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"aliquip in ex do\"\n },\n \"provider\": {\n \"name\": \"nostrud culpa\"\n }\n },\n \"git\": {\n \"branch\": \"esse\",\n \"commitSha\": \"occaecat incididunt aute exercitation\"\n }\n }\n },\n {\n \"public_id\": \"aaa-aaa-aaa\",\n \"metadata\": {\n \"ci\": {\n \"pipeline\": {\n \"url\": \"pariatur ullamco sed\"\n },\n \"provider\": {\n \"name\": \"adipisicing exercitation laborum non\"\n }\n },\n \"git\": {\n \"branch\": \"tempor fugiat consequat Lorem\",\n \"commitSha\": \"esse aliqua\"\n }\n }\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/synthetics/tests/trigger",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"synthetics",
"tests",
"trigger"
]
}
},
"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}"
}
]
}
