Difference between revisions of "API Assets List"
From unroole CMS wiki
Tommy.leung (Talk | contribs) (Created page with "== 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 * ta...") |
Tommy.leung (Talk | contribs) |
||
| Line 17: | Line 17: | ||
== HTTP Method == | == HTTP Method == | ||
GET | GET | ||
| + | |||
== Required Paramaters == | == Required Paramaters == | ||
| Line 32: | Line 33: | ||
| | | | ||
| [[API Persistence Token]] that identifies this user and its permissions. | | [[API Persistence Token]] that identifies this user and its permissions. | ||
| + | |} | ||
| + | |||
| + | == Optional Paramaters == | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! 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 == | ||
| + | |||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! 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 | ||
| + | | | ||
| + | | | ||
|} | |} | ||
Revision as of 09:43, 29 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://[channel_subdomain]-[account_subdomain].unroole.com/unroole/admin/assets/list
[channel_subdomain] is optional
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 |
