phpAx / Squadcast API V3 / Create or Update Routing Rules
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");
// 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>"
// }
// }
// ]
// }
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('rules[0].expression','<string>');
$json->UpdateString('rules[0].route_to.entity_type','<string>');
$json->UpdateString('rules[0].route_to.entity_id','<string>');
$json->UpdateString('rules[1].expression','<string>');
$json->UpdateString('rules[1].route_to.entity_type','<string>');
$json->UpdateString('rules[1].route_to.entity_id','<string>');
$http->SetRequestHeader('Authorization','');
$http->SetRequestHeader('Content-Type','application/json');
// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://api.squadcast.com/v3/services/:serviceID/routing-rules','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$Id = $jResp->stringOf('data.id');
$Created_at = $jResp->stringOf('data.created_at');
$Updated_at = $jResp->stringOf('data.updated_at');
$Deleted_at = $jResp->stringOf('data.deleted_at');
$Service_id = $jResp->stringOf('data.service_id');
$Organization_id = $jResp->stringOf('data.organization_id');
$i = 0;
$count_i = $jResp->SizeOfArray('data.rules');
while ($i < $count_i) {
$jResp->I = $i;
$expression = $jResp->stringOf('data.rules[i].expression');
$Entity_type = $jResp->stringOf('data.rules[i].route_to.entity_type');
$Entity_id = $jResp->stringOf('data.rules[i].route_to.entity_id');
$i = $i + 1;
}
?>
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}"
}
]
}
