Check filetype functions

Configuration API

OVERVIEW

Purpose

API method to check if the file type is supported for a specific functionality. For example if a file type is supported by online viewer or not. The client will send a single file extension in query string for which it wants to find the available functions, and in response Collaborate will respond with available functions for that filetype.

Request URI

GET /configuration/filetypefunctions

Query Parameter

Parameter Name	Description
filetype ( required)	Provide the file extension for which the details are required

Confirmations and assumptions

Access rights of this API has been given a value of "ACCESS_ALL", which means everyone with a valid account can access this method.

Filetype parameter is a required parameter.
If blank filetype query parameter is supplied then an error message will be returned.
A error message is displayed If filetype query param contains any of the following characters \ / ? : * " > < | .
If the filetype is not present in the Collaborate system and the filetype is controlled in Collaborate using a block list. If the requested filetype is not present in the black list then default values will be returned for this filetype.
An error message is returned if the requested filetype parameter has a length greater than 50 characters.
"allowed" tag in the response XML determines if file of that type can be added to the system or not. A value of 0 means that a file with the specific extension cannot be inserted in the system and 1 means it can be inserted into the system.

Request URL

Example : https://domain.com/instancename/api/1/configuration/filetypefunctions?filetype=txt

Response XML

Response XML

<configuration>
   <filetypes>
      <filetype>
         <type>txt</type>
         <typeicon>https://domain.com/instancename/images/fileicon/txt.png</typeicon>
         <typedesc>Plain Text Document</typedesc>
         <onlineviewersupport>1</onlineviewersupport>
         <preconvertbeforeviewer>0</preconvertbeforeviewer>
         <converttopdf>1</converttopdf>
         <ocrsupport>0</ocrsupport>
         <editwithwebdav>0</editwithwebdav>
         <displayname />
         <allowed>1</allowed>
      </filetype>
   </filetypes>
</configuration>

Parameter Name
Description


type
the file extension

typeicon
URI to get the icon for the file type as represented in Collaborate

typedesc
Description of the file type

onlineviewersupport
 Flag to indicate if the specific filetype is supported with the online viewer or not

preconvertbeforeviewer
Is the file type converted before being sent to the online viewer

converttopdf
Is the file of this filetype converted to PDF when they are uploaded to the system, this is for DRM support

ocrsupport
Is this filetype supported by the OCR

editwithwebdav
Can files of this type be edited in MS office, this option will only be true for MS office files

displayname
Name of the filetype as displayed in Collaborate

allowed
Is the file allowed in Collaborate

Parameter Name	Description
type	the file extension
typeicon	URI to get the icon for the file type as represented in Collaborate
typedesc	Description of the file type
onlineviewersupport	Flag to indicate if the specific filetype is supported with the online viewer or not
preconvertbeforeviewer	Is the file type converted before being sent to the online viewer
converttopdf	Is the file of this filetype converted to PDF when they are uploaded to the system, this is for DRM support
ocrsupport	Is this filetype supported by the OCR
editwithwebdav	Can files of this type be edited in MS office, this option will only be true for MS office files
displayname	Name of the filetype as displayed in Collaborate
allowed	Is the file allowed in Collaborate

Response Code

Code	Meaning
200	Response successfully
401	Unauthorized
403	Validation failed/ Forbidden
405	Method not allowed (API called with a wrong method)
500	Internal error occurred while uploading document

Comments

0 Comments

Last Updated: Nov 08,2024