Endpoint
/api/v2/tenants/{tenantId}/incidents/businessImpacts
Defines the severity of an entity on the business.
Path Parameters
tenantIdstring
Responses
OK
[
{
"description": "Location A servers down",
"id": 1,
"name": "Servers down",
"uniqueId": "SIMPACT-b219e457-7c95-ce66-6575-c10576bc256f"
},
{
"description": "High load on DB",
"id": 2,
"name": "Impact on DB",
"uniqueId": "SIMPACT-79f46cbb-1b4b-4563-9689-7f82663edc5c"
},
{
"description": "FDS issue",
"id": 3,
"name": "Site down",
"uniqueId": "SIMPACT-35a765bc-04a9-4e07-b4d1-d03c382118a9"
}
]
Endpoint
/api/v2/tenants/{tenantId}/incidents/businessImpacts
Creates an incident business impact.
Path Parameters
tenantIdstring
createdByobject
Child Parameters
- createdBy.email
- createdBy.firstName
- createdBy.id
- createdBy.lastName
- createdBy.loginName
- createdBy.phoneNumber
createdDatestring
descriptionstring
(Optional) Short summary describing the business impact.
namestring
Business impact name.
uniqueIdstring
updatedByobject
Child Parameters
- updatedBy.email
- updatedBy.firstName
- updatedBy.id
- updatedBy.lastName
- updatedBy.loginName
- updatedBy.phoneNumber
updatedDatestring
{
"description": "Servers in site SJ are down",
"name": "SJ Servers Down"
}
Responses
OK
createdByobject
Child Parameters
- createdBy.email
- createdBy.firstName
- createdBy.id
- createdBy.lastName
- createdBy.loginName
- createdBy.phoneNumber
createdDatestring
descriptionstring
(Optional) Short summary describing the business impact.
namestring
Business impact name.
uniqueIdstring
updatedByobject
Child Parameters
- updatedBy.email
- updatedBy.firstName
- updatedBy.id
- updatedBy.lastName
- updatedBy.loginName
- updatedBy.phoneNumber
updatedDatestring
{
"createdBy": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "john.smith"
},
"createdDate": "2017-12-14T05:50:18+0000",
"description": "Servers in SJ are down",
"name": "SJ Server Down",
"uniqueId": "SIMPACT-b5a182be-826c-4380-9575-ad02cf4f5836",
"updatedBy": {
"email": "john.smith@myorganization.com",
"firstName": "John",
"lastName": "Smith",
"loginName": "john.smith"
},
"updatedDate": "2017-12-14T05:50:18+0000"
}