Folder

Folders

Search Folders

get

Returns JSON representation of the Folder tree

Path parameters

folderIdintegerRequired

The ID of the Folder to return

Query parameters

folderNamestringOptional

Filter by Folder name

exactFolderNameintegerOptional

Filter by exact Folder name match

homeFolderIdintegerOptional

Override the home folder ID used when building the tree view

Responses

200

successful operation

application/json

Class Folder

idintegerOptional

The ID of this Folder

typestringOptional

The type of folder (home or root)

textstringOptional

The name of this Folder

parentIdintegerOptional

The folderId of the parent of this Folder

isRootintegerOptional

Flag indicating whether this is root Folder

childrenstringOptional

An array of children folderIds

createdDtstring · nullableOptional

Date this Folder was created

modifiedDtstring · nullableOptional

Date this Folder was last modified

get/folders

GET /api/folders HTTP/1.1
Accept: */*

200

successful operation

[
  {
    "id": 1,
    "type": "text",
    "text": "text",
    "parentId": 1,
    "isRoot": 1,
    "children": "text",
    "createdDt": "text",
    "modifiedDt": "text"
  }
]

Add Folder

post

Add a new Folder to the specified parent Folder

Body

textstringRequired

Folder Name

parentIdstringOptional

The ID of the parent Folder, if not provided, Folder will be added under Root Folder

Responses

200

successful operation

application/json

Class Folder

idintegerOptional

The ID of this Folder

typestringOptional

The type of folder (home or root)

textstringOptional

The name of this Folder

parentIdintegerOptional

The folderId of the parent of this Folder

isRootintegerOptional

Flag indicating whether this is root Folder

childrenstringOptional

An array of children folderIds

createdDtstring · nullableOptional

Date this Folder was created

modifiedDtstring · nullableOptional

Date this Folder was last modified

post/folders

POST /api/folders HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 33

"text='text'&parentId='text'"

200

successful operation

{
  "id": 1,
  "type": "text",
  "text": "text",
  "parentId": 1,
  "isRoot": 1,
  "children": "text",
  "createdDt": "text",
  "modifiedDt": "text"
}

Get Folder

get

Returns a single decorated Folder including sharing, usage and buttons

Path parameters

folderIdintegerRequired

The ID of the Folder to return

Query parameters

folderNamestringOptional

Filter by Folder name

exactFolderNameintegerOptional

Filter by exact Folder name match

homeFolderIdintegerOptional

Override the home folder ID used when building the tree view

Responses

200

successful operation

application/json

Class Folder

idintegerOptional

The ID of this Folder

typestringOptional

The type of folder (home or root)

textstringOptional

The name of this Folder

parentIdintegerOptional

The folderId of the parent of this Folder

isRootintegerOptional

Flag indicating whether this is root Folder

childrenstringOptional

An array of children folderIds

createdDtstring · nullableOptional

Date this Folder was created

modifiedDtstring · nullableOptional

Date this Folder was last modified

get/folders/{folderId}

GET /api/folders/{folderId} HTTP/1.1
Accept: */*

200

successful operation

[
  {
    "id": 1,
    "type": "text",
    "text": "text",
    "parentId": 1,
    "isRoot": 1,
    "children": "text",
    "createdDt": "text",
    "modifiedDt": "text"
  }
]

Edit Folder

put

Edit existing Folder

Path parameters

folderIdintegerRequired

Folder ID to edit

Body

textstringRequired

Folder Name

Responses

200

successful operation

application/json

Class Folder

idintegerOptional

The ID of this Folder

typestringOptional

The type of folder (home or root)

textstringOptional

The name of this Folder

parentIdintegerOptional

The folderId of the parent of this Folder

isRootintegerOptional

Flag indicating whether this is root Folder

childrenstringOptional

An array of children folderIds

createdDtstring · nullableOptional

Date this Folder was created

modifiedDtstring · nullableOptional

Date this Folder was last modified

put/folders/{folderId}

PUT /api/folders/{folderId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15

"text='text'"

200

successful operation

{
  "id": 1,
  "type": "text",
  "text": "text",
  "parentId": 1,
  "isRoot": 1,
  "children": "text",
  "createdDt": "text",
  "modifiedDt": "text"
}

Delete Folder

delete

Delete existing Folder

Path parameters

folderIdintegerRequired

Folder ID to delete

Responses

200

successful operation

No content

delete/folders/{folderId}

DELETE /api/folders/{folderId} HTTP/1.1
Accept: */*

200

successful operation

No content