API Reference

Critical Events

Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Critical Events

Critical Events API is used to
manage critical events within an organization.

GET /cm/v1/crisisEvent

Description

Return a paged set of critical events for an organization.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

filtered
url parameter
String
y
Like filter-The filter value, in this case, the title of the critical event.

eventStatus
url parameter
String
n
The status of the critical events used as filter. Allowable values: “Active,Closed, All”.
“Active” will be used as the default if this field is absent.

folderIds
url parameter
Array[String]
y
In filter-The IDs of the folders that contain these critical events.

columnName
url parameter
Sttring
y
The name of the column to sort by. Allowable values: “createdDate, mode”.
“createdDate” will be used as the default if this field is absent.

orderDirection
url parameter
String
y
The sort order of the data. Allowable values: “ASC,DESC”.
“DESC” will be used as the default if this field is absent.

pageNumber
url parameter
Integer
y
The page number of the data to return.
1 will be used as the default if this field is absent.

pageSize
url parameter
Integer
y
The page size of the data to return.
25 will be used as the default if this field is absent.

 

Responses

HTTP StatusResponse Body

200 OK
{
"pageSize": 25,
"start": 0,
"data": [
{
"id": "5ce34e61984bb708ae85984a",
"shortId": "CE-001-010",
"createdName": "testUser"
"createdId": 884011643700207,
"createdDate": 1558400609137,
"lastModifiedName": "testUser",
"lastModifiedId": 884011643700656,
"lastModifiedDate": 1563850362372,
"organizationId": 1328214341320748,
"description": "testEvent_20190521_1",
"folderId": "0",
"eventType": "Crime",
"title": "testEvent_20190521_1",
"eventStatus": "Active",
"ownerId": 0,
"timeZoneStr": "Asia/Shanghai",
"userDate": 1558400572997,
"localDescription": "",
"crisisTaskListInfo": [],
"mode": "EXERCISE"
},
{
"id": "5cde445d984bb77a9af21f86",
"createdName": "testUser",
"createdId": 884011643700207,
"createdDate": 1558070365883,
"lastModifiedName": "testUser",
"lastModifiedId": 884011643700656,
"lastModifiedDate": 1563850362372,
"organizationId": 1328214341320748,
"description": "testexercise20190517_1",
"folderId": "0",
"eventType": "Crime",
"title": "testexercise20190517_1",
"eventStatus": "Active",
"ownerId": 0,
"ownerName": "",
"address": "{"type":"Point","coordinates":[39.92112760000001,116.4329209]}",
"timeZoneStr": "Asia/Shanghai",
"userDate": 1558070340000,
"localDescription": "",
"crisisTaskListInfo": [],
"mode": "EXERCISE",
"detailedLocation": {
"coordinates": "39.92112760000001,116.4329209",

"mapAddress": "China, Bei Jing Shi, Dong Cheng Qu, CN 北京市 东城区 南竹杆胡同 2 2号银河SOHO商场B座1层20123 邮政编码: 100010",
"mapLink": "https://://evbg.co/qpbk51"
}
},
{
"id": "5cde43e3984bb77a9af21f82",
"createdName": "testUser",
"createdId": 884011643700207,
"createdDate": 1558070243657,
"lastModifiedName": "testUser",
"lastModifiedId": 884011643700207,
"lastModifiedDate": 1561684506033,
"organizationId": 1328214341320748,
"description": "test20190517_1",
"folderId": "0",
"eventType": "Crime",
"title": "test20190517_1",
"eventStatus": "Active",
"ownerId": 0,
"timeZoneStr": "Asia/Shanghai",
"userDate": 1558070205769,
"localDescription": "",
"crisisTaskListInfo": [],
"mode": "ACTUAL"
}
],
"totalCount": 3,
"totalPageCount": 1,
"currentPageNo": 1
}

400
Bad request

401
Unauthorized

403
Forbidden. No Permission for this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

POST /cm/v1/crisisEvent

Description

Launch a new critical event.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

crisisEvent
body
Object
n
The object of the creation data.

 

