Difference between revisions of "API Assets Upload"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Optional Paramaters) |
Tommy.leung (Talk | contribs) (→Optional Paramaters) |
||
Line 55: | Line 55: | ||
| asset[name] | | asset[name] | ||
| Filename with spaces replaced with underscores. | | Filename with spaces replaced with underscores. | ||
− | | 255 | + | | 255 characters |
| | | | ||
| The name of the asset. | | The name of the asset. | ||
Line 61: | Line 61: | ||
| asset[description] | | asset[description] | ||
| | | | ||
− | | | + | | ~17000 characters |
| | | | ||
| The description of the asset. | | The description of the asset. | ||
Line 67: | Line 67: | ||
| asset[tag_list] | | asset[tag_list] | ||
| | | | ||
− | | ∞ | + | | ∞, but each tag is 255 characters |
| | | | ||
| List of comma separated tags (e.g. Ruby, HTML5, css3). | | List of comma separated tags (e.g. Ruby, HTML5, css3). |
Revision as of 14:25, 28 May 2012
Contents
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 Persistence Token that identifies this user and its permissions. | |||
asset[asset][] | List of files. 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 characters | The name of the asset. | |
asset[description] | ~17000 characters | The description of the asset. | ||
asset[tag_list] | ∞, but each tag is 255 characters | List of comma separated tags (e.g. Ruby, HTML5, css3). | ||
asset[private] | 0 | 1 - Private 0 - Not private |
Public accessibility of an asset determines if its links can be shared or bookmarked. | |
sharable | 0 | 1 - Yes 0 - No |
Asset can be shared through the Mobile Briefcase | |
editable | 0 | 1 - Yes 0 - No |
Asset can be opened in other applications through the Mobile Briefcase | |
printable | 0 | 1 - Yes 0 - No |
Asset can be printed through the Mobile Briefcase |
Response
Field | Type | Description |
---|---|---|
status | string | API Status Code |
success_files | array of API Asset Fields | List of files that were successfully uploaded |
failed_files | array of files names | List of file names that failed to uploaded |
error |