PureBasic / Squadcast API V3 / Create or Update Routing Rules
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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
; Use this online tool to generate code from sample JSON: Generate Code to Create JSON
; The following JSON is sent in the request body.
; {
; "rules": [
; {
; "expression": "<string>",
; "route_to": {
; "entity_type": "<string>",
; "entity_id": "<string>"
; }
; },
; {
; "expression": "<string>",
; "route_to": {
; "entity_type": "<string>",
; "entity_id": "<string>"
; }
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"rules[0].expression","<string>")
CkJsonObject::ckUpdateString(json,"rules[0].route_to.entity_type","<string>")
CkJsonObject::ckUpdateString(json,"rules[0].route_to.entity_id","<string>")
CkJsonObject::ckUpdateString(json,"rules[1].expression","<string>")
CkJsonObject::ckUpdateString(json,"rules[1].route_to.entity_type","<string>")
CkJsonObject::ckUpdateString(json,"rules[1].route_to.entity_id","<string>")
CkHttp::ckSetRequestHeader(http,"Authorization","")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.squadcast.com/v3/services/:serviceID/routing-rules","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "data": {
; "id": "5d8b23427c870edd41453c25",
; "created_at": "2019-09-25T08:20:18.884Z",
; "updated_at": "2019-09-25T08:20:18.884Z",
; "deleted_at": null,
; "service_id": "5d81d9687000fb6b9def7e35",
; "organization_id": "5d81d9187000fb6b9def7e32",
; "rules": [
; {
; "expression": "re(current.labels.alertname, \"^CPUThrottlingHigh.*\") && re(past.labels.alertname, \"^CPUThrottlingHigh.*\")",
; "route_to": {
; "entity_type": "escalationpolicy",
; "entity_id": "5d81d9407000fb6b9def7e33"
; }
; },
; {
; "expression": "re(current.labels.alertname, \"^CPUThrottlingHigh.*\") && re(past.labels.alertname, \"^CPUThrottlingHigh.*\")",
; "route_to": {
; "entity_type": "squad",
; "entity_id": "5d8b5976578cc3b845cb3608"
; }
; },
; {
; "expression": "re(current.labels.alertname, \"^CPUThrottlingHigh.*\") && re(past.labels.alertname, \"^CPUThrottlingHigh.*\")",
; "route_to": {
; "entity_type": "user",
; "entity_id": "5d81d9187000fb6b9def7e31"
; }
; }
; ]
; }
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
expression.s
Entity_type.s
Entity_id.s
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")
Deleted_at.s = CkJsonObject::ckStringOf(jResp,"data.deleted_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)
expression = CkJsonObject::ckStringOf(jResp,"data.rules[i].expression")
Entity_type = CkJsonObject::ckStringOf(jResp,"data.rules[i].route_to.entity_type")
Entity_id = CkJsonObject::ckStringOf(jResp,"data.rules[i].route_to.entity_id")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -X POST
-H "Authorization: "
-H "Content-Type: application/json"
-d '{
"rules": [
{
"expression": "<string>",
"route_to": {
"entity_type": "<string>",
"entity_id": "<string>"
}
},
{
"expression": "<string>",
"route_to": {
"entity_type": "<string>",
"entity_id": "<string>"
}
}
]
}'
https://api.squadcast.com/v3/services/:serviceID/routing-rules
Postman Collection Item JSON
{
"name": "Create or Update Routing Rules",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"rules\": [\n {\n \"expression\": \"<string>\",\n \"route_to\": {\n \"entity_type\": \"<string>\",\n \"entity_id\": \"<string>\"\n }\n },\n {\n \"expression\": \"<string>\",\n \"route_to\": {\n \"entity_type\": \"<string>\",\n \"entity_id\": \"<string>\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/services/:serviceID/routing-rules",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID",
"routing-rules"
],
"variable": [
{
"key": "serviceID",
"value": "<string>",
"type": "string",
"description": "(Required) "
}
]
},
"description": "This endpoint creates or updates the routing rules for the given service.\nIf default rules not found it creates otherwise it updates the new rules.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `write` scope."
},
"response": [
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"rules\": [\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"escalationpolicy\",\n \"entity_id\": \"5d81d9407000fb6b9def7e33\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"squad\",\n \"entity_id\": \"5d8b5976578cc3b845cb3608\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"user\",\n \"entity_id\": \"5d81d9187000fb6b9def7e31\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/services/:serviceID/routing-rules",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID",
"routing-rules"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Created",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"rules\": [\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"escalationpolicy\",\n \"entity_id\": \"5d81d9407000fb6b9def7e33\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"squad\",\n \"entity_id\": \"5d8b5976578cc3b845cb3608\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"user\",\n \"entity_id\": \"5d81d9187000fb6b9def7e31\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/services/:serviceID/routing-rules",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID",
"routing-rules"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5d8b23427c870edd41453c25\",\n \"created_at\": \"2019-09-25T08:20:18.884Z\",\n \"updated_at\": \"2019-09-25T08:20:18.884Z\",\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 \"route_to\": {\n \"entity_type\": \"escalationpolicy\",\n \"entity_id\": \"5d81d9407000fb6b9def7e33\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"squad\",\n \"entity_id\": \"5d8b5976578cc3b845cb3608\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"user\",\n \"entity_id\": \"5d81d9187000fb6b9def7e31\"\n }\n }\n ]\n }\n}"
},
{
"name": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"rules\": [\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"escalationpolicy\",\n \"entity_id\": \"5d81d9407000fb6b9def7e33\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"squad\",\n \"entity_id\": \"5d8b5976578cc3b845cb3608\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"user\",\n \"entity_id\": \"5d81d9187000fb6b9def7e31\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/services/:serviceID/routing-rules",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID",
"routing-rules"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"rules\": [\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"escalationpolicy\",\n \"entity_id\": \"5d81d9407000fb6b9def7e33\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"squad\",\n \"entity_id\": \"5d8b5976578cc3b845cb3608\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"user\",\n \"entity_id\": \"5d81d9187000fb6b9def7e31\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/services/:serviceID/routing-rules",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID",
"routing-rules"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"rules\": [\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"escalationpolicy\",\n \"entity_id\": \"5d81d9407000fb6b9def7e33\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"squad\",\n \"entity_id\": \"5d8b5976578cc3b845cb3608\"\n }\n },\n {\n \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n \"route_to\": {\n \"entity_type\": \"user\",\n \"entity_id\": \"5d81d9187000fb6b9def7e31\"\n }\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/services/:serviceID/routing-rules",
"host": [
"{{baseUrl}}"
],
"path": [
"services",
":serviceID",
"routing-rules"
],
"variable": [
{
"key": "serviceID"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"meta\": {\n \"status\": \"<integer>\",\n \"error_message\": \"<string>\"\n }\n}"
}
]
}
