Difference between revisions of "API Assets Upload"

From unroole CMS wiki
Jump to: navigation, search
Line 21: Line 21:
 
! Default
 
! Default
 
! Maximum Length
 
! Maximum Length
 +
! Accepted Values
 
! Description
 
! Description
 
|-
 
|-
 
| token
 
| token
 
|  
 
|  
 +
|
 
|
 
|
 
| [[API Persistance Token]] that identifies this user and its permissions.
 
| [[API Persistance Token]] that identifies this user and its permissions.
 +
|-
 +
| asset[asset][]
 +
|
 +
|
 +
|
 +
| List of file assets. Not required if asset[video_id][] is specified.
 +
|-
 +
| asset[video_id][]
 +
|
 +
|
 +
|
 +
| List of youtube videos. The unique video id or url provided by youtube. ex: (LADHwoN2LMM, http://www.youtube.com/watch?v=LADHwoN2LMM). Not required if asset[asset][] is specified.
 
|}
 
|}
  
Line 36: Line 50:
 
! Default
 
! Default
 
! Maximum Length
 
! Maximum Length
 +
! Accepted Values
 
! Description
 
! Description
 
|-
 
|-
Line 41: Line 56:
 
| Filename with spaces replaced with underscores.
 
| Filename with spaces replaced with underscores.
 
| 255
 
| 255
 +
|
 
| The name of the asset.
 
| The name of the asset.
 
|-
 
|-
Line 46: Line 62:
 
|  
 
|  
 
| ∞
 
| ∞
 +
|
 
| The description of the asset.
 
| The description of the asset.
 
|-
 
|-
Line 51: Line 68:
 
|
 
|
 
| ∞
 
| ∞
| List of comma separated tags (e.g. Ruby, HTML5, css3)
+
|
 +
| List of comma separated tags (e.g. Ruby, HTML5, css3).
 +
|-
 +
| asset[private]
 +
| 0
 +
|
 +
| 0 - Yes<br />1 - No
 +
| Public accessibility of an asset determines if its links can be shared or bookmarked.
 +
|-
 +
| sharable
 +
| false
 +
|
 +
| true - Yes<br />false - No
 +
| Asset can be shared through the [[Mobile Briefcase]]
 +
|-
 +
| editable
 +
| false
 +
|
 +
| true - Yes<br />false - No
 +
| Asset can be opened in other applications through the [[Mobile Briefcase]]
 +
|-
 +
| printable
 +
| false
 +
|
 +
| true - Yes<br />false - No
 +
| Asset can be printed through the [[Mobile Briefcase]]
 
|}
 
|}

Revision as of 12:55, 28 May 2012

Summary

Allows for uploading a new asset.

URI

http://[channel-subdomain].[account-subdomain].unroole.com/unroole/admin/assets

[channel-subdomain] is optional

HTTP Method

POST

Required Paramaters

Paramater Default Maximum Length Accepted Values Description
token API Persistance Token that identifies this user and its permissions.
asset[asset][] List of file assets. Not required if asset[video_id][] is specified.
asset[video_id][] List of youtube videos. The unique video id or url provided by youtube. ex: (LADHwoN2LMM, http://www.youtube.com/watch?v=LADHwoN2LMM). Not required if asset[asset][] is specified.

Optional Paramaters

Paramater Default Maximum Length Accepted Values Description
asset[name] Filename with spaces replaced with underscores. 255 The name of the asset.
asset[description] The description of the asset.
asset[tag_list] List of comma separated tags (e.g. Ruby, HTML5, css3).
asset[private] 0 0 - Yes
1 - No
Public accessibility of an asset determines if its links can be shared or bookmarked.
sharable false true - Yes
false - No
Asset can be shared through the Mobile Briefcase
editable false true - Yes
false - No
Asset can be opened in other applications through the Mobile Briefcase
printable false true - Yes
false - No
Asset can be printed through the Mobile Briefcase