Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcV_type
LOCAL lcDefinitionType
LOCAL lcText
LOCAL lnId
LOCAL lcV_Type
LOCAL lcLive_span
LOCAL lcName
LOCAL lcCreated_at
LOCAL lnDisabled
LOCAL lcV_Email
LOCAL lcHandle
LOCAL lcIcon
LOCAL lcAuthorName
LOCAL lcStatus
LOCAL lcTitle
LOCAL lnVerified
LOCAL lcCreated
LOCAL lnIs_template
LOCAL lnTake_snapshots
LOCAL lcMetadataType
LOCAL lcModified
LOCAL lcAttributesStatus
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v1/notebooks/:notebook_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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")
lnDisabled = 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")
lnVerified = loJResp.BoolOf("data.attributes.author.verified")
lcCreated = loJResp.StringOf("data.attributes.created")
lnIs_template = loJResp.BoolOf("data.attributes.metadata.is_template")
lnTake_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 loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v1/notebooks/:notebook_id
Postman Collection Item JSON
{
"name": "Get a notebook",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v1/notebooks/:notebook_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"notebooks",
":notebook_id"
],
"variable": [
{
"key": "notebook_id",
"value": "-62147425"
}
]
},
"description": "Get a notebook using the specified notebook 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/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": "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/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": "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/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": "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/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": "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/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}"
}
]
}