Request Body

CrisisEventCreatedRequestWrapper object:

HTTP Status CodeResponse Body

200Ok
The ID of the newly-created critical event.

400
Bad Request.

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

GET /cm/v1/crisisEvent/{id}

Description

Get a critical event detail.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

id
url path
String
n
The ID of the critical event.

containDetail
url parameter
boolean
n
Pass “true” to return detailed data, pass “false” to return basic info.

 

HTTP Status CodeResponse Body

200Ok
containDetail=true
{
"id": "5ed4a91b1424f211448c325b",
"shortId": "CE-001-010",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1590995227080,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606445975879,

"organizationId": 1328214341320748,
"description": "testtest",
"folderId": "0",
"enableNotification": true,
"eventType": "Flood",
"title": "Postman TL CE 29",
"eventStatus": "Active",
"ownerId": 355971184469862,
"ownerName": "Cory Veilleux",
"address": "{"type":"Point","coordinates":[42.3202949,-72.25023629999998]}",
"geoShape": "{"type":"Polygon","coordinates":[[[48.86737580155996,-85.02867256217566],[49.53448620244693,-85.84274232786177],[50.10425231091629,-86.7958955598007],[50.56264459443221,-87.86466246208789],[50.89837591365776,-89.02272644655503],[51.10317944928524,-90.24157213451053],[51.17201225856355,-91.49118750000002],[51.10317944928524,-92.74080286548951],[50.89837591365776,-93.95964855344502],[50.56264459443221,-95.11771253791215],[50.10425231091629,-96.18647944019935],[49.53448620244693,-97.13963267213826],[48.86737580155996,-97.95370243782439],[48.11934758033769,-98.60864363788384],[47.30882047614995,-99.08832944634597],[46.45575235628708,-99.38094840662046],[45.58114858903087,-99.47929526875876],[44.70654482177466,-99.38094840662048],[43.85347670191179,-99.08832944634597],[43.04294959772405,-98.60864363788384],[42.294921376501776,-97.95370243782439],[41.62781097561481,-97.13963267213828],[41.05804486714545,-96.18647944019935],[40.59965258362953,-95.11771253791215],[40.263921264403976,-93.95964855344502],[40.05911772877649,-92.74080286548951],[39.99028491949819,-91.49118750000002],[40.05911772877649,-90.24157213451053],[40.263921264403976,-89.02272644655503],[40.59965258362953,-87.86466246208789],[41.05804486714545,-86.79589555980071],[41.62781097561481,-85.84274232786179],[43.042949597724046,-84.3737313621162],[45.58114858903087,-83.50307973124129]]]}",
"timeZoneStr": "Pacific/Niue",
"userDate": 1580991957,
"localDescription": "Local description",
"crisisIncidents": [
{
"id": 299346335682474,
"name": "test12",
"type": "IncidentTemplate"
},
{
"id": 300308408304215,
"name": "Escaltions_Tmp_RA821",

"type": "IncidentTemplate"
}
],
"fileIds": [
"5f9b6d7a170faa00016c01a0"
],
"crisisTaskListInfo": [
{
"id": "5f90f9a58d12810001471c98",
"name": "list7",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1603336613018,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606101495503,
"organizationId": 1328214341320748,
"description": "D3",
"folderId": "0",
"enableNotification": true,
"owner": {
"ownerId": 884011643741228,
"ownerName": "Lingxiao Jin"
},
"crisisTasks": [
{
"id": "5f90f9a58d12810001471c99",
"name": "task99",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1603336613024,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606102094246,
"organizationId": 1328214341320748,
"folderId": "0",
"enableNotification": true,
"crisisEventId": "5ed4a91b1424f211448c325b",
"crisisTaskStatus": "InProgress",
"position": 1,
"owner": {
"groupOwnerId": 444206992588925,
"groupOwnerName": "group_1"
},
"firstPerformedInfo": {
"performedDate": 1605666180004,
"performedById": 281754149584903,
"performedByType": "USER",
"performedByName": "lingxiao jin"
},
"lastPerformedInfo": {
"performedDate": 1606101494663,
"performedById": 281754149584903,
"performedByType": "USER",
"performedByName": "lingxiao jin"
},

"fileResources": [],
"hasWritePermissionForContact": false,
"hasOwnerPermissionForContact": false,
"taskComments": [],
"crisisTaskList": {
"id": "5f90f9a58d12810001471c98",
"folderId": "0",
"enableNotification": true,
"owner": {
"ownerId": 884011643741228,
"ownerName": "Lingxiao Jin"
},
"crisisTasks": []
}
}
],
"crisisEventId": "5ed4a91b1424f211448c325b",
"crisisTaskListStatus": "InProgress",
"completedDate": 1606101407326,
"launchedDate": 1603336673354,
"taskNum": 1,
"completedTaskNum": 0
}
],
"mode": "ACTUAL",
"detailedLocation": {
"coordinates": "42.3202949,-72.25023629999998",
"mapAddress": "3518 Greenwich Rd, Hardwick, MA 01082, USA",
"mapLink": "https://://evbg.co/zribw6"
}
}

