1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Files

getFiles

get

/ccadmin/v1/files

Get Files. Get a list of uploaded files. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
  • application/json
Query Parameters
assetType
Type: string
Asset type to fetch. One of: all, file or folder. If omitted, defaults to 'file'.
filter
Type: string
Text string to apply to name field to filter results.
folder
Type: string
Required: true
The folder to list. Must be a valid upload folder.
limit
Type: integer
Query limit.
offset
Type: integer
Query offset.
sort
Type: string
Required: true
A sort directive in the form: field:direction where direction is asc or desc.
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getFiles_response
Nested Schema : items
Type: array
Result items.
Nested Schema : sort
Type: array
Sort directive.
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Seo meta info for file.
Nested Schema : items
Type: object
Example application/json

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":40,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/files?folder=%2Fgeneral&sort=name%3Aasc&filter=city&offset=0&limit=40"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "path":"/general/city-background.jpg",
            "extension":"jpg",
            "metadata":{
            },
            "size":102568,
            "repositoryId":"/general/city-background.jpg",
            "name":"city-background.jpg",
            "checksum":4.9987243387919718E18,
            "lastModified":"2017-01-04T09:08:08.000Z",
            "type":"file",
            "url":"http://localhost:9080/file/v4998724338791971926/general/city-background.jpg"
        }
    ]
}
Default Response
The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |33136|The "assetType" parameter value is invalid.| |33110|The "folder" param must be a valid folder.| |33109|The "folder" param is required.| |33108|The "q" param is not allowed.|
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 40,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/files?folder=%2Fgeneral&sort=name%3Aasc&filter=city&offset=0&limit=40"
  }],
  "sort": [{
    "property": "name",
    "order": "asc"
  }],
  "items": [{
    "path": "/general/city-background.jpg",
    "extension": "jpg",
    "metadata": {},
    "size": 102568,
    "repositoryId": "/general/city-background.jpg",
    "name": "city-background.jpg",
    "checksum": 4998724338791972000,
    "lastModified": "2017-01-04T09:08:08.000Z",
    "type": "file",
    "url": "http://localhost:9080/file/v4998724338791971926/general/city-background.jpg"
  }]
}