PureBasic / Squadcast API V3 / Get suppression rules
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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
; Adds the "Authorization: Bearer <access_token>" header.
CkHttp::setCkAuthToken(http, "<access_token>")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://api.squadcast.com/v3/services/:serviceID/suppression-rules",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
description.s
expression.s
is_basic.i
Id.s = CkJsonObject::ckStringOf(jResp,"data.id")
Created_at.s = CkJsonObject::ckStringOf(jResp,"data.created_at")
Updated_at.s = CkJsonObject::ckStringOf(jResp,"data.updated_at")
Service_id.s = CkJsonObject::ckStringOf(jResp,"data.service_id")
Organization_id.s = CkJsonObject::ckStringOf(jResp,"data.organization_id")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"data.rules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
description = CkJsonObject::ckStringOf(jResp,"data.rules[i].description")
expression = CkJsonObject::ckStringOf(jResp,"data.rules[i].expression")
is_basic = CkJsonObject::ckBoolOf(jResp,"data.rules[i].is_basic")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}