Find here the list of actions to apply on the objects, and the data reference for this object.

What is a file ?

An upload_file is a file located on our servers. This file can be attached to nothing, or to any object of your application.

Getting the files list

GET /upload_files.xml

Returns all files, page by page
Add a page parameter to navigate

Getting a single file

GET /upload_files/#{id}.xml

Returns a single file, identified by its id

Creating a new file

POST /upload_files.xml

Creates a new file, and returns the file data

Updating an existing file

PUT /upload_files/#{id}.xml

Updates some fields of an existing file

Deleting an existing file

DELETE /upload_files/#{id}.xml

Deletes the file identified by its id

Object data

<upload_file>
 <id>id of this object</id>
 <upload_file_name>name of the file</upload_file_name>
 <object_zname>name of the object it's attached to, if any</object_zname>
 <object_zid>id of the object it's attached to, if any</object_zid>
 <upload_file_size>size in octets of the file</upload_file_size>
 <upload_file_description>user description</upload_file_description>
 <file_data>file content bytes</file_data>
</upload_file>