Difference between revisions of "API Assets Update"

From unroole CMS wiki
Jump to: navigation, search
(URI)
 
Line 5: Line 5:
  
 
== URI ==
 
== URI ==
{{:API_Base_URI}}assets/[asset-id]
+
{{:API_Base_URI}}accounts/[account-id]/assets/[asset-id]
  
 
== HTTP Method ==
 
== HTTP Method ==

Latest revision as of 17:19, 9 December 2013

DRAFT
<br\>

Summary

Allows for updating metadata of a particular asset.

URI

https://api.unroole.com/accounts/[account-id]/assets/[asset-id]

HTTP Method

PUT

Required Paramaters

Paramater Default Maximum Length Accepted Values Description
token API Persistence Token that identifies this user and its permissions.

Optional Paramaters

Paramater Default Maximum Length Accepted Values Description
name Filename with spaces replaced with underscores. 255 characters string The name of the asset.
description MySQL TEXT UTF-8 string The description of the asset.
tag_list ∞, but each tag is 255 characters string List of comma separated tags (e.g. Ruby, HTML5, css3).
private false boolean Public accessibility of an asset determines if its links can be shared or bookmarked.
sharable false boolean Asset can be shared through the Mobile Briefcase
editable false boolean Asset can be opened in other applications through the Mobile Briefcase
printable false boolean Asset can be printed through the Mobile Briefcase

Response

Field Type Description
http_status integer API Status Code
http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
error Rails default