Difference between revisions of "API Assets List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (→URI) |
Tommy.leung (Talk | contribs) (→URI) |
||
| Line 11: | Line 11: | ||
== URI == | == URI == | ||
| − | http://api.unroole.com/[account-id]/assets | + | <nowiki>http://api.unroole.com/[account-id]/assets</nowiki> |
== HTTP Method == | == HTTP Method == | ||
Revision as of 08:56, 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
http://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 | API Asset Fields | List of comma separated fields to be returned in the response |
Response
| Field | Type | Description |
|---|---|---|
| status | string | API Status Code |
| 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 |
