Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("schema_version","v1")
$oHttp.SetRequestHeader "Accept","application/json"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.app.ddog-gov.com/api/v2/services/definitions/:service_name",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "attributes": {
; "meta": {
; "github-html-url": "<string>",
; "ingested-schema-version": "<string>",
; "ingestion-source": "<string>",
; "last-modified-time": "<string>",
; "origin": "<string>",
; "origin-detail": "<string>",
; "warnings": [
; {
; "instance-location": "<string>",
; "keyword-location": "<string>",
; "message": "<string>"
; },
; {
; "instance-location": "<string>",
; "keyword-location": "<string>",
; "message": "<string>"
; }
; ]
; },
; "schema": {
; "schema-version": "v1",
; "info": {
; "dd-service": "<string>",
; "description": "<string>",
; "display-name": "<string>",
; "service-tier": "<string>"
; },
; "contact": {
; "email": "<email>",
; "slack": "<string>"
; },
; "extensions": {
; "iruree76": {},
; "aliqua_0": {},
; "ad_3": {}
; },
; "external-resources": [
; {
; "name": "<string>",
; "type": "code",
; "url": "<string>"
; },
; {
; "name": "<string>",
; "type": "repo",
; "url": "<string>"
; }
; ],
; "integrations": {
; "pagerduty": "<string>"
; },
; "org": {
; "application": "<string>",
; "team": "<string>"
; },
; "tags": [
; "<string>",
; "<string>"
; ]
; }
; },
; "id": "<string>",
; "type": "<string>"
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sInstance_location
Local $sKeyword_location
Local $sMessage
Local $sName
Local $sV_type
Local $sUrl
Local $strVal
Local $sGithub_html_url = $oJResp.StringOf("data.attributes.meta.github-html-url")
Local $sIngested_schema_version = $oJResp.StringOf("data.attributes.meta.ingested-schema-version")
Local $sIngestion_source = $oJResp.StringOf("data.attributes.meta.ingestion-source")
Local $sLast_modified_time = $oJResp.StringOf("data.attributes.meta.last-modified-time")
Local $sOrigin = $oJResp.StringOf("data.attributes.meta.origin")
Local $sOrigin_detail = $oJResp.StringOf("data.attributes.meta.origin-detail")
Local $sSchema_version = $oJResp.StringOf("data.attributes.schema.schema-version")
Local $sDd_service = $oJResp.StringOf("data.attributes.schema.info.dd-service")
Local $sDescription = $oJResp.StringOf("data.attributes.schema.info.description")
Local $sDisplay_name = $oJResp.StringOf("data.attributes.schema.info.display-name")
Local $sService_tier = $oJResp.StringOf("data.attributes.schema.info.service-tier")
Local $sV_Email = $oJResp.StringOf("data.attributes.schema.contact.email")
Local $sSlack = $oJResp.StringOf("data.attributes.schema.contact.slack")
Local $sPagerduty = $oJResp.StringOf("data.attributes.schema.integrations.pagerduty")
Local $sApplication = $oJResp.StringOf("data.attributes.schema.org.application")
Local $sTeam = $oJResp.StringOf("data.attributes.schema.org.team")
Local $sId = $oJResp.StringOf("data.id")
Local $sV_Type = $oJResp.StringOf("data.type")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.attributes.meta.warnings")
While $i < $iCount_i
$oJResp.I = $i
$sInstance_location = $oJResp.StringOf("data.attributes.meta.warnings[i].instance-location")
$sKeyword_location = $oJResp.StringOf("data.attributes.meta.warnings[i].keyword-location")
$sMessage = $oJResp.StringOf("data.attributes.meta.warnings[i].message")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("data.attributes.schema.external-resources")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("data.attributes.schema.external-resources[i].name")
$sV_type = $oJResp.StringOf("data.attributes.schema.external-resources[i].type")
$sUrl = $oJResp.StringOf("data.attributes.schema.external-resources[i].url")
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("data.attributes.schema.tags")
While $i < $iCount_i
$oJResp.I = $i
$strVal = $oJResp.StringOf("data.attributes.schema.tags[i]")
$i = $i + 1
Wend
Curl Command
curl -G -d "schema_version=v1"
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/services/definitions/:service_name
Postman Collection Item JSON
{
"name": "Get a single service definition",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name",
"value": "<string>"
}
]
},
"description": "Get a single service definition from the Datadog Service Catalog."
},
"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/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"meta\": {\n \"github-html-url\": \"<string>\",\n \"ingested-schema-version\": \"<string>\",\n \"ingestion-source\": \"<string>\",\n \"last-modified-time\": \"<string>\",\n \"origin\": \"<string>\",\n \"origin-detail\": \"<string>\",\n \"warnings\": [\n {\n \"instance-location\": \"<string>\",\n \"keyword-location\": \"<string>\",\n \"message\": \"<string>\"\n },\n {\n \"instance-location\": \"<string>\",\n \"keyword-location\": \"<string>\",\n \"message\": \"<string>\"\n }\n ]\n },\n \"schema\": {\n \"schema-version\": \"v1\",\n \"info\": {\n \"dd-service\": \"<string>\",\n \"description\": \"<string>\",\n \"display-name\": \"<string>\",\n \"service-tier\": \"<string>\"\n },\n \"contact\": {\n \"email\": \"<email>\",\n \"slack\": \"<string>\"\n },\n \"extensions\": {\n \"iruree76\": {},\n \"aliqua_0\": {},\n \"ad_3\": {}\n },\n \"external-resources\": [\n {\n \"name\": \"<string>\",\n \"type\": \"code\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"type\": \"repo\",\n \"url\": \"<string>\"\n }\n ],\n \"integrations\": {\n \"pagerduty\": \"<string>\"\n },\n \"org\": {\n \"application\": \"<string>\",\n \"team\": \"<string>\"\n },\n \"tags\": [\n \"<string>\",\n \"<string>\"\n ]\n }\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\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/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Forbidden",
"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/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Conflict",
"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/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Conflict",
"code": 409,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\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/v2/services/definitions/:service_name?schema_version=v1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"services",
"definitions",
":service_name"
],
"query": [
{
"key": "schema_version",
"value": "v1",
"description": "The schema version desired in the response."
}
],
"variable": [
{
"key": "service_name"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
