Chilkat Online Tools

autoit / Squadcast API V3 / Get suppression rules

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

; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.squadcast.com/v3/services/:serviceID/suppression-rules",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

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

; {
;   "data": {
;     "id": "5fa50748a2e7e47f1436c0fc",
;     "created_at": "2020-11-06T08:20:24.756Z",
;     "updated_at": "2020-11-11T09:28:19.972Z",
;     "service_id": "5f8ed89e39e4a959da360537",
;     "organization_id": "5db92749f8d4da1473169533",
;     "rules": [
;       {
;         "description": "Suppress low latency alerts",
;         "expression": "re(payload.policy_name, \"low latency\")",
;         "is_basic": false
;       }
;     ]
;   }
; }

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

Local $sDescription
Local $sExpression
Local $bIs_basic

Local $sId = $oJResp.StringOf("data.id")
Local $sCreated_at = $oJResp.StringOf("data.created_at")
Local $sUpdated_at = $oJResp.StringOf("data.updated_at")
Local $sService_id = $oJResp.StringOf("data.service_id")
Local $sOrganization_id = $oJResp.StringOf("data.organization_id")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data.rules")
While $i < $iCount_i
    $oJResp.I = $i
    $sDescription = $oJResp.StringOf("data.rules[i].description")
    $sExpression = $oJResp.StringOf("data.rules[i].expression")
    $bIs_basic = $oJResp.BoolOf("data.rules[i].is_basic")
    $i = $i + 1
Wend

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.squadcast.com/v3/services/:serviceID/suppression-rules

Postman Collection Item JSON

{
  "name": "Get suppression rules",
  "request": {
    "auth": {
      "type": "bearer",
      "bearer": [
        {
          "key": "token",
          "value": "{{sq_pb_auth_header}}",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/services/:serviceID/suppression-rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services",
        ":serviceID",
        "suppression-rules"
      ],
      "variable": [
        {
          "key": "serviceID",
          "value": "5c7cf71ad517f500100b37d6",
          "type": "string"
        }
      ]
    },
    "description": "This endpoint returns the default suppression rules for the service if not already created. Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `read` scope."
  },
  "response": [
    {
      "name": "200 - suppression rules",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/suppression-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "suppression-rules"
          ],
          "variable": [
            {
              "key": "serviceID",
              "value": ""
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "Date",
          "value": "Fri, 18 Sep 2020 06:21:12 GMT"
        },
        {
          "key": "Content-Length",
          "value": "63"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"data\": {\n        \"id\": \"5fa50748a2e7e47f1436c0fc\",\n        \"created_at\": \"2020-11-06T08:20:24.756Z\",\n        \"updated_at\": \"2020-11-11T09:28:19.972Z\",\n        \"service_id\": \"5f8ed89e39e4a959da360537\",\n        \"organization_id\": \"5db92749f8d4da1473169533\",\n        \"rules\": [\n            {\n                \"description\": \"Suppress low latency alerts\",\n                \"expression\": \"re(payload.policy_name, \\\"low latency\\\")\",\n                \"is_basic\": false\n            }\n        ]\n    }\n}"
    }
  ]
}