API Reference

Folders

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

Folders

GET /cm/v1/folders

Description

Get the folders in a tree format of an organization.

Parameters

ParameterPositionTypeOptionalDescription

organizationId
header
Long
n
The ID of the organization.

Authorization
header
String
n
Basic authorization header.

 

Response

HTTP Status CodeResponse Body

200Ok
FolderTree object:
{
"folderTree": {
"id": "5dbfcfbe2a97355f41f57bd6",//the preseted home folder of the organization
"name": "Home",
"access": true,//If the current user can access this folder
"children": [
{
"id": "5dc51a202a97353db4cbf661",
"name": "f1",
"access": true,
"children": [
{
"id": "5e151bcdf0ee6e5da3bacc94",
"name": "f1-1",
"access": true,
"resourcesNumMap": {//Statistics number of different resources in this folder
"CRISISEVENT": 0,
"CRISISEVENTTEMPLATE": 0,
"CRISISTASKLISTTEMPLATE": 0,
"CRISISDOCUMENT": 0,
"CRISISWIDGETTEMPLATE": 0,
"REQUESTSUBMISSION": 0

}
},
{
"id": "5e09adf2f0ee6e16b3b80a4e",
"name": "f1-2",
"access": true,
"resourcesNumMap": {
"CRISISEVENT": 0,
"CRISISEVENTTEMPLATE": 0,
"CRISISTASKLISTTEMPLATE": 0,
"CRISISDOCUMENT": 0,
"CRISISWIDGETTEMPLATE": 0,
"REQUESTSUBMISSION": 0
}
}
],
"resourcesNumMap": {
"CRISISEVENT": 0,
"CRISISEVENTTEMPLATE": 2,
"CRISISTASKLISTTEMPLATE": 0,
"CRISISDOCUMENT": 5,
"CRISISWIDGETTEMPLATE": 0,
"REQUESTSUBMISSION": 2
}
}
],
"resourcesNumMap": {
"CRISISEVENT": 0,
"CRISISEVENTTEMPLATE": 0,
"CRISISTASKLISTTEMPLATE": 0,
"CRISISDOCUMENT": 0,
"CRISISWIDGETTEMPLATE": 0,
"REQUESTSUBMISSION": 0
}
},
"uncategorized": {
"id": "0",
"name": "Uncategorized",
"access": true,
"resourcesNumMap": {
"CRISISEVENT": 26,
"CRISISEVENTTEMPLATE": 3,
"CRISISTASKLISTTEMPLATE": 16,
"CRISISDOCUMENT": 7,
"CRISISWIDGETTEMPLATE": 0,
"REQUESTSUBMISSION": 43
}
}
}

400
Bad Request

401
Unauthorized

403
Forbidden. No Permission for this Resource

404
Resource Not Found

406
Not Acceptable. Illegal Input.

500
Internal Error