containDetail=false
{
"id": "5ed4a91b1424f211448c325b",
"shortId": "CE-001-010",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1590995227080,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606445975879,
"organizationId": 1328214341320748,
"description": "testtest",
"folderId": "0",
"enableNotification": true,
"eventType": "Flood",
"title": "Postman TL CE 29",
"eventStatus": "Active",
"ownerId": 355971184469862,
"ownerName": "Cory Veilleux",
"address": "{"type":"Point","coordinates":[42.3202949,-72.25023629999998]}",
"geoShape": "{"type":"Polygon","coordinates":[[[48.86737580155996,-85.02867256217566],[49.53448620244693,-85.84274232786177],[50.10425231091629,-86.7958955598007],[50.56264459443221,-87.86466246208789],[50.89837591365776,-89.02272644655503],[51.10317944928524,-90.24157213451053],[51.17201225856355,-91.49118750000002],[51.10317944928524,-92.74080286548951],[50.89837591365776,-93.95964855344502],[50.56264459443221,-95.11771253791215],[50.10425231091629,-96.18647944019935],[49.53448620244693,-97.13963267213826],[48.86737580155996,-97.95370243782439],[48.11934758033769,-98.60864363788384],[47.30882047614995,-99.08832944634597],[46.45575235628708,-99.38094840662046],[45.58114858903087,-99.47929526875876],[44.70654482177466,-99.38094840662048],[43.85347670191179,-99.08832944634597],[43.04294959772405,-98.60864363788384],[42.294921376501776,-97.95370243782439],[41.62781097561481,-97.13963267213828],[41.05804486714545,-96.18647944019935],[40.59965258362953,-95.11771253791215],[40.263921264403976,-93.95964855344502],[40.05911772877649,-92.74080286548951],[39.99028491949819,-91.49118750000002],[40.05911772877649,-90.24157213451053],[40.263921264403976,-89.02272644655503],[40.59965258362953,-87.86466246208789],[41.05804486714545,-86.79589555980071],[41.62781097561481,-85.84274232786179],[43.042949597724046,-84.3737313621162],[45.58114858903087,-83.50307973124129]]]}",
"timeZoneStr": "Pacific/Niue",
"userDate": 1580991957,

"localDescription": "Local description",
"crisisIncidents": [
{
"id": 299346335682474,
"name": "test12",
"type": "IncidentTemplate"
},
{
"id": 300308408304215,
"name": "Escaltions_Tmp_RA821",
"type": "IncidentTemplate"
}
],
"fileIds": [
"5f9b6d7a170faa00016c01a0"
],
"crisisTaskListInfo": [],
"mode": "ACTUAL"

400
Bad Request
,
"detailedLocation": {
"coordinates": "42.3202949,-72.25023629999998",
"mapAddress": "3518 Greenwich Rd, Hardwick, MA 01082, USA",
"mapLink": "https://://evbg.co/zribw6"
}
}

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

