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: string
Asset type to fetch. One of: all, file or folder. If omitted, defaults to 'file'.
-
filter: string
Text string to apply to name field to filter results.
-
folder(required): string
The folder to list. Must be a valid upload folder.
-
limit: integer
Query limit.
-
offset: integer
Query offset.
-
sort(required): string
A sort directive in the form: field:direction where direction is asc or desc.
-
uploadType: string
Indicates the type of upload performed for the files.Allowed Values:
[ "collectionImage", "crashReport", "general", "manualCollectionImage", "manualProductImage", "productImage", "thirdPartyFile", "bulkImport" ]
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getFiles_response
Type:
Show Source
object-
items:
array items
Result items.
-
limit:
integer
Query limit.
-
links:
array links
List of navigation links.
-
offset:
integer
Query offset.
-
sort:
array sort
Sort directive.
-
total:
integer
Total items found by query. Deprecated.
-
totalResults:
integer
Total items found by query.
Nested Schema : items
Type:
Show Source
object-
checksum:
integer
File checksum.
-
extension:
string
File extension.
-
lastModified:
string
Last modified date and time.
-
metadata:
object metadata
Seo meta info for file.
-
name:
string
File name without path.
-
path:
string
Full path to file, including name.
-
repositoryId:
string
The repository id of the file.
-
size:
integer
File size in bytes.
-
type:
string
The item type. Set to 'file' for files.
Nested Schema : metadata
Type:
objectSeo meta info for file.
Show Source
-
altText:
string
Alt text for image file.
-
titleText:
string
Title text for image file.
Nested Schema : items
Type:
Show Source
object-
href:
string
The URL of the link.
-
rel:
string
The link's relation to the current page of results: next, prev or self.
Nested Schema : items
Type:
Show Source
object-
order:
string
Sort order.
-
property:
string
Sort property.
Example Response (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":"4998724338791971800",
"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.|
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code