Media

The Media object is used to store media files. Media files can then be attached to tasks or the user profile. There is currently a limit of 1MB per file as well as 50MB per account. As per our terms of service, any material that is published (i.e. is available to the public) must be done with the material's owner consent. No exceptions!

Media types allowed (by extension) are: jpg, jpeg, png, bmp, doc, docx, xls, xlsx, ppt, pptx, txt.

A media object contains the following fields:

 
id the media system id
filename the media's filename including extension
size the media's size in bytes
caption caption used to describe the media
isPublic whether the media is available to the public
accessUrl a time sensitive url from which the media can be downloaded
expiration the time at which the access url will expire using ISO 8601

Sample Media XML

<media>
    <id>1234</id>
    <filename>myLogo.jpg</filename>
    <size>12346</size>
    <caption>Checklist logo</caption>
    <accessUrl>http://media.checklist.com/users/4328723897429/filename.jpg</accessUrl>
    <expires>2011-12-31T16:55:31Z</expires>
    <isPublic>true</isPublic>
</media>

Supported methods

List

Method list
Description Returns all media of the current user
URL https://api.checklist.com/rest/v1/media/list [GET]
Authentication required (commercial)
Parameters None
Response List of Media objects
Errors 401UnAuthorized - returned if not authorized to perform this action
Throttling normal

Upload

Method upload
Description Upload a new media file to the platform.
URL https://api.checklist.com/rest/v1/media/upload?filename={filename}&caption={caption} [POST]
Authentication required
Parameters filenameOptional. The filename to be used (overrides the uploaded filename)
captionOptional. The media's caption. Maximum 100 characters
filepassed in the body of the request
Response the media object is returned
Errors 401UnAuthorized - returned if not authorized to perform this action. User can load itself, no other user.
Throttling normal

Re-Upload

Method upload
Description Re-uploads a file effectively replacing the media file.
URL https://api.checklist.com/rest/v1/media/{mediaId}/upload?filename={filename}&caption={caption} [PUT]
Authentication required
Parameters filenameOptional. The filename to be used (overrides the uploaded filename)
captionOptional. the media's caption
filepassed in the body of the request
Response The media object
Errors 401UnAuthorized - returned if not authorized to perform this action. User can load itself, no other user.
Throttling normal

Get

Method get
Description Get the media object including an access url and expiration time. This is used to get a "private" link to the file which is only available until expiration time.
URL https://api.checklist.com/rest/v1/media/{mediaId} [GET]
Authentication required
Parameters mediaIdthe media's id
Response The Media object including a URL and expiration
Errors 401UnAuthorized - returned if not authorized to perform this action. User can load itself, no other user.
400Invalid Parameters - returned if provided media Id is not private
Throttling normal

Delete

Method delete
Description Delete a media from the platform and free the space. If the user has used the media anywhere the media will be removed (e.g. from a task)
URL https://api.checklist.com/rest/v1/media/{mediaId}/delete [DELETE]
Authentication required
Parameters mediaIdthe media Id to be deleted
Response 200
Errors 401UnAuthorized - returned if not authorized to perform this action. User can load itself, no other user.
400Invalid Field - returned if provided media Id is invalid (does not exist)
Throttling normal
* - optional parameter.