API Reference

Task List Templates

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

Task List Templates

Task List Templates API is
used to manage task list templates within an organization.

GET /cm/v1/crisisTaskListTemplates

Description

Retrieve all task list templates for an organization.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization containing these crisis task list templates.

Authorization
header
String
n
Basic authorization header.

filtered
url parameter
String
y
The filter value.

columnName
url parameter
String
y
Sort Crisis Categories by column name. Default value: lastModifiedDate.

orderDirection
url parameter
String
y
Sort Crisis Categories by ASC or DESC. Default value: DESC.

pageNumber
url parameter
Integer
y
The page number of Crisis Categories to return.
Default value: 1.

pageSize
url parameter
Integer
y
The page size of Crisis Categories to return.
Default value: -1.

folderIds
url parameter
Array[String]
y
Filter by folder IDs.

containUsedNo
url parameter
boolean
y
If task list template is used. Default value: false.

needInit
url parameter
boolean
y
If the system event template can be initialized. Default value: true.

Response

HTTP Status CodeResponse Body

200Ok
{
"pageSize": 10,
"start": 0,
"data": [
{
"id": "5eb65969f729d700018012f3",
"name": "test custom fields",
"nameLowerCase": "test custom fields",
"createdName": "jingwei allRole",
"createdId": 281754149584908,
"createdDate": 1589008745050,
"lastModifiedName": "jingwei allRole",
"lastModifiedId": 281754149584908,
"lastModifiedDate": 1589008745050,
"organizationId": 281891588538372,
"status": "A",
"description": "test custom fields",
"folderId": "0",
"enableNotification": true,
"deleteFlag": "5eb65969f729d700018012f3",
"bulkOpsTime": 0,
"eventType": "Air Quality Hazard",
"title": "test custom fields",
"titleLowerCase": "test custom fields",
"ownerId": 0,
"fileIds": [],
"taskListTemplates": [],
"localDescription": "",
"crisisIncidents": [],
"enableAutoLaunch": false
},
{
"id": "5e5a1aa13ee149307cea4fba",
"name": "test dashboard template",
"nameLowerCase": "test dashboard template",
"createdName": "Everbridge",
"createdId": -1,
"createdDate": 1582963361705,
"lastModifiedName": "jingwei allRole",
"lastModifiedId": 281754149584908,
"lastModifiedDate": 1589008629286,
"organizationId": 281891588538372,
"status": "A",
"description": "test dashboard template",
"folderId": "5e6f364f9ed6b200017d5ad6",
"folderName": "system generated",
"enableNotification": true,
"deleteFlag": "5e5a1aa13ee149307cea4fba",
"bulkOpsTime": 1582963361705,

"eventType": "Earthquake",
"title": "Earthquake",
"titleLowerCase": "earthquake",
"ownerId": 281754149584902,
"ownerName": "jingwei organizationAdmin",
"fileIds": [],
"taskListTemplates": [
{
"id": "5e5a1a9a3ee149307cea4fa1",
"performedDate": 1589008629275,
"performedById": 281754149584908,
"performedByName": "jingwei allRole",
"enableAutoLaunch": true
},
{
"id": "5e5a1a9a3ee149307cea4fa2",
"performedDate": 1589008629275,
"performedById": 281754149584908,
"performedByName": "jingwei allRole",
"enableAutoLaunch": true
},
{
"id": "5e781dcab56cc80001a5e7b7",
"performedDate": 1589008629275,
"performedById": 281754149584908,
"performedByName": "jingwei allRole",
"enableAutoLaunch": true
},
{
"id": "5e781dcab56cc80001a5e7b7",
"performedDate": 1589008629275,
"performedById": 281754149584908,
"performedByName": "jingwei allRole",
"enableAutoLaunch": true
}
],
"localDescription": "",
"crisisIncidents": [],
"enableAutoLaunch": true,
"taskListTempIds": [
"5e5a1a9a3ee149307cea4fa1",
"5e5a1a9a3ee149307cea4fa2",
"5e781dcab56cc80001a5e7b7",
"5e781dcab56cc80001a5e7b7"
],
"dashboardTemplateIds": [
"5e97ed789147a94aa4821965",
"5e97ed789147a94aa4821966"
]
}
],
"totalCount": 3,
"totalPageCount": 2,
"currentPageNo": 1
}