Files

Loading...
The Files API provides persistence of files, such as comment attachments and report images.With this version File API will now support versioned files. A solution can maintain multiple versions of a file. There are few additional parameters which will be required while creation of File, which indicates that the File is a versioned file.

Files

The CRUD (Create, Read, Update, Delete) operations for files.
get
Get file resources
Internal-Use OnlyRetrieves file resources for the specified criteria. Standard paging, filtering, and sorting options are available.
/files
delete
Delete file resources
Internal-Use OnlyDeletes file resources for the specified parentUri. If the user is not authorized to delete all matching files, no files are deleted.
/files
get
Get schema for indexing
Internal-Use OnlyThis endpoint returns schema field to be indexed by search service.
/files
post
Create new file resource
Internal-Use OnlyCreates a new file resource by passing file content in the request body.
/files
post
Create a new file resource
Internal-Use OnlyCreates a new file resource by passing a file in the form of a multipart request.
/files
post
Get file resources for multiple parentUris
Internal-Use OnlyRetrieves the file resources that are associated with multiple parentUri specifications. Request the parentUri values in the body. The returned collection is grouped by parentUri.
/files
head
Check if a file resource exists
Internal-Use OnlyDetermines whether a file resource exists for the specified fileId.
/files/{fileId}
get
Get a file resource
Internal-Use OnlyRetrieves a file resource by specifying a fileId.
/files/{fileId}
put
Update a file resource
Internal-Use OnlyUpdates the file resource information. The user can change these attributes: name, description, parentUri, documentType, contentDisposition, properties,expirationTimeStamp,typeDefName and searchable
/files/{fileId}
patch
Update a file resource
Internal-Use OnlyUpdates the file resource information. The user can change these attributes: name, description, parentUri, documentType, contentDisposition, properties, expirationTimeStamp,typeDefName and searchable
/files/{fileId}
delete
Delete a file resource
Internal-Use OnlyDeletes the file resource.
/files/{fileId}
get
Get file resource content
Internal-Use OnlyRetrieves the content of the file resource.
/files/{fileId}/content
put
Update file resource content
Internal-Use OnlyUpdates the content of the file resource.
/files/{fileId}/content
post
Copy an existing file
Internal-Use OnlyCopies the file if the user has Read access to the specified file.
/files/{fileId}/copy
head
Check if a file resource exists for given fileVersion
Internal-Use OnlyDetermines whether a file resource exists for the specified version of fileId.
/files/{fileId}/version/{fileVersion}
get
Get a file resource for specific version
Internal-Use OnlyRetrieves a file resource by specifying fileVersion of a fileId.
/files/{fileId}/version/{fileVersion}
get
Get the file resource content for a specified version
Internal-Use OnlyRetrieves the content of the file resource for a specified version.
/files/{fileId}/version/{fileVersion}/content
get
Get all the versions of a given file id
Internal-Use OnlyRetrieves file resources of all the versions of a given fileId. Standard paging, option is available.
/files/{fileId}/versions