Tasks

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

Tasks

Tasks API is used to manage
tasks within an organization.

PUT /cm/v1/taskLists/{id}/tasks

Description

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

datas

body

Object

n

The object of the creation data.

 

Request Body

CrisisTaskCreateRequestWrapper object:

*Choose one pair of owner model by type.

Response

HTTP Status CodeResponse Body

200Ok

The ID of the newly created 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/tasks/{id}

Description

Update a task.

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.

crisisTaskWrapper

body

Object

n

The object of the update data.

 

Request Body

CrisisTaskUpdateRequestWrapper object:

*Choose one pair of owner model by type.

Response

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

Description

Return a paged set of task comments.

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.

filtered

url parameter

String

y

Like filter-The filter value, in this case, the content of the comments.

columnName

url parameter

String

y

The name of the column to sort by, allowable values: “lastModifiedDate”.
“lastModifiedDate” 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 Crisis Categories to return.
Default value: 1.

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": 2,
"start": 0,
"data": [
{
"id": "5fc5ff2f62e38468e7c9a618",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1606811439588,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606811439588,
"enableNotification": true,
"noteContent": "string",
"scopeType": "CRISISTASK",
"scopeId": "5fc5f9d73890a722a474130d",
"level": "Warn"
},
{
"id": "5fc5ff183890a722a4741328",
"createdName": "lingxiao jin",
"createdId": 281754149584903,
"createdDate": 1606811416435,
"lastModifiedName": "lingxiao jin",
"lastModifiedId": 281754149584903,
"lastModifiedDate": 1606811416435,
"enableNotification": true,
"noteContent": "string",
"scopeType": "CRISISTASK",
"scopeId": "5fc5f9d73890a722a474130d",
"level": "Warn"
}
],
"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