Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Id
string ls_Name
string ls_Slug
string ls_V_Email
string ls_Escalation_policy_id
string ls_Organization_id
string ls_Api_key
string ls_Description
string ls_Depends
string ls_Escalation_policyId
string ls_Escalation_policyName
string ls_Escalation_policyDescription
string ls_Escalation_policySlug
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "name": "<string>",
// "description": "<string>",
// "escalation_policy_id": "<string>",
// "email_prefix": "<string>"
// }
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.UpdateString("name","<string>")
loo_Json.UpdateString("description","<string>")
loo_Json.UpdateString("escalation_policy_id","<string>")
loo_Json.UpdateString("email_prefix","<string>")
loo_Http.SetRequestHeader("Authorization","")
loo_Http.SetRequestHeader("Content-Type","application/json")
loo_Resp = loo_Http.PostJson3("https://api.squadcast.com/v3/services","application/json",loo_Json)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_Json
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": {
// "id": "5e8edb24668e003cb0b18ba1",
// "name": "Payment API Service",
// "slug": "payment-api-service",
// "email": "unique_string@gopherhut.incidents.squadcast.com",
// "escalation_policy_id": "5d81d9407000fb6b9def7e33",
// "organization_id": "5d81d9187000fb6b9def7e32",
// "api_key": "2f81ac8b2362990dd220f8bb4f7cd30ccc3dac43",
// "description": "Payment API Service monitor",
// "depends": null,
// "escalation_policy": {
// "id": "5d81d9407000fb6b9def7e33",
// "name": "Example Escalation Policy",
// "description": "On-Boarding Example",
// "slug": "example-escalation-policy"
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
ls_Id = loo_JResp.StringOf("data.id")
ls_Name = loo_JResp.StringOf("data.name")
ls_Slug = loo_JResp.StringOf("data.slug")
ls_V_Email = loo_JResp.StringOf("data.email")
ls_Escalation_policy_id = loo_JResp.StringOf("data.escalation_policy_id")
ls_Organization_id = loo_JResp.StringOf("data.organization_id")
ls_Api_key = loo_JResp.StringOf("data.api_key")
ls_Description = loo_JResp.StringOf("data.description")
ls_Depends = loo_JResp.StringOf("data.depends")
ls_Escalation_policyId = loo_JResp.StringOf("data.escalation_policy.id")
ls_Escalation_policyName = loo_JResp.StringOf("data.escalation_policy.name")
ls_Escalation_policyDescription = loo_JResp.StringOf("data.escalation_policy.description")
ls_Escalation_policySlug = loo_JResp.StringOf("data.escalation_policy.slug")
destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -X POST
-H "Authorization: "
-H "Content-Type: application/json"
-d '{
"name": "<string>",
"description": "<string>",
"escalation_policy_id": "<string>",
"email_prefix": "<string>"
}'
https://api.squadcast.com/v3/services
Postman Collection Item JSON
{
"name": "Create Service",
"request": {
"auth": {
"type": "noauth"
},
"method": "POST",
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"escalation_policy_id\": \"<string>\",\n \"email_prefix\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
},
"description": "This endpoint is used to create a service.\nRequires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `service-write` scope.\n"
},
"response": [
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"auxpkg create 1\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"description\": \"service api\",\n \"email_prefix\": \"\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"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": "Created",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"auxpkg create 1\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"description\": \"service api\",\n \"email_prefix\": \"\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"id\": \"5e8edb24668e003cb0b18ba1\",\n \"name\": \"Payment API Service\",\n \"slug\": \"payment-api-service\",\n \"email\": \"unique_string@gopherhut.incidents.squadcast.com\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"organization_id\": \"5d81d9187000fb6b9def7e32\",\n \"api_key\": \"2f81ac8b2362990dd220f8bb4f7cd30ccc3dac43\",\n \"description\": \"Payment API Service monitor\",\n \"depends\": null,\n \"escalation_policy\": {\n \"id\": \"5d81d9407000fb6b9def7e33\",\n \"name\": \"Example Escalation Policy\",\n \"description\": \"On-Boarding Example\",\n \"slug\": \"example-escalation-policy\"\n }\n }\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"auxpkg create 1\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"description\": \"service api\",\n \"email_prefix\": \"\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"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": "Conflict",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"auxpkg create 1\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"description\": \"service api\",\n \"email_prefix\": \"\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"status": "Conflict",
"code": 409,
"_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 \"name\": \"auxpkg create 1\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"description\": \"service api\",\n \"email_prefix\": \"\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"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": "Forbidden",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"auxpkg create 1\",\n \"escalation_policy_id\": \"5d81d9407000fb6b9def7e33\",\n \"description\": \"service api\",\n \"email_prefix\": \"\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"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": "Payment Required",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Authorization",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"escalation_policy_id\": \"<string>\",\n \"email_prefix\": \"<string>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/services",
"host": [
"{{baseUrl}}"
],
"path": [
"services"
]
}
},
"status": "Payment Required",
"code": 402,
"_postman_previewlanguage": "json",
"header": null,
"cookie": [
],
"body": "{\n\t\"meta\": {\n\t\t\"status\": 402,\n\t\t\"error_message\": \"organization has crossed the plan limits for 'service'\",\n\t\t\"error_details\": {\n\t\t\t\"code\": \"E0402\",\n\t\t\t\"description\": \"You've exceeded the number of services under your current plan. To continue, please upgrade.\",\n\t\t\t\"link\": \"https://support.squadcast.com/docs/error-codes-and-what-they-mean\"\n\t\t}\n\t}\n}"
}
]
}
