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
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"current_only","<boolean>")
CkJsonObject::ckUpdateString(queryParams,"include","<string>")
CkJsonObject::ckUpdateInt(queryParams,"page[offset]",0)
CkJsonObject::ckUpdateInt(queryParams,"page[limit]",30)
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://api.app.ddog-gov.com/api/v2/downtime",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
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(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": [
; {
; "attributes": {
; "canceled": "<dateTime>",
; "created": "<dateTime>",
; "display_timezone": "UTC",
; "message": "<string>",
; "modified": "<dateTime>",
; "monitor_identifier": {
; "monitor_id": "<long>"
; },
; "mute_first_recovery_notification": "<boolean>",
; "notify_end_states": [
; "no data",
; "no data"
; ],
; "notify_end_types": [
; "canceled",
; "canceled"
; ],
; "schedule": {
; "recurrences": [
; {
; "duration": "<string>",
; "rrule": "<string>",
; "start": "<string>"
; }
; ],
; "current_downtime": {
; "end": "<dateTime>",
; "start": "<dateTime>"
; },
; "timezone": "UTC"
; },
; "scope": "<string>",
; "status": "active"
; },
; "id": "<string>",
; "relationships": {
; "created_by": {
; "data": {
; "id": "<string>",
; "type": "users"
; }
; },
; "monitor": {
; "data": {
; "id": "<string>",
; "type": "monitors"
; }
; }
; },
; "type": "downtime"
; },
; {
; "attributes": {
; "canceled": "<dateTime>",
; "created": "<dateTime>",
; "display_timezone": "UTC",
; "message": "<string>",
; "modified": "<dateTime>",
; "monitor_identifier": {
; "monitor_id": "<long>"
; },
; "mute_first_recovery_notification": "<boolean>",
; "notify_end_states": [
; "warn",
; "alert"
; ],
; "notify_end_types": [
; "canceled",
; "canceled"
; ],
; "schedule": {
; "recurrences": [
; {
; "duration": "<string>",
; "rrule": "<string>",
; "start": "<string>"
; }
; ],
; "current_downtime": {
; "end": "<dateTime>",
; "start": "<dateTime>"
; },
; "timezone": "UTC"
; },
; "scope": "<string>",
; "status": "scheduled"
; },
; "id": "<string>",
; "relationships": {
; "created_by": {
; "data": {
; "id": "<string>",
; "type": "users"
; }
; },
; "monitor": {
; "data": {
; "id": "<string>",
; "type": "monitors"
; }
; }
; },
; "type": "downtime"
; }
; ],
; "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"
; }
; ],
; "meta": {
; "page": {
; "total_filtered_count": "<long>"
; }
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Canceled.s
Created.s
Display_timezone.s
Message.s
Modified.s
Monitor_id.s
Mute_first_recovery_notification.s
v_End.s
Start.s
Timezone.s
Scope.s
Status.s
id.s
Id.s
v_Type.s
DataId.s
DataType.s
v_type.s
j.i
count_j.i
strVal.s
duration.s
rrule.s
start.s
Created_at.s
Disabled.s
v_Email.s
Handle.s
Icon.s
Modified_at.s
Name.s
Service_account.s
attributesStatus.s
Title.s
Verified.s
Total_filtered_count.s = CkJsonObject::ckStringOf(jResp,"meta.page.total_filtered_count")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Canceled = CkJsonObject::ckStringOf(jResp,"data[i].attributes.canceled")
Created = CkJsonObject::ckStringOf(jResp,"data[i].attributes.created")
Display_timezone = CkJsonObject::ckStringOf(jResp,"data[i].attributes.display_timezone")
Message = CkJsonObject::ckStringOf(jResp,"data[i].attributes.message")
Modified = CkJsonObject::ckStringOf(jResp,"data[i].attributes.modified")
Monitor_id = CkJsonObject::ckStringOf(jResp,"data[i].attributes.monitor_identifier.monitor_id")
Mute_first_recovery_notification = CkJsonObject::ckStringOf(jResp,"data[i].attributes.mute_first_recovery_notification")
v_End = CkJsonObject::ckStringOf(jResp,"data[i].attributes.schedule.current_downtime.end")
Start = CkJsonObject::ckStringOf(jResp,"data[i].attributes.schedule.current_downtime.start")
Timezone = CkJsonObject::ckStringOf(jResp,"data[i].attributes.schedule.timezone")
Scope = CkJsonObject::ckStringOf(jResp,"data[i].attributes.scope")
Status = CkJsonObject::ckStringOf(jResp,"data[i].attributes.status")
id = CkJsonObject::ckStringOf(jResp,"data[i].id")
Id = CkJsonObject::ckStringOf(jResp,"data[i].relationships.created_by.data.id")
v_Type = CkJsonObject::ckStringOf(jResp,"data[i].relationships.created_by.data.type")
DataId = CkJsonObject::ckStringOf(jResp,"data[i].relationships.monitor.data.id")
DataType = CkJsonObject::ckStringOf(jResp,"data[i].relationships.monitor.data.type")
v_type = CkJsonObject::ckStringOf(jResp,"data[i].type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.notify_end_states")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"data[i].attributes.notify_end_states[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.notify_end_types")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"data[i].attributes.notify_end_types[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"data[i].attributes.schedule.recurrences")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
duration = CkJsonObject::ckStringOf(jResp,"data[i].attributes.schedule.recurrences[j].duration")
rrule = CkJsonObject::ckStringOf(jResp,"data[i].attributes.schedule.recurrences[j].rrule")
start = CkJsonObject::ckStringOf(jResp,"data[i].attributes.schedule.recurrences[j].start")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"included")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Created_at = CkJsonObject::ckStringOf(jResp,"included[i].attributes.created_at")
Disabled = CkJsonObject::ckStringOf(jResp,"included[i].attributes.disabled")
v_Email = CkJsonObject::ckStringOf(jResp,"included[i].attributes.email")
Handle = CkJsonObject::ckStringOf(jResp,"included[i].attributes.handle")
Icon = CkJsonObject::ckStringOf(jResp,"included[i].attributes.icon")
Modified_at = CkJsonObject::ckStringOf(jResp,"included[i].attributes.modified_at")
Name = CkJsonObject::ckStringOf(jResp,"included[i].attributes.name")
Service_account = CkJsonObject::ckStringOf(jResp,"included[i].attributes.service_account")
attributesStatus = CkJsonObject::ckStringOf(jResp,"included[i].attributes.status")
Title = CkJsonObject::ckStringOf(jResp,"included[i].attributes.title")
Verified = CkJsonObject::ckStringOf(jResp,"included[i].attributes.verified")
id = CkJsonObject::ckStringOf(jResp,"included[i].id")
DataId = CkJsonObject::ckStringOf(jResp,"included[i].relationships.org.data.id")
DataType = CkJsonObject::ckStringOf(jResp,"included[i].relationships.org.data.type")
v_type = CkJsonObject::ckStringOf(jResp,"included[i].type")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"included[i].relationships.other_orgs.data")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
id = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_orgs.data[j].id")
v_type = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_orgs.data[j].type")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"included[i].relationships.other_users.data")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
id = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_users.data[j].id")
v_type = CkJsonObject::ckStringOf(jResp,"included[i].relationships.other_users.data[j].type")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"included[i].relationships.roles.data")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
id = CkJsonObject::ckStringOf(jResp,"included[i].relationships.roles.data[j].id")
v_type = CkJsonObject::ckStringOf(jResp,"included[i].relationships.roles.data[j].type")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "current_only=%3Cboolean%3E"
-d "include=%3Cstring%3E"
-d "page[offset]=0"
-d "page[limit]=30"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/downtime
Postman Collection Item JSON
{
"name": "Get all downtimes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
},
"description": "Get all scheduled downtimes."
},
"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/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"attributes\": {\n \"canceled\": \"<dateTime>\",\n \"created\": \"<dateTime>\",\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"no data\",\n \"no data\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"canceled\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"<dateTime>\",\n \"start\": \"<dateTime>\"\n },\n \"timezone\": \"UTC\"\n },\n \"scope\": \"<string>\",\n \"status\": \"active\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\n },\n {\n \"attributes\": {\n \"canceled\": \"<dateTime>\",\n \"created\": \"<dateTime>\",\n \"display_timezone\": \"UTC\",\n \"message\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"monitor_identifier\": {\n \"monitor_id\": \"<long>\"\n },\n \"mute_first_recovery_notification\": \"<boolean>\",\n \"notify_end_states\": [\n \"warn\",\n \"alert\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"canceled\"\n ],\n \"schedule\": {\n \"recurrences\": [\n {\n \"duration\": \"<string>\",\n \"rrule\": \"<string>\",\n \"start\": \"<string>\"\n }\n ],\n \"current_downtime\": {\n \"end\": \"<dateTime>\",\n \"start\": \"<dateTime>\"\n },\n \"timezone\": \"UTC\"\n },\n \"scope\": \"<string>\",\n \"status\": \"scheduled\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"created_by\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n },\n \"monitor\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"monitors\"\n }\n }\n },\n \"type\": \"downtime\"\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 \"meta\": {\n \"page\": {\n \"total_filtered_count\": \"<long>\"\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/v2/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
}
},
"status": "Forbidden",
"code": 403,
"_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/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime"
],
"query": [
{
"key": "current_only",
"value": "<boolean>",
"description": "Only return downtimes that are active when the request is made."
},
{
"key": "include",
"value": "<string>",
"description": "Comma-separated list of resource paths for related resources to include in the response. Supported resource\npaths are `created_by` and `monitor`."
},
{
"key": "page[offset]",
"value": "0",
"description": "Specific offset to use as the beginning of the returned page."
},
{
"key": "page[limit]",
"value": "30",
"description": "Maximum number of downtimes in the response."
}
]
}
},
"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}"
}
]
}