PUT /cm/v1/crisisEvent/{id}

Description

Update a critical event.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

crisisEvent
body
Object
n
The object of the update data.

id
url path
Strting
n
The ID of the critical event.

 

Request Body

CrisisEventUpdateRequestWrapper object:

HTTP Status CodeResponse Body

200Ok
The ID of the updated critical event.

400
Bad Request.

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

PUT /cm/v1/crisisEvent/{id}/status

Description

Update the status of a critical event.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

eventStatus
url parameter
String
n
The status of the critical event (Active, Closed).
“Active” will be used if this field is absent.

id
url path
String
n
The ID of the critical event.

 

Response Body

HTTP Status CodeResponse Body

200Ok

400
Bad Request.

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

GET /cm/v1/crisisEvent/{id}/auditLogs

Description

Return a paged set of critical event audit logs of a critical event.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

id
url path
String
n
The ID of the critical event.

columnName
url parameter
String
y
The name of the column to sort by, allowable values: “auditDate”.
“auditDate” will be used as default if this field is absent.

orderDirection
url parameter
String
y
The sort order of the data, allowable values: “ASC, DESC”.
“DESC” will be used as default if this field is absent.

pageNumber
url parameter
Integer
y
The page number of the data to return.
1 will be used as default if this field is absent.

pageSize
url parameter
Integer
y
The page size of the data to return.
25 will be used as default if this field is absent.

 

Response

HTTP Status CodeResponse Body

