Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_SbRequestBody
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Default_value
string ls_Name
string ls_Prefix
integer j
integer li_Count_j
string ls_StrVal
string ls_Dashboard_id
string ls_Dashboard_type
string ls_Handle
string ls_Name
string ls_Created_at
string ls_Live_span
integer li_Global_time_selectable_enabled
string ls_Public_url
string ls_Share_type
string ls_Token
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "global_time": {
// "live_span": "1h"
// },
// "share_list": [
// "test@datadoghq.com",
// "test2@datadoghq.com"
// ],
// "share_type": "invite"
// }
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_Json.UpdateString("global_time.live_span","1h")
loo_Json.UpdateString("share_list[0]","test@datadoghq.com")
loo_Json.UpdateString("share_list[1]","test2@datadoghq.com")
loo_Json.UpdateString("share_type","invite")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbRequestBody = create oleobject
li_rc = loo_SbRequestBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Json.EmitSb(loo_SbRequestBody)
loo_Resp = loo_Http.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/dashboard/public/:token",loo_SbRequestBody,"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "dashboard_id": "123-abc-456",
// "dashboard_type": "custom_timeboard",
// "author": {
// "handle": "test@datadoghq.com",
// "name": "consequat irure sit"
// },
// "created_at": "2008-04-06T04:45:45.510Z",
// "global_time": {
// "live_span": "1h"
// },
// "global_time_selectable_enabled": false,
// "public_url": "fugiat esse mollit adipisicing",
// "selectable_template_vars": [
// {
// "default_value": "*",
// "name": "exampleVar",
// "prefix": "test",
// "visible_tags": [
// "selectableValue1",
// "selectableValue2"
// ]
// }
// ],
// "share_list": [
// "test@datadoghq.com",
// "test2@email.com"
// ],
// "share_type": "open",
// "token": "dolor fugiat consectetur ex"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Dashboard_id = loo_JResp.StringOf("dashboard_id")
ls_Dashboard_type = loo_JResp.StringOf("dashboard_type")
ls_Handle = loo_JResp.StringOf("author.handle")
ls_Name = loo_JResp.StringOf("author.name")
ls_Created_at = loo_JResp.StringOf("created_at")
ls_Live_span = loo_JResp.StringOf("global_time.live_span")
li_Global_time_selectable_enabled = loo_JResp.BoolOf("global_time_selectable_enabled")
ls_Public_url = loo_JResp.StringOf("public_url")
ls_Share_type = loo_JResp.StringOf("share_type")
ls_Token = loo_JResp.StringOf("token")
i = 0
li_Count_i = loo_JResp.SizeOfArray("selectable_template_vars")
do while i < li_Count_i
loo_JResp.I = i
ls_Default_value = loo_JResp.StringOf("selectable_template_vars[i].default_value")
ls_Name = loo_JResp.StringOf("selectable_template_vars[i].name")
ls_Prefix = loo_JResp.StringOf("selectable_template_vars[i].prefix")
j = 0
li_Count_j = loo_JResp.SizeOfArray("selectable_template_vars[i].visible_tags")
do while j < li_Count_j
loo_JResp.J = j
ls_StrVal = loo_JResp.StringOf("selectable_template_vars[i].visible_tags[j]")
j = j + 1
loop
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("share_list")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("share_list[i]")
i = i + 1
loop
destroy loo_Http
destroy loo_Json
destroy loo_SbRequestBody
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"global_time": {
"live_span": "1h"
},
"share_list": [
"test@datadoghq.com",
"test2@datadoghq.com"
],
"share_type": "invite"
}'
https://api.app.ddog-gov.com/api/v1/dashboard/public/:token
Postman Collection Item JSON
{
"name": "Update a shared dashboard",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token",
"value": "tempor Ut sed velit"
}
]
},
"description": "Update a shared dashboard associated with the specified token."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "PUT",
"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 \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"dashboard_id\": \"123-abc-456\",\n \"dashboard_type\": \"custom_timeboard\",\n \"author\": {\n \"handle\": \"test@datadoghq.com\",\n \"name\": \"consequat irure sit\"\n },\n \"created_at\": \"2008-04-06T04:45:45.510Z\",\n \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"global_time_selectable_enabled\": false,\n \"public_url\": \"fugiat esse mollit adipisicing\",\n \"selectable_template_vars\": [\n {\n \"default_value\": \"*\",\n \"name\": \"exampleVar\",\n \"prefix\": \"test\",\n \"visible_tags\": [\n \"selectableValue1\",\n \"selectableValue2\"\n ]\n }\n ],\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@email.com\"\n ],\n \"share_type\": \"open\",\n \"token\": \"dolor fugiat consectetur ex\"\n}"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "PUT",
"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 \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"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": "Authentication Error",
"originalRequest": {
"method": "PUT",
"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 \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"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": "Item Not Found",
"originalRequest": {
"method": "PUT",
"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 \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"status": "Not Found",
"code": 404,
"_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": "PUT",
"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 \"global_time\": {\n \"live_span\": \"1h\"\n },\n \"share_list\": [\n \"test@datadoghq.com\",\n \"test2@datadoghq.com\"\n ],\n \"share_type\": \"invite\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/dashboard/public/:token",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"dashboard",
"public",
":token"
],
"variable": [
{
"key": "token"
}
]
}
},
"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}"
}
]
}
