Chilkat Online Tools

Swift3 / Squadcast API V3 / Create or Update Tagging Rules

Back to Collection Items

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let http = CkoHttp()!
    var success: Bool

    // 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>",
    //       "tags": {
    //         "key": {
    //           "value": "<string>",
    //           "color": "<string>"
    //         }
    //       }
    //     },
    //     {
    //       "expression": "<string>",
    //       "tags": {
    //         "key": {
    //           "value": "<string>",
    //           "color": "<string>"
    //         }
    //       }
    //     }
    //   ]
    // }

    let json = CkoJsonObject()!
    json.update("rules[0].expression", value: "<string>")
    json.update("rules[0].tags.key.value", value: "<string>")
    json.update("rules[0].tags.key.color", value: "<string>")
    json.update("rules[1].expression", value: "<string>")
    json.update("rules[1].tags.key.value", value: "<string>")
    json.update("rules[1].tags.key.color", value: "<string>")

    http.setRequestHeader("Authorization", value: "")
    http.setRequestHeader("Content-Type", value: "application/json")

    var resp: CkoHttpResponse? = http.postJson3("https://api.squadcast.com/v3/services/:serviceID/tagging-rules", contentType: "application/json", json: json)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "data": {
    //     "id": "5d8c7b6905f5b9cfbfd30816",
    //     "created_at": "2019-09-26T08:48:41.869Z",
    //     "updated_at": "2019-09-26T08:48:41.869Z",
    //     "deleted_at": null,
    //     "service_id": "5d8c79cb3f00de06d5fed406",
    //     "organization_id": "5d81d9187000fb6b9def7e32",
    //     "rules": [
    //       {
    //         "expression": "re(current.labels.alertname, \"^CPUThrottlingHigh.*\") && re(past.labels.alertname, \"^CPUThrottlingHigh.*\")",
    //         "tags": {
    //           "severity": {
    //             "value": "high",
    //             "color": "#ff0000"
    //           }
    //         }
    //       }
    //     ]
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var expression: String?
    var Value: String?
    var Color: String?

    var Id: String? = jResp.string(of: "data.id")
    var Created_at: String? = jResp.string(of: "data.created_at")
    var Updated_at: String? = jResp.string(of: "data.updated_at")
    var Deleted_at: String? = jResp.string(of: "data.deleted_at")
    var Service_id: String? = jResp.string(of: "data.service_id")
    var Organization_id: String? = jResp.string(of: "data.organization_id")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "data.rules").intValue
    while i < count_i {
        jResp.i = i
        expression = jResp.string(of: "data.rules[i].expression")
        Value = jResp.string(of: "data.rules[i].tags.severity.value")
        Color = jResp.string(of: "data.rules[i].tags.severity.color")
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Authorization: "
	-H "Content-Type: application/json"
	-d '{
    "rules": [
        {
            "expression": "<string>",
            "tags": {
                "key": {
                    "value": "<string>",
                    "color": "<string>"
                }
            }
        },
        {
            "expression": "<string>",
            "tags": {
                "key": {
                    "value": "<string>",
                    "color": "<string>"
                }
            }
        }
    ]
}'
https://api.squadcast.com/v3/services/:serviceID/tagging-rules

Postman Collection Item JSON

{
  "name": "Create or Update Tagging 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            \"tags\": {\n                \"key\": {\n                    \"value\": \"<string>\",\n                    \"color\": \"<string>\"\n                }\n            }\n        },\n        {\n            \"expression\": \"<string>\",\n            \"tags\": {\n                \"key\": {\n                    \"value\": \"<string>\",\n                    \"color\": \"<string>\"\n                }\n            }\n        }\n    ]\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "services",
        ":serviceID",
        "tagging-rules"
      ],
      "variable": [
        {
          "key": "serviceID",
          "value": "<string>",
          "type": "string",
          "description": "(Required) service id"
        }
      ]
    },
    "description": "This endpoint creates or updates the tagging 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": "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            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-rules"
          ],
          "variable": [
            {
              "key": "serviceID"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"data\": {\n  \"id\": \"5d8c7b6905f5b9cfbfd30816\",\n  \"created_at\": \"2019-09-26T08:48:41.869Z\",\n  \"updated_at\": \"2019-09-26T08:48:41.869Z\",\n  \"deleted_at\": null,\n  \"service_id\": \"5d8c79cb3f00de06d5fed406\",\n  \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n  \"rules\": [\n   {\n    \"expression\": \"re(current.labels.alertname, \\\"^CPUThrottlingHigh.*\\\") && re(past.labels.alertname, \\\"^CPUThrottlingHigh.*\\\")\",\n    \"tags\": {\n     \"severity\": {\n      \"value\": \"high\",\n      \"color\": \"#ff0000\"\n     }\n    }\n   }\n  ]\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            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-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            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-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}"
    },
    {
      "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            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-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": "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            \"tags\": {\n                \"severity\": {\n                    \"value\": \"high\",\n                    \"color\": \"#ff0000\"\n                }\n            }\n        }\n    ]\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/services/:serviceID/tagging-rules",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "services",
            ":serviceID",
            "tagging-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}"
    }
  ]
}