| Note |
|---|
A new API is now availableThis page documents IntelligenceBank's legacy API referred to as v2. Most of the calls listed below have been upgraded as part of a Please use instead the new API version, referred to as v3. For better performance and additional flexibility, please use the v3 calls when possible. v3 calls can be used in conjunction with v2 calls. Some additional calls are also only available in v3. You can access the v3 API documentation at https://apidoc.intelligencebank.com |
...
| Expand | ||
|---|---|---|
| ||
|
Overview
This service provides the ability to retrieve, add and modify digital assets that reside on an IntelligenceBank platform instance.
RFC2119 Words
The key words "MUST","MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" and "OPTIONAL" in this document are to be interpreted as described in RFP2119.
Media Type Support
All server response bodies SHOULD be returned using the JSON Media Type. All client request bodies SHOULD be sent using the application/x-www-form-urlencoded Form Media Type, or the multipart/form Media Type as appropriate.
Product Key
All calls can have a product key parameter appended to the URL as p60=KEYVALUE.
It allows to track the source of calls in the platform's Usage Reporting.
URLs and Operations
All URLs share a common base of
...
Below is a list of the endpoint URLs and the operations they perform
/login
The /login URL supports the following HTTP methods
POST using the Login Payload and returns the Login Response
/reset
The /reset URL supports the following HTTP methods
POST using the Reset Payload and returns the No Content Response
/resources
The /resources URL supports the following HTTP methods
GET using the Root Folder Request and returns the Folder Response
GET using the Folder Request and returns the Folder Response
GET using the Resource Request and returns the resource file or file size estimate
POST using the Create Folder Payload and returns the FolderResponse
POST using the Create Resource Payload and returns the Resource Response
PUT using the Update Folder Payload and returns the FolderResponse
PUT using the Update Resource Payload and returns the Resource Response
DELETE using the Delete Folder Request and returns a No Content Response
DELETE using the Delete Resource Request and returns a No Content Response
/icon
The /icon URL supports the following HTTP methods
GET using the Icon Request and returns the icon file
/comments
The /comments URL supports the following HTTP methods
GET with the Comment Request and returns the Comment Response
POST with the Comment Payload and returns the No Content Response
/sync
The /sync URL supports the following HTTP methods
POST with the Sync Payload and returns the Sync Response
/search
The /search URL supports the following HTTP methods
GET with the Search Request and returns the Search Response
/downloadpresets
The /downloadpresets URL supports the following HTTP methods
GET using the Download Preset Request and returns the Download Preset Response
Requests and Payloads
Below is a list of query strings and payloads that can be sent from the client to the server along with a list of common server responses.
...
Login
Example
p70=joe.blow@test.com&p80=mypassword&p90=test.intelligencebank.com
...
Upon successful completion of this operation, the server SHOULD return the Login Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Reset Password
Example
p70=joe.blow@test.com&p90=test.intelligencebank.com
...
Upon successful completion of this operation, the server SHOULD return the No Content Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Request Client API URL
Note that this call uses a different API.
...
In this case, URL to use for subsequent API calls is https://apiau.intelligencebank.com
...
Browser Login (For SSO Users)
Note that this call uses a different API. It enables the user to be authenticated by login to IntelligenceBank via their browser. This is useful for Single Sign On users to login into third-party applications using the IntelligenceBank API.
STEP 1
...
Warning, DO NOT use the first level SID, but always use the "sid" value returned inside "session".
...
Request Root Folder List
?p10={apikey}&p20={useruuid}
...
Upon successful completion of this operation, the server SHOULD return the Folder Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Request Folder Info
This call allows to request and retrieve details of sub-folders and number of files about one or multiple folders. If folders have a lot of files (e.g. 1000+), it is advised to make this call first to retrieve the count of files so that subsequent folder content requests can be paginated accordingly (see below).
...
The Resources URL is https://XXXXX.intelligencebank.com/webapp/1.0/resources?
...
Request Folder Content
?p10={apikey}&p20={useruuid}&folderuuid={folder uuid}&skip={starting position}&limit={number of resources to return}
...
would request the contents of the folder with that folderuuid. The response will contain metadata for all the folders and the next 50 resources within the folder.
...
Delete Folder Request
?p10={apikey}&p20={useruuid}&folderuuid={folder uuid}
...
Upon successful completion of this operation, the server SHOULD return the No Content Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Create Folder
?p10={apikey}&p20={user id}
...
Upon successful completion of this operation, the server SHOULD return the Folder Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Update Folder
?p10={apikey}&p20={user id}&folderuuid=hg3v23ghj4hb34hhjhjg34dssf
...
Upon successful completion of this operation, the server SHOULD return the Folder Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Resource Request
Context
User wants to download a file.
...
Upon successful completion of this operation, the server SHOULD return the requested file. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Delete Resource Request
?p10={apikey}&p20={useruuid}&fileuuid={folder uuid}
...
Upon successful completion of this operation, the server SHOULD return the No Content Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Create Resource
?p10={apikey}&p20={user uuid}&folderuuid={folder uuid}
...
Upon successful completion of this operation, the server SHOULD return the No Content Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Update Resource
There are two options for updating a resource. The first option is for updating the metadata of the resource only using standard POST url-form-encoded method. The second is for updating the resource file, and optionally the metadata too. The resource file can also be flagged that it should create a new version.
...
Upon successful completion of this operation, the server SHOULD return the Resource Response: "Resource updated successfully". If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Thumbnail / Icon Request
?p10={apikey}&p20={useruuid}&type={ folder | people | file }&name={ folderuuid | fileuuid | useruuid | 'folder' | 'people }&ext={ file extension desired }
...
Upon successful completion of this operation, the server SHOULD return the requested file. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Download Presets Request
?p10={apikey}&p20={useruuid}
...
Upon successful completion of this operation, the server SHOULD return the Download Preset Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Comments Request
?p10={apikey}&p20={useruuid}&fileuuid={ fileuuid }
...
Upon successful completion of this operation, the server SHOULD return the Comment Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Comment
?p10={apikey}&p20={user id}&fileuuid={ fileuuid }&version={version number}
...
Upon successful completion of this operation, the server SHOULD return the Comment Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Sync
?p10={apikey}&p20={user id}
...
Upon successful completion of this operation, the server SHOULD return the Sync Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
...
Search Request
?p10={apikey}&p20={useruuid}&searchterm={ word or words to search for }&folderuuid= {folder uuid to start search from }&fromdate={ date to search from in format YYYY-MM-DD}skip={starting position}&limit={number of resources to return}
...
Upon successful completion of this operation, the server SHOULD return the Search Response. If the operation is not successful, the server MUST return the appropriate HTTP status code and the Error Response.
Responses
Below is a list of the common responses from the server:
...
Login Response
The HTTP status code is returned with the following cookie
...
The _aid value returned in the cookie of the header is required in the header for all subsequent operations.
...
Folder Response
The HTTP status code is returned with the following body:
...
The server SHOULD return this response when the GET Root Folder Request, Folder Request, Create Folder, Update Folder operations are successful.
...
Resource Response
The HTTP status code is returned with the following body:
...
The server SHOULD return this response when the GET Resource Request with { fileinfo=true } has been successful.
...
Comment Response
The HTTP status code is returned with the following body:
...
The server SHOULD return this response when the GET Comment Request operation is successful.
...
Sync Response
The HTTP status code is returned with the following body:
...
The server SHOULD return this response when the Sync Payload operation is successful.
...
Search Response
The HTTP status code is returned with the following body:
...
The server SHOULD return this response when the Search Request operation is successful.
...
Download Presets Response
The HTTP status code is returned with the following body:
...
The server SHOULD return this response when the Download Preset Request operation is successful.
...
No Content Response
The HTTP status code is returned with no body.
The server SHOULD return this response when the Delete Folder Request, Delete Resource Request, Rest Request and Comment Payload operations are successful
...
Error Response
The HTTP status code returned is in the 4xx or 5xx family and an appropriate error message is included in the body.