FileResource Resource

User: david Date: 5/22/12 Time: 11:02 AM

GET /files

Request Parameters
name type description default constraints
count query 100 int
file_name query    
first query 0 int
id query    
library query false boolean
parent_binder_paths query false boolean
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /files/{id}

Request Parameters
name type description default constraints
id path    
data_name query    
force_overwrite query false boolean
last_major_version query   int
last_minor_version query   int
last_version query   int
md5 query    
mod_date query    
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /files/{id}

Request Parameters
name type description default constraints
id path    
data_name query    
force_overwrite query false boolean
last_major_version query   int
last_minor_version query   int
last_version query   int
md5 query    
mod_date query    
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /files/{id}

Request Parameters
name type description
id path
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

GET /files/{id}

Request Parameters
name type description
id path
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

GET /files/{id}/thumbnail

Request Parameters
name type description
id path
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

GET /files/{id}/scaled

Request Parameters
name type description
id path
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

DELETE /files/{id}

Request Parameters
name type description default constraints
id path    
purge query false boolean
version query   int

GET /files/{id}/access

Request Parameters
name type description
id path
Response Body
media type data type
application/json Access (JSON)
application/xml access (XML)

POST /files/{id}/name

Request Parameters
name type description
name form
id path
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /files/{id}/parent_folder

Request Parameters
name type description constraints
folder_id form long
name form  
id path  
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

GET /files/{id}/metadata

Request Parameters
name type description
id path
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /files/{id}/metadata

Request Parameters
name type description default constraints
description_format form text  
synchronize form   boolean
id path    
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

GET /files/{id}/major_version

Request Parameters
name type description
id path
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /files/{id}/major_version

Request Parameters
name type description
id path
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

GET /files/{id}/versions

Request Parameters
name type description
id path
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

GET /files/{id}/versions/current

Request Parameters
name type description
id path
Response Body
media type data type
application/json FileVersionProperties (JSON)
application/xml fileVersionProperties (XML)

POST /files/{id}/versions/current

Request Parameters
name type description
id path
Request Body
media type data type
application/json FileVersionProperties (JSON)
application/xml fileVersionProperties (XML)
Response Body
media type data type
application/json FileVersionProperties (JSON)
application/xml fileVersionProperties (XML)