200Ok
{
"pageSize": 3,
"start": 0,
"data": [
{
"id": "5fc0714187ab877a9c8ec31d",
"auditUserType": "USER",
"auditUserName": "lingxiao jin",
"auditUserId": 281754149584903,
"organizationId": 1328214341320748,
"resourceType": "CRISISEVENT",
"resourceId": "5ed4a91b1424f211448c325b",
"resourceName": "Postman TL CE 29",
"actionType": "UPDATE",
"level2ActionType": "BASEINFO",
"currentResourceData": "{"id":"5ed4a91b1424f211448c325b","createdName":"lingxiao jin","createdId":281754149584903,"createdDate":1590995227080,"lastModifiedName":"lingxiao jin","lastModifiedId":281754149584903,"lastModifiedDate":1606447425347,"organizationId":1328214341320748,"description":"testtest22","folderId":"0","enableNotification":true,"eventType":"Flood","title":"Postman TL CE 29","eventStatus":"Active","ownerId":355971184469862,"ownerName":"Cory Veilleux","address":"{\"type\":\"Point\",\"coordinates\":[42.3202949,-72.25023629999998]}","geoShape":"{\"type\":\"Polygon\",\"coordinates\":[[[48.86737580155996,-85.02867256217566],[49.53448620244693,-85.84274232786177],[50.10425231091629,-86.7958955598007],[50.56264459443221,-87.86466246208789],[50.89837591365776,-89.02272644655503],[51.10317944928524,-90.24157213451053],[51.17201225856355,-91.49118750000002],[51.10317944928524,-92.74080286548951],[50.89837591365776,-93.95964855344502],[50.56264459443221,-95.11771253791215],[50.10425231091629,-96.18647944019935],[49.53448620244693,-97.13963267213826],[48.86737580155996,-97.95370243782439],[48.11934758033769,-98.60864363788384],[47.30882047614995,-99.08832944634597],[46.45575235628708,-99.38094840662046],[45.58114858903087,-99.47929526875876],[44.70654482177466,-99.38094840662048],[43.85347670191179,-99.08832944634597],[43.04294959772405,-98.60864363788384],[42.294921376501776,-97.95370243782439],[41.62781097561481,-97.13963267213828],[41.05804486714545,-96.18647944019935],[40.59965258362953,-95.11771253791215],[40.263921264403976,-93.95964855344502],[40.05911772877649,-92.74080286548951],[39.99028491949819,-91.49118750000002],[40.05911772877649,-90.24157213451053],[40.263921264403976,-89.02272644655503],[40.59965258362953,-87.86466246208789],[41.05804486714545,-86.79589555980071],[41.62781097561481,-85.84274232786179],[43.042949597724046,-84.3737313621162],[45.58114858903087,-83.50307973124129]]]}","timeZoneStr":"Pacific/Niue","userDate":1580991957,"localDescription":"Local description","mode":"ACTUAL"}",
"auditDate": 1606447425353,
"action": "Critical Event BaseInfo Updated",
"details": "lingxiao jin changed the basic information of the Critical Event 'Postman TL CE 29'",
"detailActionType": "UPDATE"
},
{
"id": "5fc06b97f973f02e4185bae5",
"auditUserType": "USER",
"auditUserName": "lingxiao jin",
"auditUserId": 281754149584903,
"organizationId": 1328214341320748,
"resourceType": "CRISISINCIDENT",
"resourceId": "299346335682474",
"resourceName": "test12",
"actionType": "CREATE",

"currentResourceData": "{"crisisIncidentTemplates":"[]","crisisIncidentInstances":"[{\"accountId\":1328214341320736,\"status\":\"A\",\"createdId\":281754149584903,\"createdName\":\"lingxiao jin\",\"lastModifiedId\":281754149584903,\"lastModifiedName\":\"lingxiao jin\",\"createdDate\":1605772355490,\"lastModifiedDate\":1605772355490,\"organizationId\":1328214341320748,\"createdProxyName\":\"eb admin\",\"lastModifiedProxyName\":\"eb admin\",\"resourceBundleId\":1328214341320764,\"id\":299346335682474,\"name\":\"test12\",\"incidentStatus\":\"Open\",\"phaseStatus\":{\"id\":1001,\"name\":\"New\",\"seq\":100,\"incidentStatus\":\"Open\",\"isDefault\":true,\"status\":\"A\",\"phaseNodeType\":\"Begin\",\"phaseFlag\":0,\"flowFlag\":0},\"hasJournal\":false,\"duration\":673620,\"isCloseIncident\":false,\"incidentAction\":\"Launch\",\"incidentType\":\"Incident\",\"serviceType\":\"DEFAULT\",\"subServiceId\":0,\"enableIncidentChat\":false,\"launchType\":\"SendNow\",\"useTemplateVarValue\":false,\"newService\":false},{\"accountId\":1328214341320736,\"status\":\"A\",\"createdId\":281754149584903,\"createdName\":\"lingxiao jin\",\"lastModifiedId\":281754149584903,\"lastModifiedName\":\"lingxiao jin\",\"createdDate\":1577924337906,\"lastModifiedDate\":1577924337906,\"organizationId\":1328214341320748,\"resourceBundleId\":1328214341320764,\"id\":300308408304215,\"name\":\"Escaltions_Tmp_RA821\",\"incidentStatus\":\"Open\",\"phaseStatus\":{\"id\":1001,\"name\":\"New\",\"seq\":100,\"incidentStatus\":\"Open\",\"isDefault\":true,\"status\":\"A\",\"phaseNodeType\":\"Begin\",\"phaseFlag\":0,\"flowFlag\":0},\"hasJournal\":false,\"duration\":28521638,\"isCloseIncident\":false,\"incidentType\":\"Incident\",\"serviceType\":\"DEFAULT\",\"subServiceId\":0,\"enableIncidentChat\":false,\"launchType\":\"SendNow\",\"useTemplateVarValue\":false,\"newService\":false}]","crisisSchedules":"[]","crisisIncidents":[{"id":299346335682474,"type":"IncidentTemplate","name":"test12","crisisIncidentType":"IncidentTemplate"},{"id":300308408304215,"type":"IncidentTemplate","name":"Escaltions_Tmp_RA821","crisisIncidentType":"IncidentTemplate"}]}",
"auditDate": 1606445975964,
"action": "Incident Communication Added to Critical Event",
"details": "lingxiao jin added the Incident Communication 'test12' to the Critical Event 'Postman TL CE 29'",
"detailActionType": "ADD"
},
{
"id": "5fc06b97f973f02e4185bae4",
"auditUserType": "USER",
"auditUserName": "lingxiao jin",
"auditUserId": 281754149584903,
"organizationId": 1328214341320748,
"resourceType": "CRISISINCIDENT",
"resourceId": "300308408304215",
"resourceName": "Escaltions_Tmp_RA821",
"actionType": "CREATE",
"currentResourceData": "{"crisisIncidentTemplates":"[]","crisisIncidentInstances":"[{\"accountId\":1328214341320736,\"status\":\"A\",\"createdId\":281754149584903,\"createdName\":\"lingxiao jin\",\"lastModifiedId\":281754149584903,\"lastModifiedName\":\"lingxiao jin\",\"createdDate\":1605772355490,\"lastModifiedDate\":1605772355490,\"organizationId\":1328214341320748,\"createdProxyName\":\"eb admin\",\"lastModifiedProxyName\":\"eb admin\",\"resourceBundleId\":1328214341320764,\"id\":299346335682474,\"name\":\"test12\",\"incidentStatus\":\"Open\",\"phaseStatus\":{\"id\":1001,\"name\":\"New\",\"seq\":100,\"incidentStatus\":\"Open\",\"isDefault\":true,\"status\":\"A\",\"phaseNodeType\":\"Begin\",\"phaseFlag\":0,\"flowFlag\":0},\"hasJournal\":false,\"duration\":673620,\"isCloseIncident\":false,\"incidentAction\":\"Launch\",\"incidentType\":\"Incident\",\"serviceType\":\"DEFAULT\",\"subServiceId\":0,\"enableIncidentChat\":false,\"launchType\":\"SendNow\",\"useTemplateVarValue\":false,\"newService\":false},{\"accountId\":1328214341320736,\"status\":\"A\",\"createdId\":281754149584903,\"createdName\":\"lingxiao jin\",\"lastModifiedId\":281754149584903,\"lastModifiedName\":\"lingxiao jin\",\"createdDate\":1577924337906,\"lastModifiedDate\":1577924337906,\"organizationId\":1328214341320748,\"resourceBundleId\":1328214341320764,\"id\":300308408304215,\"name\":\"Escaltions_Tmp_RA821\",\"incidentStatus\":\"Open\",\"phaseStatus\":{\"id\":1001,\"name\":\"New\",\"seq\":100,\"incidentStatus\":\"Open\",\"isDefault\":true,\"status\":\"A\",\"phaseNodeType\":\"Begin\",\"phaseFlag\":0,\"flowFlag\":0},\"hasJournal\":false,\"duration\":28521638,\"isCloseIncident\":false,\"incidentType\":\"Incident\",\"serviceType\":\"DEFAULT\",\"subServiceId\":0,\"enableIncidentChat\":false,\"launchType\":\"SendNow\",\"useTemplateVarValue\":false,\"newService\":false}]","crisisSchedules":"[]","crisisIncidents":[{"id":299346335682474,"type":"IncidentTemplate","name":"test12","crisisIncidentType":"IncidentTemplate"},{"id":300308408304215,"type":"IncidentTemplate","name":"Escaltions_Tmp_RA821","crisisIncidentType":"IncidentTemplate"}]}",

"auditDate": 1606445975964,
"action": "Incident Communication Added to Critical Event",
"details": "lingxiao jin added the Incident Communication 'Escaltions_Tmp_RA821' to the Critical Event 'Postman TL CE 29'",
"detailActionType": "ADD"
}
],
"totalCount": 76,
"totalPageCount": 26,
"currentPageNo": 1
}

400
Bad Request.

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

GET /cm/v1/crisisEvent/{id}/fileResources

Description

Return a list of attachment files of the critical event.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

id
url path
String
n
The ID of the critical event.

 

Response

HTTP Status CodeResponse Body

200Ok
[
{
"id": "5f9b6d7a170faa00016c01a0",
"name": "testLog",
"nameLowerCase": "testlog",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1604021626570,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1604021626570,
"organizationId": 1328214341320748,
"status": "A",
"folderId": "0",
"enableNotification": true,
"deleteFlag": "-1",
"bulkOpsTime": 0,
"metadata": {
"OriginalFileName": "storeFiles-10-20.csv",
"ContentType": "application/octet-stream",
"ContentLength": 1676962
},
"fileId": "evbg-dev3-us-west-2-crismgt_5f9b6d7a170faa00016c01a0",
"bucket": "evbg-dev3-us-west-2-crismgt",
"documentType": "File",
"scopeType": "ORGANIZATION",
"scopeId": "1328214341320748",

"scopeId": "1328214341320748",
"addedOnInfo": {
"id": "5f9b6d7a170faa00016c01a0",
"performedDate": 1604371663769,
"performedById": 281754149584903,
"performedByName": "lingxiao jin"
},
"contentType": "application/octet-stream",
"originalName": "storeFiles-10-20.csv",
"length": 1676962
},
{
"id": "5f9b6d7a170faa00016c01a1",
"name": "testLog1",
"nameLowerCase": "testlog1",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1604021626570,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1604021626570,
"organizationId": 1328214341320748,
"status": "A",
"folderId": "0",
"enableNotification": true,
"deleteFlag": "-1",
"bulkOpsTime": 0,
"metadata": {
"OriginalFileName": "storeFiles-10-20.csv",
"ContentType": "application/octet-stream",
"ContentLength": 1676962
},
"fileId": "evbg-dev3-us-west-2-crismgt_5f9b6d7a170faa00016c01a0",
"bucket": "evbg-dev3-us-west-2-crismgt",
"documentType": "File",
"scopeType": "ORGANIZATION",
"scopeId": "1328214341320748",
"addedOnInfo": {
"id": "5f9b6d7a170faa00016c01a1",
"performedDate": 1604371663769,
"performedById": 281754149584903,
"performedByName": "lingxiao jin"
},
"contentType": "application/octet-stream",
"originalName": "storeFiles-10-20.csv",
"length": 1676962
}
]

400
Bad Request.

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error

GET /cm/v1/crisisEvent/{id}/notes

Description

Return a paged set of notes of a critical event.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

id
url path
String
n
The ID of the critical event.

columnName
url parameter
String
y
The name of the column to sort by, allowable values: “auditDate”.
“auditDate” will be used as default if this field is absent.

orderDirection
url parameter
String
y
The sort order of the data, allowable values: “ASC, DESC”.
“DESC” will be used as default if this field is absent.

pageNumber
url parameter
Integer
y
The page number of the data to return.
1 will be used as default if this field is absent.

pageSize
url parameter
Integer
y
The page size of the data to return.
25 will be used as default if this field is absent.

 

Response

HTTP Status CodeResponse Body

200Ok
{
"pageSize": 25,
"start": 0,
"data": [
{
"id": "5fc0d02875baa524adf16bd6",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1606471720525,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606471720525,
"enableNotification": true,
"noteContent": "string456",
"noteFileResources": [
{
"id": "5f8d5e70050cfb0001cdbab6",
"name": "s1.jpg",
"metadata": {
"OriginalFileName": "s1.jpg",
"ContentType": "image/jpeg",
"ContentLength": 87414
},

"fileId": "5f8d5e70050cfb0001cdbab6",
"documentType": "File"
}
],
"noteFileIds": [
"5f8d5e70050cfb0001cdbab6"
],
"scopeType": "CRISISEVENT",
"scopeId": "5ed4a91b1424f211448c325b"
},
{
"id": "5fc0cfd175baa524adf16bd4",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1606471633784,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606471633784,
"enableNotification": true,
"noteContent": "string123",
"scopeType": "CRISISEVENT",
"scopeId": "5ed4a91b1424f211448c325b"
}
],
"totalCount": 2,
"totalPageCount": 1,
"currentPageNo": 1
}

400
Bad Request.

401
Unauthorized

403
Forbidden. No Permission For this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error