Qodex.ai

Data Exchange API

Number of APIs: 11

Offers data transfer operations as part of the Analytics package, in a single endpoint providing various operations like upload/download, move, (recursive) delete, share within tenant.
It also provides an abstraction that helps callers easily share files and folders between the users of tHe same tenant, while allowing uploads with different visibilities

  • private, or
  • public (within a tenant only)
    When looking to p[lace a file or directory (either when creating a new one or moving it) into the root of the storage, simply set the parentId of the file or folder to one of the _PUBLIC_ROOT_ID or _PRIVATE_ROOT_ID allowing in this way to specify its visibility space.
    Allowed and safe characters to use in both filename and directyory names are the following:
  • Alphanumeric characters [0-9a-zA-Z]
  • Special characters -, , ., (, ), and the space character The following are examples of valid object key names:
  • 4my-data
  • _testdir./myfile.csv

    Not allowed is using &$@=;:+,?,^{}%`[]"<>#|~!*' in filenames and directory names.
    The maximum length of the composed path, that is filename and directories names separated by '/' that is used in a request is 1024 bytes in UTF-8 encoding.

    1. files-{id} - Performs a file deletion along with its associated metadata. DELETE {{baseUrl}}/files/:id

    2. files-{id}-properties - Retrieves the file properties (metadata). GET {{baseUrl}}/files/:id/properties

    3. files-{id}-properties - Allows updating the properties (metadata) of an existing file. PATCH {{baseUrl}}/files/:id/properties

    4. files-{id} - Performs a file download GET {{baseUrl}}/files/:id

    5. files - Performs a new file upload POST {{baseUrl}}/files

    6. directories-{id}-properties - Retreives updatable directory options, i.e the name and the parentId. GET {{baseUrl}}/directories/:id/properties

    7. directories-{id} - Performs a listing of all the accessible files and folders from current specified directory; recursive parameter can also be specified for this operation GET {{baseUrl}}/directories/:id?pageNumber=<integer>&pageSize=<integer>&filter=<string>

    8. directories-{id} - Performs a directory deletion DELETE {{baseUrl}}/directories/:id?recursive=false

    9. directories - Creates a directory POST {{baseUrl}}/directories

    10. files-{id} - Allows users to update a file's contents. If the file does not already exists already, or permissions are not sufficient, an error is returned. PUT {{baseUrl}}/files/:id