folder

Returns JSON representation of the Folder tree

get/folders

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/folders
  • Auth
    none declared

Path parameters

folderIdinteger required

The ID of the Folder to return

Query parameters

folderNamestring

Filter by Folder name

exactFolderNameinteger

Filter by exact Folder name match

homeFolderIdinteger

Override the home folder ID used when building the tree view

Response

successful operation

idinteger

The ID of this Folder

typestring

The type of folder (home or root)

textstring

The name of this Folder

parentIdinteger

The folderId of the parent of this Folder

isRootinteger

Flag indicating whether this is root Folder

childrenstring

An array of children folderIds

createdDtstring nullable

Date this Folder was created

modifiedDtstring nullable

Date this Folder was last modified

Changes

    • breaking

      added the new path request parameter folderId

    • warning

      deleted the query request parameter folderId

    • warning

      deleted the query request parameter gridView

    • info

      added the new optional query request parameter homeFolderId

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • warning

      deleted the path request parameter folderId

    • info

      added the media type application/json for the response with the status