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

getMediaContents

get

/ccadmin/v1/files/mediaContents

Get Media Contents. Get a list of media folder contents. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
  • application/json
Query Parameters
filter
Type: string
Text string to apply to name field to filter results.
folder
Type: string
Required: true
One of: all, products, collections or general.
includeOnlyWhitelisted
Type: boolean
If true, include only whitelisted file types in the response.
limit
Type: integer
Query limit.
metadata
Type: string
Seo meta info for product. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |altText|string|Alt text for product image.| |titleText|string|Title text for product image.|
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 : getMediaContents_response
Nested Schema : items
Type: array
Result items.
Nested Schema : metadata
Type: object
Seo meta info for product.
Nested Schema : sort
Type: array
Sort directive.
Nested Schema : items
Type: object
Nested Schema : metadata
Type: object
Seo meta info for image.
Nested Schema : items
Type: object
Example application/json

{
    "total":1,
    "metadata":{
        "altText":"city background",
        "titleText":"city background"
    },
    "offset":0,
    "limit":250,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/files/mediaContents?folder=all&sort=name%3Aasc&filter=city"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "path":"/general/city-background.jpg",
            "extension":"jpg",
            "size":102568,
            "name":"city-background.jpg",
            "checksum":4.9987243387919718E18,
            "repositoryId":"/general/city-background.jpg",
            "lastModified":"2014-12-16 12:28:14.0",
            "type":"file"
        }
    ]
}
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| |------------------|------------------| |33114|There was an error while attempting to execute the query.| |33112|There was an error while attempting to create the query.| |33113|There was an error while attempting to get the storage system view.| |33110|The "folder" param must be a valid folder.| |33111|Storage system does not support this query.| |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,
  "metadata": {
    "altText": "city background",
    "titleText": "city background"
  },
  "offset": 0,
  "limit": 250,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadminui/v1/files/mediaContents?folder=all&sort=name%3Aasc&filter=city"
  }],
  "sort": [{
    "property": "name",
    "order": "asc"
  }],
  "items": [{
    "path": "/general/city-background.jpg",
    "extension": "jpg",
    "size": 102568,
    "name": "city-background.jpg",
    "checksum": 4998724338791972000,
    "repositoryId": "/general/city-background.jpg",
    "lastModified": "2014-12-16 12:28:14.0",
    "type": "file"
  }]
}