Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "data": {
// "attributes": {
// "cells": [
// {
// "attributes": {
// "definition": {
// "text": "## Some updated test markdown\n\nWith some example content.",
// "type": "markdown"
// }
// },
// "type": "notebook_cells"
// },
// {
// "attributes": {
// "definition": {
// "requests": [
// {
// "display_type": "bars",
// "q": "avg:system.load.1{*}",
// "style": {
// "line_type": "solid",
// "line_width": "normal",
// "palette": "warm"
// }
// }
// ],
// "show_legend": true,
// "type": "timeseries",
// "yaxis": {
// "scale": "linear"
// }
// },
// "graph_size": "m",
// "split_by": {
// "keys": [
// ],
// "tags": [
// ]
// },
// "time": null
// },
// "id": "abcd1234",
// "type": "notebook_cells"
// }
// ],
// "name": "Example Notebook",
// "time": {
// "live_span": "1h"
// }
// },
// "type": "notebooks"
// }
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("data.attributes.cells[0].attributes.definition.text","## Some updated test markdown" + Chr(10) + Chr(10) + "With some example content.")
loJson.UpdateString("data.attributes.cells[0].attributes.definition.type","markdown")
loJson.UpdateString("data.attributes.cells[0].type","notebook_cells")
loJson.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].display_type","bars")
loJson.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].q","avg:system.load.1{*}")
loJson.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].style.line_type","solid")
loJson.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].style.line_width","normal")
loJson.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].style.palette","warm")
loJson.UpdateBool("data.attributes.cells[1].attributes.definition.show_legend",.T.)
loJson.UpdateString("data.attributes.cells[1].attributes.definition.type","timeseries")
loJson.UpdateString("data.attributes.cells[1].attributes.definition.yaxis.scale","linear")
loJson.UpdateString("data.attributes.cells[1].attributes.graph_size","m")
loJson.UpdateNewArray("data.attributes.cells[1].attributes.split_by.keys")
loJson.UpdateNewArray("data.attributes.cells[1].attributes.split_by.tags")
loJson.UpdateNull("data.attributes.cells[1].attributes.time")
loJson.UpdateString("data.attributes.cells[1].id","abcd1234")
loJson.UpdateString("data.attributes.cells[1].type","notebook_cells")
loJson.UpdateString("data.attributes.name","Example Notebook")
loJson.UpdateString("data.attributes.time.live_span","1h")
loJson.UpdateString("data.type","notebooks")
loHttp.SetRequestHeader("Content-Type","application/json")
loHttp.SetRequestHeader("Accept","application/json")
loSbRequestBody = createobject("CkStringBuilder")
loJson.EmitSb(loSbRequestBody)
loResp = loHttp.PTextSb("PUT","https://api.app.ddog-gov.com/api/v1/notebooks/:notebook_id",loSbRequestBody,"utf-8","application/json",.F.,.F.)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
release loSbRequestBody
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
return
endif
release loResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": 123456,
// "type": "notebooks",
// "attributes": {
// "cells": [
// {
// "id": "abcd1234",
// "type": "notebook_cells",
// "attributes": {
// "definition": {
// "type": "markdown",
// "text": "# Example Header \nexample content"
// }
// }
// },
// {
// "id": "abcd1234",
// "type": "notebook_cells",
// "attributes": {
// "definition": {
// "type": "markdown",
// "text": "# Example Header \nexample content"
// }
// }
// }
// ],
// "time": {
// "live_span": "1h"
// },
// "name": "Example Notebook",
// "author": {
// "created_at": "1944-02-06T04:58:13.667Z",
// "disabled": false,
// "email": "tempor exercitation",
// "handle": "est eu aliquip officia",
// "icon": "nostrud n",
// "name": "dolor dolor",
// "status": "anim Ut pariatur",
// "title": "eu",
// "verified": true
// },
// "created": "2021-02-24T23:14:15.173964+00:00",
// "metadata": {
// "is_template": false,
// "take_snapshots": false,
// "type": "investigation"
// },
// "modified": "2021-02-24T23:15:23.274966+00:00",
// "status": "published"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnId = loJResp.IntOf("data.id")
lcV_Type = loJResp.StringOf("data.type")
lcLive_span = loJResp.StringOf("data.attributes.time.live_span")
lcName = loJResp.StringOf("data.attributes.name")
lcCreated_at = loJResp.StringOf("data.attributes.author.created_at")
llDisabled = loJResp.BoolOf("data.attributes.author.disabled")
lcV_Email = loJResp.StringOf("data.attributes.author.email")
lcHandle = loJResp.StringOf("data.attributes.author.handle")
lcIcon = loJResp.StringOf("data.attributes.author.icon")
lcAuthorName = loJResp.StringOf("data.attributes.author.name")
lcStatus = loJResp.StringOf("data.attributes.author.status")
lcTitle = loJResp.StringOf("data.attributes.author.title")
llVerified = loJResp.BoolOf("data.attributes.author.verified")
lcCreated = loJResp.StringOf("data.attributes.created")
llIs_template = loJResp.BoolOf("data.attributes.metadata.is_template")
llTake_snapshots = loJResp.BoolOf("data.attributes.metadata.take_snapshots")
lcMetadataType = loJResp.StringOf("data.attributes.metadata.type")
lcModified = loJResp.StringOf("data.attributes.modified")
lcAttributesStatus = loJResp.StringOf("data.attributes.status")
i = 0
lnCount_i = loJResp.SizeOfArray("data.attributes.cells")
do while i < lnCount_i
loJResp.I = i
lcId = loJResp.StringOf("data.attributes.cells[i].id")
lcV_type = loJResp.StringOf("data.attributes.cells[i].type")
lcDefinitionType = loJResp.StringOf("data.attributes.cells[i].attributes.definition.type")
lcText = loJResp.StringOf("data.attributes.cells[i].attributes.definition.text")
i = i + 1
enddo
release loHttp
release loJson
release loSbRequestBody
release loSbResponseBody
release loJResp
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some updated test markdown\n\nWith some example content.",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "bars",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "warm"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"id": "abcd1234",
"type": "notebook_cells"
}
],
"name": "Example Notebook",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}'
https://api.app.ddog-gov.com/api/v1/notebooks/:notebook_id
Postman Collection Item JSON
{
"name": "Update a notebook",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id",
"value": "-62147425"
}
]
},
"description": "Update a notebook using the specified ID."
},
"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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": 123456,\n \"type\": \"notebooks\",\n \"attributes\": {\n \"cells\": [\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n },\n {\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\",\n \"attributes\": {\n \"definition\": {\n \"type\": \"markdown\",\n \"text\": \"# Example Header \\nexample content\"\n }\n }\n }\n ],\n \"time\": {\n \"live_span\": \"1h\"\n },\n \"name\": \"Example Notebook\",\n \"author\": {\n \"created_at\": \"1944-02-06T04:58:13.667Z\",\n \"disabled\": false,\n \"email\": \"tempor exercitation\",\n \"handle\": \"est eu aliquip officia\",\n \"icon\": \"nostrud n\",\n \"name\": \"dolor dolor\",\n \"status\": \"anim Ut pariatur\",\n \"title\": \"eu\",\n \"verified\": true\n },\n \"created\": \"2021-02-24T23:14:15.173964+00:00\",\n \"metadata\": {\n \"is_template\": false,\n \"take_snapshots\": false,\n \"type\": \"investigation\"\n },\n \"modified\": \"2021-02-24T23:15:23.274966+00:00\",\n \"status\": \"published\"\n }\n }\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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"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": "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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"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": "Conflict",
"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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"status": "Conflict",
"code": 409,
"_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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some updated test markdown\\n\\nWith some example content.\",\n \"type\": \"markdown\"\n }\n },\n \"type\": \"notebook_cells\"\n },\n {\n \"attributes\": {\n \"definition\": {\n \"requests\": [\n {\n \"display_type\": \"bars\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"warm\"\n }\n }\n ],\n \"show_legend\": true,\n \"type\": \"timeseries\",\n \"yaxis\": {\n \"scale\": \"linear\"\n }\n },\n \"graph_size\": \"m\",\n \"split_by\": {\n \"keys\": [],\n \"tags\": []\n },\n \"time\": null\n },\n \"id\": \"abcd1234\",\n \"type\": \"notebook_cells\"\n }\n ],\n \"name\": \"Example Notebook\",\n \"time\": {\n \"live_span\": \"1h\"\n }\n },\n \"type\": \"notebooks\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id"
}
]
}
},
"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}"
}
]
}
