Difference between revisions of "API Assets Update"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→URI) |
(→URI) |
||
(5 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
+ | <div style="color:red;font-weight:bold;font-size:20px">DRAFT</div><br\> | ||
+ | |||
== Summary == | == Summary == | ||
Allows for updating metadata of a particular asset. | Allows for updating metadata of a particular asset. | ||
== URI == | == URI == | ||
− | {{:API_Base_URI}}[account-id]/assets/[asset-id] | + | {{:API_Base_URI}}accounts/[account-id]/assets/[asset-id] |
== HTTP Method == | == HTTP Method == | ||
Line 17: | Line 19: | ||
! Accepted Values | ! Accepted Values | ||
! Description | ! Description | ||
− | + | {{:API Required Parameter Common}} | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|} | |} | ||
== Optional Paramaters == | == Optional Paramaters == | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Paramater | ||
+ | ! Default | ||
+ | ! Maximum Length | ||
+ | ! Accepted Values | ||
+ | ! Description | ||
{{:API_Assets_Create_Update_Parameter}} | {{:API_Assets_Create_Update_Parameter}} | ||
+ | |} | ||
== Response == | == Response == |
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 |