REST API: Folders

Methods


TypeVer.Command parameterParameters
Getters
Folders
GET3.0sp6+ getFolderForm
Example of success:

GET3.3sp1+ getFolderCompany folderId=<id>
Example of success:

Example of failure:
GET3.3sp1+ getFolderCategory folderId=<id>
Example of success:

Example of failure:
GET3.0b1+ getFolderDetails folderId=<id>
Example of success:

Example of failure:
GET3.3 getExternalFolderDetails folderId=<id>
treeType=<treeType>
(opt.) connectorIndex=<index>
Example of success:

Example of failure:
GET3.0b1+ getFolderAttachments folderId=<id>
Example of success:
GET3.0sp4+ getFolderInheritedAttachments folderId=<id>
Example of success:

GET6+ getFolderTreeStructure folderId=<id>
Example of success:

Setters
POST3.0sp7+createFolder treeType=<treeType>
parentFolderId=<id>
Content of the form with values
(see getFolderForm)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST3.2sp4+createFolderUnderCategory parentFolderId=<id>
categoryId=<id>
Content of the form with values
(see getFolderForm)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST3.2sp4+createFolderUnderCompany treeType=<treeType>
parentFolderId=<id>
companyId=<id>
Content of the form with values
(see getFolderForm)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST3.2sp4+createFolderUnderProject parentFolderId=<id>
projectId=<id>
Content of the form with values
(see getFolderForm)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST3.0sp6+updateFolderDetails treeType=<treeType>
Content of the form with values
(see getFolderForm)
must be passed in the request's body
as multi-part.
Example of success:

Example of failure:
POST3.0b1+copyFolder folderId=<id>
folderName=<name>
treeType=<treeType>
destParentFolderId=<id>
Example of success:

Example of failure:
POST3.0b1+moveFoldersToFolder treeType=<treeType>
folderIds=<id, id, ...>
folderNames=<name, name, ...>
destParentFolderId=<id>
destParentFolderName=<name>
Example of success:

Example of failure:
POST3.0b1+moveFoldersToProjectFolder folderIds=<id, id, ...>
folderNames=<name, name, ...>
destParentProjectFolderId=<id>
destParentProjectFolderName=<name>
Example of success:

Example of failure:
POST3.0b1+moveFoldersToCategory folderIds=<id, id, ...>
folderNames=<name, name, ...>
destParentCategoryId=<id>
destParentCategoryName=<name>
Example of success:

Example of failure:
POST3.0b1+moveFoldersToCompany folderIds=<id, id, ...>
folderNames=<name, name, ...>
treeType=<treeType>
destParentCompanyId=<id>
destParentCompanyName=<name>
Example of success:

Example of failure:
POST3.0b1+moveFoldersToProject folderIds=<id, id, ...>
folderNames=<name, name, ...>
treeType=<treeType>
destParentProjectId=<id>
destParentProjectName=<name>
Example of success:

Example of failure:
POST3.0b1+moveFoldersToRoot folderIds=<id, id, ...>
folderNames=<name, name, ...>
treeType=<treeType>
Example of success:

Example of failure:
POST3.0b1+emptyFolders treeType=<treeType>
folderIds=<id, id, ...>
Example of success:

Example of failure:
POST3.0b1+deleteFolders treeType=<treeType>
folderIds=<id, id, ...>
Example of success:

Example of failure: