Description:
Returns a list of icons that are already uploaded on the CompetitionLabs api
Resource URL:
https://<apphost>.competitionlabs.com/api/<your-space-name>/achievements/icons
Request header
Key | Value | Required |
X-API-KEY | Your unique API key | Yes |
Content-Type | application/json | Yes |
Request URL parameter
Parameter | Type | Required | Description |
---|---|---|---|
space | String | Yes | This is the space name which is linked to the account |
Additional Query String Parameters
You can use the query parameters along with the generic parameters.
Query parameters
Parameter | Type | Constraint | Usage |
---|---|---|---|
attachmentType | String | Case sensitive | ?attachmentType=search_word |
bucketName | String | Case sensitive | ?bucketName=search_word |
fileName | String | Case sensitive. For lookup you would use "fileName.raw=search_word" because the field "fileName" is indexed to support more complex searches | ?fileName.raw=search_word |
mimeType | String | Case sensitive | ?mimeType=search_word |
extension | String | Case sensitive | ?extension=search_word |
locationKey | String | Case sensitive | ?locationKey=search_word |
locationFolder | String | Case sensitive | ?locationFolder=search_word |
metadata | Array [Object] | Complex search applies, allows full search on a complex object of Metadata | ?metadata.key=search_word |
created | DateTime | Works with simple dates or date and time, eg: created=2016-02-07, created=2018-08-23T14:23:09 | ?created=search_DateTime |
id | String | Case sensitive | ?id=search_word |
EXAMPLE
ERROR CODES
Code | HTTP Status | Description | Example |
---|---|---|---|
1007 | 404 |
| |
404 | The Request URL is incorrect | ||
401 | The X-API-KEY is missing |