Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
Dim queryParams As New ChilkatJsonObject
success = queryParams.UpdateString("include","<string>")
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/downtime/:downtime_id",queryParams)
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' 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": [
' "alert",
' "alert"
' ],
' "notify_end_types": [
' "canceled",
' "expired"
' ],
' "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"
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim strVal As String
Dim duration As String
Dim rrule As String
Dim start As String
Dim Created_at As String
Dim Disabled As String
Dim v_Email As String
Dim Handle As String
Dim Icon As String
Dim Modified_at As String
Dim Name As String
Dim Service_account As String
Dim attributesStatus As String
Dim Title As String
Dim Verified As String
Dim id As String
Dim v_type As String
Dim j As Long
Dim count_j As Long
Dim Canceled As String
Canceled = jResp.StringOf("data.attributes.canceled")
Dim Created As String
Created = jResp.StringOf("data.attributes.created")
Dim Display_timezone As String
Display_timezone = jResp.StringOf("data.attributes.display_timezone")
Dim Message As String
Message = jResp.StringOf("data.attributes.message")
Dim Modified As String
Modified = jResp.StringOf("data.attributes.modified")
Dim Monitor_id As String
Monitor_id = jResp.StringOf("data.attributes.monitor_identifier.monitor_id")
Dim Mute_first_recovery_notification As String
Mute_first_recovery_notification = jResp.StringOf("data.attributes.mute_first_recovery_notification")
Dim v_End As String
v_End = jResp.StringOf("data.attributes.schedule.current_downtime.end")
Dim Start As String
Start = jResp.StringOf("data.attributes.schedule.current_downtime.start")
Dim Timezone As String
Timezone = jResp.StringOf("data.attributes.schedule.timezone")
Dim Scope As String
Scope = jResp.StringOf("data.attributes.scope")
Dim Status As String
Status = jResp.StringOf("data.attributes.status")
Dim Id As String
Id = jResp.StringOf("data.id")
Dim DataId As String
DataId = jResp.StringOf("data.relationships.created_by.data.id")
Dim v_Type As String
v_Type = jResp.StringOf("data.relationships.created_by.data.type")
DataId = jResp.StringOf("data.relationships.monitor.data.id")
Dim DataType As String
DataType = jResp.StringOf("data.relationships.monitor.data.type")
Dim dataType As String
dataType = jResp.StringOf("data.type")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data.attributes.notify_end_states")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("data.attributes.notify_end_states[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("data.attributes.notify_end_types")
Do While i < count_i
jResp.I = i
strVal = jResp.StringOf("data.attributes.notify_end_types[i]")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("data.attributes.schedule.recurrences")
Do While i < count_i
jResp.I = i
duration = jResp.StringOf("data.attributes.schedule.recurrences[i].duration")
rrule = jResp.StringOf("data.attributes.schedule.recurrences[i].rrule")
start = jResp.StringOf("data.attributes.schedule.recurrences[i].start")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("included")
Do While i < count_i
jResp.I = i
Created_at = jResp.StringOf("included[i].attributes.created_at")
Disabled = jResp.StringOf("included[i].attributes.disabled")
v_Email = jResp.StringOf("included[i].attributes.email")
Handle = jResp.StringOf("included[i].attributes.handle")
Icon = jResp.StringOf("included[i].attributes.icon")
Modified_at = jResp.StringOf("included[i].attributes.modified_at")
Name = jResp.StringOf("included[i].attributes.name")
Service_account = jResp.StringOf("included[i].attributes.service_account")
attributesStatus = jResp.StringOf("included[i].attributes.status")
Title = jResp.StringOf("included[i].attributes.title")
Verified = jResp.StringOf("included[i].attributes.verified")
id = jResp.StringOf("included[i].id")
DataId = jResp.StringOf("included[i].relationships.org.data.id")
DataType = jResp.StringOf("included[i].relationships.org.data.type")
v_type = jResp.StringOf("included[i].type")
j = 0
count_j = jResp.SizeOfArray("included[i].relationships.other_orgs.data")
Do While j < count_j
jResp.J = j
id = jResp.StringOf("included[i].relationships.other_orgs.data[j].id")
v_type = jResp.StringOf("included[i].relationships.other_orgs.data[j].type")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("included[i].relationships.other_users.data")
Do While j < count_j
jResp.J = j
id = jResp.StringOf("included[i].relationships.other_users.data[j].id")
v_type = jResp.StringOf("included[i].relationships.other_users.data[j].type")
j = j + 1
Loop
j = 0
count_j = jResp.SizeOfArray("included[i].relationships.roles.data")
Do While j < count_j
jResp.J = j
id = jResp.StringOf("included[i].relationships.roles.data[j].id")
v_type = jResp.StringOf("included[i].relationships.roles.data[j].type")
j = j + 1
Loop
i = i + 1
Loop
Curl Command
curl -G -d "include=%3Cstring%3E"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/downtime/:downtime_id
Postman Collection Item JSON
{
"name": "Get a downtime",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"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`."
}
],
"variable": [
{
"key": "downtime_id",
"value": "<string>"
}
]
},
"description": "Get downtime detail by `downtime_id`."
},
"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/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"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`."
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\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 \"alert\",\n \"alert\"\n ],\n \"notify_end_types\": [\n \"canceled\",\n \"expired\"\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 \"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": "Bad Request",
"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/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"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`."
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"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`."
}
],
"variable": [
{
"key": "downtime_id"
}
]
}
},
"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": "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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"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`."
}
],
"variable": [
{
"key": "downtime_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/downtime/:downtime_id?include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"downtime",
":downtime_id"
],
"query": [
{
"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`."
}
],
"variable": [
{
"key": "downtime_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}"
}
]
}
