REST API for Oracle Commerce Cloud December 2017

deleteMediaItems

post

/ccadmin/v1/files/deleteMediaItems

Delete Media Items. Delete one or more media items by path

Request

Supported Media Types

application/json

Body Parameter

Root Schema : deleteMediaItems_request

Example


{
    "deletePaths":[
        "/general/logo.png",
        "/products/prod10032.jpg"
    ]
}

Properties

deletePaths: Type: array deletePaths

Required: true

Additional Properties Allowed:

Array of paths to delete. Paths must be files within media folders.

Nested Schema : deletePaths

Type: array

Array of paths to delete. Paths must be files within media folders.

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : deleteMediaItems_response

Properties

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| |------------------|------------------| |33116|Invalid encoding error. The encoding UTF-8 is not supported.| |33127|The deletePaths parameter cannot be empty.| |33115|One or more media files could not be deleted.| |33126|The deletePaths parameter cannot be null.|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{"deletePaths": [
  "/general/logo.png",
  "/products/prod10032.jpg"
]}