Escalation Policies
Authorizations
Query parameters
start-indexinteger · int32OptionalDefault:
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
max-resultsinteger · int32 · max: 50OptionalDefault:
the maximum number of results when paging through a list of escalation policies.
50
Responses
200
OK
application/json
get
GET /api/escalation-policies HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
OK
[
{
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
}
]
Authorizations
Body
idinteger · int64Optional
namestringRequired
repeatingbooleanOptionalDefault:
false
frequencyinteger · int32 · min: 1 · max: 9OptionalDefault:
1
delayMininteger · int32 · max: 15OptionalDefault:
0
routingKeystringOptional
optional
Responses
201
Created. The URI of the escalation policy is included in the Location header and the entity in the body
application/json
post
POST /api/escalation-policies HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 309
{
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
}
201
Created. The URI of the escalation policy is included in the Location header and the entity in the body
{
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Responses
200Success
application/json
get
GET /api/escalation-policies/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200Success
{
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Body
idinteger · int64Optional
namestringRequired
repeatingbooleanOptionalDefault:
false
frequencyinteger · int32 · min: 1 · max: 9OptionalDefault:
1
delayMininteger · int32 · max: 15OptionalDefault:
0
routingKeystringOptional
optional
Responses
200
The updated escalation policy
application/json
put
PUT /api/escalation-policies/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 309
{
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
}
200
The updated escalation policy
{
"id": 1,
"name": "text",
"escalationRules": [
{
"escalationTimeout": 1,
"user": {
"id": 1
},
"schedule": {
"id": 1
},
"users": [
{
"id": 1,
"firstName": "text",
"lastName": "text"
}
],
"schedules": [
{
"id": 1,
"name": "text",
"type": "STATIC"
}
]
}
],
"teams": [
{
"id": 1,
"name": "text"
}
],
"repeating": false,
"frequency": 1,
"delayMin": 0,
"routingKey": "text"
}
Was this helpful?