DOCUMENTATION
API V2 Documentation: https://intelligencebank.atlassian.net/wiki/spaces/APIDOC
API V3 Documentation: https://apidoc.intelligencebank.com
PRODUCT KEY
If applicable, the product key is to be added under Params as:
productkey={{provided_value}}
This applies to all calls, including when POST.
FIELD NAMES
Note that field / attribute names can differ between V2 and V3 responses.
CALLS MAPPING
V2 Call | V3 Call | Comments (GAPS are highlighted in bold) |
---|---|---|
NA |
| |
Call to get the root list of folders. |
| |
A “V3thumbnail” is currently returned for images, but will be changed back to use “thumbnail” at the end of August 2020 once all filetypes are migrated to our new preview generation code. | ||
| ||
| ||
| ||
A “V3thumbnail” is currently returned for images, but will be changed back to use “thumbnail” at the end of August 2020 once all filetypes are migrated to our new preview generation code. | ||
| ||
| ||
Folder Info (GET) - TBD |
|
ORDER MANAGEMENT
To replicate the order of Folders and Files from the IntelligenceBank platform in the API Client, the following logic needs to be implemented.
FOLDERS
The order of folders to be used whenever folders are displayed is determined in the Login response with: "defaultFolderSortOrder".
Options are "name", "createTime", "sortOrder"
If the value is set to "name", then all folder calls need to be set as folder.limit(100).order(name)?verbose
If the value is set to "createTime", then all folder calls need to be set as folder.limit(100).order(createTime:-1)?verbose
If the value is set to "sortOrder", then all folder calls need to be set as folder.limit(100).order(sortorder)?verbose
For testing purposes, the current order option can be changed in the platform front end under Admin > Settings > Resources - General > Default Folder Order
RESOURCES
The order of resources to be used when returned for a specific folder _id (if isSearching=false) is determined in the Folder information with: "defaultResourceOrder"
Options are "sortOrder", "name", "lastUpdateTime", "assignedDate".
If the value is set to "name", then all folder calls need to be set as resource.limit(100).order(name)?verbose
If the value is set to "createTime", then all folder calls need to be set as resource.limit(100).order(assignedDate:-1)?verbose
If the value is set to "lastUpdateTime", then all folder calls need to be set as resource.limit(100).order(lastUpdateTime:-1)?verbose
If the value is set to "sortOrder", then all folder calls need to be set as resource.limit(100).order(sortorder)?verbose
For testing purposes, the current order option can be changed against each folder under Folder Settings > Folder Order.