API Reference

Task Lists

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

Task Lists

Task Lists API is used to
manage task lists within an organization.

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

Description

Get all task list items 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.

containCrisisTask
url parameter
boolean
y
Whether to include the tasks when getting the task lists. Default value: true.

 

Response

HTTP Status CodeResponse Body

200Ok
[
{
"id": "5f61b51c581c92000118bb97",
"name": "tasklist b",
"createdName": "jingwei allRole",
"createdId": 281754149584908,
"createdDate": 1600238876024,
"lastModifiedName": "jingwei allRole",
"lastModifiedId": 281754149584908,
"lastModifiedDate": 1600238876024,
"organizationId": 281891588538372,
"description": "b",
"folderId": "0",
"enableNotification": true,
"crisisTasks": [
{
"id": "5f61b51c581c92000118bb98",
"name": "task a",
"description": "string",
"createdName": "jingwei allRole",
"createdId": 281754149584908,
"createdDate": 1600238876025,
"lastModifiedName": "jingwei allRole",
"lastModifiedId": 281754149584908,
"lastModifiedDate": 1600238876025,
"organizationId": 281891588538372,
"folderId": "0",
"enableNotification": true,
"crisisEventId": "5eb65998f729d700018012fb",
"crisisTaskStatus": "Active",
"position": 1,
"owner": {
"ownerId": 281754149585180,
"ownerName": "jingwei contact"
},
"fileResources": [],
"hasWritePermissionForContact": false,
"hasOwnerPermissionForContact": false,
"taskComments": []
}
],
"crisisEventId": "5eb65998f729d700018012fb",
"crisisTaskListStatus": "NotLaunched",
"taskNum": 1,
"completedTaskNum": 0
}
]

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/{id}/taskLists/batch

Description

Add task lists to 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.

datas
body
Object
n
The object of the creation data.

 

Request Body

CrisisTaskListBatchCreateWrapper object:

HTTP Status CodeResponse Body

200Ok
The ID array of the newly created task lists .
[
"5fc5f04a62e38468e7c9a5e8",
"5fc5f04a62e38468e7c9a5e9"
]

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/taskLists/{id}

Description

Get a task list 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 task list.

showTaskComments
url parameter
boolean
y
If the returning data contains task comments. Default value: false.

 

Response

HTTP Status CodeResponse Body

200Ok
{
"id": "5fc5f04a62e38468e7c9a5e8",
"name": "2333",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1606807626752,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606807626752,
"organizationId": 1328214341320748,
"description": "D3",
"folderId": "0",
"enableNotification": true,
"owner": {
"ownerId": 884011643741357,
"ownerName": "Lingxiao Jin"
},
"crisisTasks": [
{
"id": "5fc5f04a62e38468e7c9a5ea",
"name": "taskiv",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1606807626754,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606807626754,
"organizationId": 1328214341320748,
"folderId": "0",
"enableNotification": true,
"crisisEventId": "5fbcc0249fd9b728d9ac43b9",
"crisisTaskStatus": "Active",
"position": 1,
"owner": {
"ownerId": 884011643741357,
"ownerName": "Lingxiao Jin"
},
"fileResources": [],
"hasWritePermissionForContact": false,
"hasOwnerPermissionForContact": false,
"taskComments": []
}
],
"crisisEventId": "5fbcc0249fd9b728d9ac43b9",
"crisisTaskListStatus": "NotLaunched",
"taskNum": 1,
"completedTaskNum": 0,
"crisisEvent": {
"id": "5fbcc0249fd9b728d9ac43b9",
"createdName": "lingxiao jin",

"createdId": 281754149584903,
"createdDate": 1606205476068,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606786626290,
"organizationId": 1328214341320748,
"description": "testtest",
"folderId": "0",
"enableNotification": true,
"eventType": "Flood",
"title": "Postman TL CE 34",
"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": [
{
"name": "linus s1",
"type": "scenarioTemplate",
"templateId": 298384262955024,
"enableAutoLaunch": true
},
{
"id": 299346335682473,
"name": "test12",
"type": "scenarioTemplate"
},
{
"id": 299346335682470,
"name": "test12",
"type": "scenarioTemplate"
}
],
"crisisTaskListInfo": [],
"mode": "ACTUAL"
}
}

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/taskLists/{id}

Description

Update a task list.

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 task list.

crisisTaskList
body
Object
n
The object of the update data.

 

Request Body

CrisisTaskListCreateUpdateWrapper object:

*Choose one pair of owner model by type.

HTTP Status CodeResponse Body

200Ok
The ID of the newly updated task list.

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/taskLists/{id}/launch

Description

Launch a task list.

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 task list.

 

Response

HTTP Status CodeResponse Body

200Ok
The ID of the newly launched task list.

400
Bad Request

401
Unauthorized

403
Forbidden. No Permission for this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error