delphiDll / Squadcast API V3 / Create or Update Routing Rules
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
expression: PWideChar;
Entity_type: PWideChar;
Entity_id: PWideChar;
Id: PWideChar;
Created_at: PWideChar;
Updated_at: PWideChar;
Deleted_at: PWideChar;
Service_id: PWideChar;
Organization_id: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// 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 := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'rules[0].expression','<string>');
CkJsonObject_UpdateString(json,'rules[0].route_to.entity_type','<string>');
CkJsonObject_UpdateString(json,'rules[0].route_to.entity_id','<string>');
CkJsonObject_UpdateString(json,'rules[1].expression','<string>');
CkJsonObject_UpdateString(json,'rules[1].route_to.entity_type','<string>');
CkJsonObject_UpdateString(json,'rules[1].route_to.entity_id','<string>');
CkHttp_SetRequestHeader(http,'Authorization','');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
resp := CkHttp_PostJson3(http,'https://api.squadcast.com/v3/services/:serviceID/routing-rules','application/json',json);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(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
Id := CkJsonObject__stringOf(jResp,'data.id');
Created_at := CkJsonObject__stringOf(jResp,'data.created_at');
Updated_at := CkJsonObject__stringOf(jResp,'data.updated_at');
Deleted_at := CkJsonObject__stringOf(jResp,'data.deleted_at');
Service_id := CkJsonObject__stringOf(jResp,'data.service_id');
Organization_id := CkJsonObject__stringOf(jResp,'data.organization_id');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'data.rules');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
expression := CkJsonObject__stringOf(jResp,'data.rules[i].expression');
Entity_type := CkJsonObject__stringOf(jResp,'data.rules[i].route_to.entity_type');
Entity_id := CkJsonObject__stringOf(jResp,'data.rules[i].route_to.entity_id');
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
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}"
}
]
}
