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
' 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 test markdown\n\nWith some example content.",
' "type": "markdown"
' }
' },
' "type": "notebook_cells"
' },
' {
' "attributes": {
' "definition": {
' "requests": [
' {
' "display_type": "line",
' "q": "avg:system.load.1{*}",
' "style": {
' "line_type": "solid",
' "line_width": "normal",
' "palette": "dog_classic"
' }
' }
' ],
' "show_legend": true,
' "type": "timeseries",
' "yaxis": {
' "scale": "linear"
' }
' },
' "graph_size": "m",
' "split_by": {
' "keys": [
' ],
' "tags": [
' ]
' },
' "time": null
' },
' "type": "notebook_cells"
' }
' ],
' "name": "Example Notebook",
' "time": {
' "live_span": "1h"
' }
' },
' "type": "notebooks"
' }
' }
Dim json As New ChilkatJsonObject
success = json.UpdateString("data.attributes.cells[0].attributes.definition.text","## Some test markdown" & vbLf & vbLf & "With some example content.")
success = json.UpdateString("data.attributes.cells[0].attributes.definition.type","markdown")
success = json.UpdateString("data.attributes.cells[0].type","notebook_cells")
success = json.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].display_type","line")
success = json.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].q","avg:system.load.1{*}")
success = json.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].style.line_type","solid")
success = json.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].style.line_width","normal")
success = json.UpdateString("data.attributes.cells[1].attributes.definition.requests[0].style.palette","dog_classic")
success = json.UpdateBool("data.attributes.cells[1].attributes.definition.show_legend",1)
success = json.UpdateString("data.attributes.cells[1].attributes.definition.type","timeseries")
success = json.UpdateString("data.attributes.cells[1].attributes.definition.yaxis.scale","linear")
success = json.UpdateString("data.attributes.cells[1].attributes.graph_size","m")
success = json.UpdateNewArray("data.attributes.cells[1].attributes.split_by.keys")
success = json.UpdateNewArray("data.attributes.cells[1].attributes.split_by.tags")
success = json.UpdateNull("data.attributes.cells[1].attributes.time")
success = json.UpdateString("data.attributes.cells[1].type","notebook_cells")
success = json.UpdateString("data.attributes.name","Example Notebook")
success = json.UpdateString("data.attributes.time.live_span","1h")
success = json.UpdateString("data.type","notebooks")
http.SetRequestHeader "Content-Type","application/json"
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.PostJson3("https://api.app.ddog-gov.com/api/v1/notebooks","application/json",json)
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": {
' "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
Dim id As String
Dim v_type As String
Dim DefinitionType As String
Dim Text As String
Dim Id As Long
Id = jResp.IntOf("data.id")
Dim v_Type As String
v_Type = jResp.StringOf("data.type")
Dim Live_span As String
Live_span = jResp.StringOf("data.attributes.time.live_span")
Dim Name As String
Name = jResp.StringOf("data.attributes.name")
Dim Created_at As String
Created_at = jResp.StringOf("data.attributes.author.created_at")
Dim Disabled As Long
Disabled = jResp.BoolOf("data.attributes.author.disabled")
Dim v_Email As String
v_Email = jResp.StringOf("data.attributes.author.email")
Dim Handle As String
Handle = jResp.StringOf("data.attributes.author.handle")
Dim Icon As String
Icon = jResp.StringOf("data.attributes.author.icon")
Dim AuthorName As String
AuthorName = jResp.StringOf("data.attributes.author.name")
Dim Status As String
Status = jResp.StringOf("data.attributes.author.status")
Dim Title As String
Title = jResp.StringOf("data.attributes.author.title")
Dim Verified As Long
Verified = jResp.BoolOf("data.attributes.author.verified")
Dim Created As String
Created = jResp.StringOf("data.attributes.created")
Dim Is_template As Long
Is_template = jResp.BoolOf("data.attributes.metadata.is_template")
Dim Take_snapshots As Long
Take_snapshots = jResp.BoolOf("data.attributes.metadata.take_snapshots")
Dim MetadataType As String
MetadataType = jResp.StringOf("data.attributes.metadata.type")
Dim Modified As String
Modified = jResp.StringOf("data.attributes.modified")
Dim AttributesStatus As String
AttributesStatus = jResp.StringOf("data.attributes.status")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("data.attributes.cells")
Do While i < count_i
jResp.I = i
id = jResp.StringOf("data.attributes.cells[i].id")
v_type = jResp.StringOf("data.attributes.cells[i].type")
DefinitionType = jResp.StringOf("data.attributes.cells[i].attributes.definition.type")
Text = jResp.StringOf("data.attributes.cells[i].attributes.definition.text")
i = i + 1
Loop
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"attributes": {
"cells": [
{
"attributes": {
"definition": {
"text": "## Some test markdown\n\nWith some example content.",
"type": "markdown"
}
},
"type": "notebook_cells"
},
{
"attributes": {
"definition": {
"requests": [
{
"display_type": "line",
"q": "avg:system.load.1{*}",
"style": {
"line_type": "solid",
"line_width": "normal",
"palette": "dog_classic"
}
}
],
"show_legend": true,
"type": "timeseries",
"yaxis": {
"scale": "linear"
}
},
"graph_size": "m",
"split_by": {
"keys": [],
"tags": []
},
"time": null
},
"type": "notebook_cells"
}
],
"name": "Example Notebook",
"time": {
"live_span": "1h"
}
},
"type": "notebooks"
}
}'
https://api.app.ddog-gov.com/api/v1/notebooks
Postman Collection Item JSON
{
"name": "Create a notebook",
"request": {
"method": "POST",
"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 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\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
},
"description": "Create a notebook using the specified options."
},
"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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some 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\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"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": "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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some 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\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"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": "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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some 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\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"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": "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 \"data\": {\n \"attributes\": {\n \"cells\": [\n {\n \"attributes\": {\n \"definition\": {\n \"text\": \"## Some 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\": \"line\",\n \"q\": \"avg:system.load.1{*}\",\n \"style\": {\n \"line_type\": \"solid\",\n \"line_width\": \"normal\",\n \"palette\": \"dog_classic\"\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 \"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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks"
]
}
},
"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}"
}
]
}
