Folder / Files API
Overview

OVERVIEW

1       The site is described as a folder within itself, is this expected behaviour for the output?

Yes. Collaborate creates a default folder for each site, named after the site itself.


2.       It looks like the mandatory parameters of ParentFolderID and dmsDatabasename are ignored as I always just get the folder structure starting from the site.

You can receive all child folders for site (means childs of site's root folder), at this time ParentFolderID and dmsDatabasename are not necessary.


3.       There is no way to retrieve folders below the first level of the site.

To get child of any subfolder of site's root folder ParentFolderID  and dmsDatabasename  are mandatory, it will only return those child which are created using API call. Currently you don't have created any folder

using API call so you are not able to retrive any child. For example, create any folder X under "Tikit" folder and Y as child of X using API and pass dmsDatabasename=Tikit during creation. Now if you try to retrive child of X by passing folderid of X as parentFolderID and "Tikit" as dmsDatabasename then you will get Y.

4.       I am getting a 204 error on file upload

In order to resolve the  204 (No content) error code make sure that you use the same charater encoding for the content as specified in the headers

i.e.: in the following exampe charset=UTF-16 is defined so the value "Test" should be encoded with UTF-16 as well

************************************************************

--a8ca11fe-ccc0-47d5-808c-0a1f1c512dad--

Content-Disposition: form-data; name="documentname"

Content-Type: text/plain; charset=UTF-16

Test

************************************************************
if value not set with utf-16 encoding in above exmaple it will give 204

 

Q. I want to work with JSON, does your API support JSON

A. HighQ API does support JSON, please set the header parameter of 

Accept = application/JSON

in your request

and you can send the request and receive the response in JSON format. All methods support both XML and JSON format. 

 

Q) Does the system allow duplicate file names 

A) This is the default behaviour of Collaborate

Q)  Has a concept of Add Large File, seems to imply that Add File will timeout (do we have to use Large?  What is the size that required?)

A) There is no hard and fast rule for this, but It depends on the network speed and the load on the server, for most purposes its perfectly fine to use the normal file upload to upload files, its only when you are thinking about uploading very large files like 100 mb or 1 GB etc then you should be using Large file upload

Q)  What is the maximum file size to upload?

A) The upload size is limited by the size allocated on the server for the specific instance and the configuration. We have tested the setup with more than 2 GB of individual file upload

Q)  What is the restrictions on Site, Folder and File Names?  Any special characters invalid? What is the size limit?

A) Collaborate API follows the same rules for file names as it does in the UI, only < and > characters are not allowed in document names. 

Q)  Can you impersonate a user?  I can't find support.  Is there a concept of Owner of a file?  For permissions?

A) Please see the impersonation API here. The user uploading a new file becomes the author of the file, and in order to upload a file, you need to have upload rights to the folder. 

 

Comments


2 Comments

Last Updated: Nov 08,2024