SQL Server / Squadcast API V3 / Get suppression rules
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.squadcast.com/v3/services/:serviceID/suppression-rules', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @description nvarchar(4000)
DECLARE @expression nvarchar(4000)
DECLARE @is_basic int
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'data.id'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'data.created_at'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'data.updated_at'
DECLARE @Service_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Service_id OUT, 'data.service_id'
DECLARE @Organization_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Organization_id OUT, 'data.organization_id'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'data.rules'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @description OUT, 'data.rules[i].description'
EXEC sp_OAMethod @jResp, 'StringOf', @expression OUT, 'data.rules[i].expression'
EXEC sp_OAMethod @jResp, 'BoolOf', @is_basic OUT, 'data.rules[i].is_basic'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
