Difference between revisions of "API Assets Update File"

From unroole CMS wiki
Jump to: navigation, search
(Created page with "== Summary == Allows for replacing a particular asset with a new file. == URI == http://[channel_subdomain]-[account_subdomain].unroole.com/unroole/admin/asset/[asset_id]/cha...")
 
 
(11 intermediate revisions by one user not shown)
Line 3: Line 3:
  
 
== URI ==
 
== URI ==
http://[channel_subdomain]-[account_subdomain].unroole.com/unroole/admin/asset/[asset_id]/change_style
+
{{:API_Base_URI}}accounts/[account-id]/assets/[asset-id]/change_style
 
+
[channel_subdomain] is optional.
+
  
 
== HTTP Method ==
 
== HTTP Method ==
Line 19: Line 17:
 
! Accepted Values
 
! Accepted Values
 
! Description
 
! Description
|-
+
{{:API Required Parameter Common}}
| token
+
|
+
|
+
|
+
| [[API Persistence Token]] that identifies this user and its permissions.
+
 
|-
 
|-
 
| style
 
| style
Line 30: Line 23:
 
|
 
|
 
| {{:API Asset Styles}}
 
| {{:API Asset Styles}}
| The asset style to replace with the new file.
+
| The asset version to replace with the new file.
 
|-
 
|-
 
| file
 
| file
Line 37: Line 30:
 
|  
 
|  
 
|  
 
|  
|}
 
 
== Optional Paramaters ==
 
 
{| class="wikitable"
 
|-
 
! Paramater
 
! Default
 
! Maximum Length
 
! Accepted Values
 
! Description
 
|-
 
| regenerate
 
| true
 
|
 
| 1 - Yes <br /> 0 - No
 
| Regenerate all version based on the original
 
 
|}
 
|}
  
Line 63: Line 39:
 
! Type
 
! Type
 
! Description
 
! Description
|-
+
{{:API Response Common}}
| status
+
| string
+
| [[API Status Code]]
+
|-
+
| error
+
|
+
|
+
 
|}
 
|}

Latest revision as of 15:46, 10 December 2013

Summary

Allows for replacing a particular asset with a new file.

URI

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

HTTP Method

PUT

Required Paramaters

Paramater Default Maximum Length Accepted Values Description
token API Persistence Token that identifies this user and its permissions.
style original
  • original
  • thumb
  • icon
The asset version to replace with the new file.
file

Response

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