Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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": {
; "type": "correction",
; "attributes": {
; "slo_id": "sloId",
; "start": 1600000000,
; "category": "Scheduled Maintenance",
; "description": "reprehend",
; "duration": 1600000000,
; "end": 1600000000,
; "rrule": "FREQ=DAILY;INTERVAL=10;COUNT=5",
; "timezone": "UTC"
; }
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"data.type","correction")
CkJsonObject::ckUpdateString(json,"data.attributes.slo_id","sloId")
CkJsonObject::ckUpdateInt(json,"data.attributes.start",1600000000)
CkJsonObject::ckUpdateString(json,"data.attributes.category","Scheduled Maintenance")
CkJsonObject::ckUpdateString(json,"data.attributes.description","reprehend")
CkJsonObject::ckUpdateInt(json,"data.attributes.duration",1600000000)
CkJsonObject::ckUpdateInt(json,"data.attributes.end",1600000000)
CkJsonObject::ckUpdateString(json,"data.attributes.rrule","FREQ=DAILY;INTERVAL=10;COUNT=5")
CkJsonObject::ckUpdateString(json,"data.attributes.timezone","UTC")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.app.ddog-gov.com/api/v1/slo/correction","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "attributes": {
; "category": "Scheduled Maintenance",
; "created_at": 11806311,
; "creator": {
; "email": "dolor nisi",
; "handle": "la",
; "name": "in quis est cillum"
; },
; "description": "nostrud amet ea exercitation",
; "duration": 3600,
; "end": 30790629,
; "modified_at": 77538107,
; "modifier": {
; "email": "pariatur nisi minim reprehenderit",
; "handle": "irure commodo",
; "name": "veniam"
; },
; "rrule": "FREQ=DAILY;INTERVAL=10;COUNT=5",
; "slo_id": "incididunt qui velit sunt labore",
; "start": -34398281,
; "timezone": "eu id"
; },
; "id": "enim qui",
; "type": "correction"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Category.s = CkJsonObject::ckStringOf(jResp,"data.attributes.category")
Created_at.i = CkJsonObject::ckIntOf(jResp,"data.attributes.created_at")
v_Email.s = CkJsonObject::ckStringOf(jResp,"data.attributes.creator.email")
Handle.s = CkJsonObject::ckStringOf(jResp,"data.attributes.creator.handle")
Name.s = CkJsonObject::ckStringOf(jResp,"data.attributes.creator.name")
Description.s = CkJsonObject::ckStringOf(jResp,"data.attributes.description")
Duration.i = CkJsonObject::ckIntOf(jResp,"data.attributes.duration")
v_End.i = CkJsonObject::ckIntOf(jResp,"data.attributes.end")
Modified_at.i = CkJsonObject::ckIntOf(jResp,"data.attributes.modified_at")
ModifierEmail.s = CkJsonObject::ckStringOf(jResp,"data.attributes.modifier.email")
ModifierHandle.s = CkJsonObject::ckStringOf(jResp,"data.attributes.modifier.handle")
ModifierName.s = CkJsonObject::ckStringOf(jResp,"data.attributes.modifier.name")
Rrule.s = CkJsonObject::ckStringOf(jResp,"data.attributes.rrule")
Slo_id.s = CkJsonObject::ckStringOf(jResp,"data.attributes.slo_id")
Start.i = CkJsonObject::ckIntOf(jResp,"data.attributes.start")
Timezone.s = CkJsonObject::ckStringOf(jResp,"data.attributes.timezone")
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
v_Type.s = CkJsonObject::ckStringOf(jResp,"data.type")
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"data": {
"type": "correction",
"attributes": {
"slo_id": "sloId",
"start": 1600000000,
"category": "Scheduled Maintenance",
"description": "reprehend",
"duration": 1600000000,
"end": 1600000000,
"rrule": "FREQ=DAILY;INTERVAL=10;COUNT=5",
"timezone": "UTC"
}
}
}'
https://api.app.ddog-gov.com/api/v1/slo/correction
Postman Collection Item JSON
{
"name": "Create an SLO correction",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"reprehend\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
},
"description": "Create an SLO Correction."
},
"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 \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"reprehend\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"category\": \"Scheduled Maintenance\",\n \"created_at\": 11806311,\n \"creator\": {\n \"email\": \"dolor nisi\",\n \"handle\": \"la\",\n \"name\": \"in quis est cillum\"\n },\n \"description\": \"nostrud amet ea exercitation\",\n \"duration\": 3600,\n \"end\": 30790629,\n \"modified_at\": 77538107,\n \"modifier\": {\n \"email\": \"pariatur nisi minim reprehenderit\",\n \"handle\": \"irure commodo\",\n \"name\": \"veniam\"\n },\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"slo_id\": \"incididunt qui velit sunt labore\",\n \"start\": -34398281,\n \"timezone\": \"eu id\"\n },\n \"id\": \"enim qui\",\n \"type\": \"correction\"\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 \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"reprehend\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"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": "Forbidden",
"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 \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"reprehend\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"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": "SLO Not Found",
"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 \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"reprehend\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"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": "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 \"type\": \"correction\",\n \"attributes\": {\n \"slo_id\": \"sloId\",\n \"start\": 1600000000,\n \"category\": \"Scheduled Maintenance\",\n \"description\": \"reprehend\",\n \"duration\": 1600000000,\n \"end\": 1600000000,\n \"rrule\": \"FREQ=DAILY;INTERVAL=10;COUNT=5\",\n \"timezone\": \"UTC\"\n }\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/slo/correction",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"slo",
"correction"
]
}
},
"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}"
}
]
}