Difference between revisions of "API Assets List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→Optional Paramaters) |
Tommy.leung (Talk | contribs) (→Response) |
||
Line 73: | Line 73: | ||
| string | | string | ||
| [[API Status Code]] | | [[API Status Code]] | ||
+ | |- | ||
+ | | http_status | ||
+ | | integer | ||
+ | | http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html | ||
|- | |- | ||
| assets | | assets |
Revision as of 09:05, 31 May 2012
Summary
Allows querying for a list of assets. The query is a wildcard search on the asset's:
- id
- name
- description
- content_type
- type
- file_name
- upload_id
- tags
URI
https://api.unroole.com/[account-id]/assets
HTTP Method
GET
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 |
---|---|---|---|---|
search | string | The search terms to be used in the query. | ||
limit | TBD | The maximum number of assets to return. | ||
fields | id, name, file_name, url | API Asset Fields | List of comma separated fields to be returned in the response |
Response
Field | Type | Description |
---|---|---|
status | string | API Status Code |
http_status | integer | http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html |
assets | array of API Asset Fields | List of files that matched the search query |
result_length | integer | Total number of results that could be returned. This may not be the number of assets in the response, as it is truncated by limit parameter. |
error |