Chilkat Online Tools

lianja / Squadcast API V3 / Get Tagging Rules

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loHttp.SetRequestHeader("Authorization","")

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.squadcast.com/v3/services/:serviceID/tagging-rules",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
endif

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "data": {
//     "id": "5d89e22915e52fa3f8620d37",
//     "created_at": "2019-09-24T09:30:17.463Z",
//     "updated_at": "2019-09-24T09:30:17.463Z",
//     "deleted_at": null,
//     "service_id": "5d81d9687000fb6b9def7e35",
//     "organization_id": "5d81d9187000fb6b9def7e32",
//     "rules": [
//       {
//         "expression": "re(current.labels.alertname, \"^CPUThrottlingHigh.*\") && re(past.labels.alertname, \"^CPUThrottlingHigh.*\")",
//         "tags": {
//           "foo": "bar",
//           "severity": "asa",
//           "tag2": "as"
//         }
//       }
//     ]
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcId = loJResp.StringOf("data.id")
lcCreated_at = loJResp.StringOf("data.created_at")
lcUpdated_at = loJResp.StringOf("data.updated_at")
lcDeleted_at = loJResp.StringOf("data.deleted_at")
lcService_id = loJResp.StringOf("data.service_id")
lcOrganization_id = loJResp.StringOf("data.organization_id")
i = 0
lnCount_i = loJResp.SizeOfArray("data.rules")
do while i < lnCount_i
    loJResp.I = i
    lcExpression = loJResp.StringOf("data.rules[i].expression")
    lcFoo = loJResp.StringOf("data.rules[i].tags.foo")
    lcSeverity = loJResp.StringOf("data.rules[i].tags.severity")
    lcTag2 = loJResp.StringOf("data.rules[i].tags.tag2")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-H "Authorization: "
https://api.squadcast.com/v3/services/:serviceID/tagging-rules

Postman Collection Item JSON

{
  "name": "Get Tagging Rules",
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": ""
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services",
        ":serviceID",
        "tagging-rules"
      ],
      "variable": [
        {
          "key": "serviceID",
          "value": "<string>",
          "type": "string",
          "description": "(Required) service id"
        }
      ]
    },
    "description": "This endpoint returns the default tagging rules for the service if not already created.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope."
  },
  "response": [
    {
      "name": "OK",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": {\n  \"id\": \"5d89e22915e52fa3f8620d37\",\n  \"created_at\": \"2019-09-24T09:30:17.463Z\",\n  \"updated_at\": \"2019-09-24T09:30:17.463Z\",\n  \"deleted_at\": null,\n  \"service_id\": \"5d81d9687000fb6b9def7e35\",\n  \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n  \"rules\": [\n   {\n    \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n    \"tags\": {\n     \"foo\": \"bar\",\n     \"severity\": \"asa\",\n     \"tag2\": \"as\"\n    }\n   }\n  ]\n }\n}"
    }
  ]
}