Versions Compared

Old Version 5

changes.mady.by.user Charly Vanni

Saved on

compared with

New Version Current

changes.mady.by.user Charly Vanni

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

V2 Call

V3 Call

Comments (GAPS are highlighted in bold)

Login / Authentication (POST)

NA

  • V2 Login / Authentication to still be used, including for the Browser Login option (if implemented).

  • The following parameters returned in the response are to be used for subsequent V3 calls:

    • “apiV3url”

    • “clientid”

    • “sid” (in headers)

Root Folders (GET)

Call to get the root list of folders.

Folders List (GET)

  • Get root Folders and get sub-folders are now part of the same base call.

Folder Content (GET)

Folders List (GET)

Resources List (GET)

Resources List (POST - for advanced search queries)

Public Share Link Request (GET)

  • Resources and Sub-Folders are now retrieved via 2 separate calls.

  • Check the count on the parent folder to know if there are sub-folders or resources to retrieve.

  • To get sub-folders, simply include the parent folder uuid in Params of the Folders List call.

  • “publicURL” parameter is not returned in the Resources List call anymore. A dedicated “Public Share Link” call is now available to get that information for any asset that is listed as isPublic = true in the Resources List response.

  • Thumbnail URL is to be retrieved in “thumbnail” parameter.

Note

A “V3thumbnail” is currently returned for images, but will be changed back to use “thumbnail” at the end of August October 2020 once all filetypes are migrated to our new preview generation code.

Download File (GET)

Download File (GET)

  • Note that Presets can now be requested for download directly via a Preset id.

Download File Preview (GET)

Download File Preview (GET)

Download Image With Transformations (GET)

Download File (GET)

  • Ability to get File Size estimate is not available in V3 at this point, and still pending scheduling and development.

    • V2 call can still be used for now.

Presets List (GET)

Presets List (GET)

  • Files can now have their own individual presets (i.e. Single Presets).

Thumbnail Icon (GET)

Folders List (GET)

Resources List (GET)

  • Thumbnail icons are now returned as a field of folder or resource object (“thumbnail”).

Note

A “V3thumbnail” is currently returned for images, but will be changed back to use “thumbnail” at the end of August October 2020 once all filetypes are migrated to our new preview generation code.

Create Resource (POST)

Update Resource (PUT / POST)

File Upload (POST)

Create Resource (POST)

Update Resource (PUT)

  • Upload of the file itself is now separated from creating or updating the resource.

Delete Resource (DELETE)

Delete Resource (DELETE)

Create Folder (POST)

Create Folder (POST)

  • Note the current limitations in the V3 call description.

Sync Call (GET)

Resource List (GET)

Resource Info (GET)

Folder Info (GET) - TBD

  • No directly equivalent call - request specific objects directly to view their Info in V3:

    • For Resources: You can use Resources List (GET or POST) with searchParams[keywords] applied (multiple UUIDs can be included in a single request, e.g. UUID1 UUID2 UUID3).

    • For Folders: Use Folder List (GET) searchParams[keywords] applied (multiple UUIDs can be included in a single request, e.g. UUID1 UUID2 UUID3).

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

Info

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

...

    • )

...

    • .