Difference between revisions of "API Asset Fields"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (Created page with "{| class="wikitable" |- ! Field ! Type ! Description |- | id | integer | |- | name | string | |- | description | string | |- | file_name | string | |- | asset_content_type...") |
Tommy.leung (Talk | contribs) |
||
(8 intermediate revisions by one user not shown) | |||
Line 11: | Line 11: | ||
| name | | name | ||
| string | | string | ||
− | | | + | | The display name of the asset. |
|- | |- | ||
| description | | description | ||
Line 19: | Line 19: | ||
| file_name | | file_name | ||
| string | | string | ||
− | | | + | | The name of the file associated with this asset |
|- | |- | ||
− | | | + | | content_type |
| string | | string | ||
| mime-type of the asset [http://en.wikipedia.org/wiki/Internet_media_type Internet media type] | | mime-type of the asset [http://en.wikipedia.org/wiki/Internet_media_type Internet media type] | ||
Line 30: | Line 30: | ||
|- | |- | ||
| asset_updated_at | | asset_updated_at | ||
− | | datetime | + | | [http://www.w3.org/TR/NOTE-datetime ISO 8061 datetime] |
| When asset was updated (replace the asset, regenerated from original...etc.) | | When asset was updated (replace the asset, regenerated from original...etc.) | ||
|- | |- | ||
| updated_at | | updated_at | ||
− | | datetime | + | | [http://www.w3.org/TR/NOTE-datetime ISO 8061 datetime] |
| When the asset meta data was updated (name, description...etc.) | | When the asset meta data was updated (name, description...etc.) | ||
|- | |- | ||
| created_at | | created_at | ||
− | | datetime | + | | [http://www.w3.org/TR/NOTE-datetime ISO 8061 datetime] |
| When the asset was created | | When the asset was created | ||
|- | |- | ||
| type | | type | ||
| string | | string | ||
− | | | + | | {{:API_Asset_Types}} |
|- | |- | ||
| video_id | | video_id | ||
Line 49: | Line 49: | ||
| Youtube video id | | Youtube video id | ||
|- | |- | ||
− | | | + | | dimensions |
+ | | | ||
+ | | | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Field | ||
+ | ! Description | ||
+ | |- | ||
+ | | original | ||
+ | | | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Field | ||
+ | ! Type | ||
+ | |- | ||
+ | | width | ||
+ | | integer | ||
+ | |- | ||
+ | | height | ||
+ | | integer | ||
+ | |} | ||
+ | |- | ||
+ | | thumb | ||
+ | | | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Field | ||
+ | ! Type | ||
+ | |- | ||
+ | | width | ||
+ | | integer | ||
+ | |- | ||
+ | | height | ||
+ | | integer | ||
+ | |} | ||
+ | |- | ||
+ | | icon | ||
+ | | | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Field | ||
+ | ! Type | ||
+ | |- | ||
+ | | width | ||
+ | | integer | ||
+ | |- | ||
+ | | height | ||
+ | | integer | ||
+ | |} | ||
+ | |} | ||
+ | |- | ||
+ | | upload_id | ||
| string | | string | ||
− | | | + | | Unique string to help with querying for a specific set of assets uploaded in a batch |
|- | |- | ||
− | | | + | | private |
+ | | boolean | ||
+ | | Public accessibility of an asset determines if its links can be shared or bookmarked. | ||
+ | |- | ||
+ | | sharable | ||
+ | | boolean | ||
+ | | Asset can be shared through the [[Mobile Briefcase]] | ||
+ | |- | ||
+ | | editable | ||
+ | | boolean | ||
+ | | Asset can be opened in other applications through the [[Mobile Briefcase]] | ||
+ | |- | ||
+ | | printable | ||
+ | | boolean | ||
+ | | Asset can be printed through the [[Mobile Briefcase]] | ||
+ | |- | ||
+ | | used | ||
+ | | boolean | ||
+ | | If the asset is used in other parts of the cms (gallery, page, collection...etc.)<br /> | ||
+ | |- | ||
+ | | tags | ||
+ | | array of strings | ||
+ | | | ||
+ | |- | ||
+ | | url | ||
| string | | string | ||
− | | | + | | |
+ | |- | ||
+ | | styles | ||
+ | | | ||
+ | | | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Field | ||
+ | ! Description | ||
+ | |- | ||
+ | | thumb | ||
+ | | | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Field | ||
+ | ! Type | ||
|- | |- | ||
− | | | + | | url |
| string | | string | ||
− | | | + | |} |
|- | |- | ||
− | | | + | | icon |
− | | | + | | |
− | | | + | {| class="wikitable" |
|- | |- | ||
− | | | + | ! Field |
+ | ! Type | ||
+ | |- | ||
+ | | url | ||
| string | | string | ||
− | | | + | |} |
+ | |} | ||
|} | |} |
Latest revision as of 12:07, 4 June 2012
Field | Type | Description | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | integer | |||||||||||||||||||||||||||
name | string | The display name of the asset. | ||||||||||||||||||||||||||
description | string | |||||||||||||||||||||||||||
file_name | string | The name of the file associated with this asset | ||||||||||||||||||||||||||
content_type | string | mime-type of the asset Internet media type | ||||||||||||||||||||||||||
file_size | integer | in bytes | ||||||||||||||||||||||||||
asset_updated_at | ISO 8061 datetime | When asset was updated (replace the asset, regenerated from original...etc.) | ||||||||||||||||||||||||||
updated_at | ISO 8061 datetime | When the asset meta data was updated (name, description...etc.) | ||||||||||||||||||||||||||
created_at | ISO 8061 datetime | When the asset was created | ||||||||||||||||||||||||||
type | string |
| ||||||||||||||||||||||||||
video_id | string | Youtube video id | ||||||||||||||||||||||||||
dimensions |
| |||||||||||||||||||||||||||
upload_id | string | Unique string to help with querying for a specific set of assets uploaded in a batch | ||||||||||||||||||||||||||
private | boolean | Public accessibility of an asset determines if its links can be shared or bookmarked. | ||||||||||||||||||||||||||
sharable | boolean | Asset can be shared through the Mobile Briefcase | ||||||||||||||||||||||||||
editable | boolean | Asset can be opened in other applications through the Mobile Briefcase | ||||||||||||||||||||||||||
printable | boolean | Asset can be printed through the Mobile Briefcase | ||||||||||||||||||||||||||
used | boolean | If the asset is used in other parts of the cms (gallery, page, collection...etc.) | ||||||||||||||||||||||||||
tags | array of strings | |||||||||||||||||||||||||||
url | string | |||||||||||||||||||||||||||
styles |
|