Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sDescription
String sIntegration
String sPer_unit
String sShort_name
Integer iStatsd_interval
String sV_type
String sUnit
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "description": "exercitation ea ullamco occaecat",
// "integration": "nulla aute in",
// "per_unit": "second",
// "short_name": "exercitation et proident do",
// "statsd_interval": 33065337,
// "type": "count",
// "unit": "byte"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "description" "exercitation ea ullamco occaecat" To iSuccess
Get ComUpdateString Of hoJson "integration" "nulla aute in" To iSuccess
Get ComUpdateString Of hoJson "per_unit" "second" To iSuccess
Get ComUpdateString Of hoJson "short_name" "exercitation et proident do" To iSuccess
Get ComUpdateInt Of hoJson "statsd_interval" 33065337 To iSuccess
Get ComUpdateString Of hoJson "type" "count" To iSuccess
Get ComUpdateString Of hoJson "unit" "byte" To iSuccess
Send ComSetRequestHeader To hoHttp "Content-Type" "application/json"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get pvComObject of hoResp to vResp
Get ComHttpSb Of hoHttp "PUT" "https://api.app.ddog-gov.com/api/v1/metrics/:metric_name" vSbRequestBody "utf-8" "application/json" vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "description": "exercitation ea ullamco occaecat",
// "integration": "nulla aute in",
// "per_unit": "second",
// "short_name": "exercitation et proident do",
// "statsd_interval": 33065337,
// "type": "count",
// "unit": "byte"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComStringOf Of hoJResp "description" To sDescription
Get ComStringOf Of hoJResp "integration" To sIntegration
Get ComStringOf Of hoJResp "per_unit" To sPer_unit
Get ComStringOf Of hoJResp "short_name" To sShort_name
Get ComIntOf Of hoJResp "statsd_interval" To iStatsd_interval
Get ComStringOf Of hoJResp "type" To sV_type
Get ComStringOf Of hoJResp "unit" To sUnit
End_Procedure
Curl Command
curl -X PUT
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"description": "exercitation ea ullamco occaecat",
"integration": "nulla aute in",
"per_unit": "second",
"short_name": "exercitation et proident do",
"statsd_interval": 33065337,
"type": "count",
"unit": "byte"
}'
https://api.app.ddog-gov.com/api/v1/metrics/:metric_name
Postman Collection Item JSON
{
"name": "Edit metric metadata",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name",
"value": "tempor Ut sed velit"
}
]
},
"description": "Edit metadata of a specific metric. Find out more about [supported types](https://docs.datadoghq.com/developers/metrics)."
},
"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 \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\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 \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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": "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 \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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 \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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 \"description\": \"exercitation ea ullamco occaecat\",\n \"integration\": \"nulla aute in\",\n \"per_unit\": \"second\",\n \"short_name\": \"exercitation et proident do\",\n \"statsd_interval\": 33065337,\n \"type\": \"count\",\n \"unit\": \"byte\"\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v1/metrics/:metric_name",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v1",
"metrics",
":metric_name"
],
"variable": [
{
"key": "metric_name"
}
]
}
},
"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}"
}
]
}
