deleteFiles
post
/ccadmin/v1/files/deleteFiles
Delete Files. Delete one or more files by path
Request
Supported Media Types
- application/json
Root Schema : deleteFiles_request
Type:
Show Source
object
-
deletePaths:
array deletePaths
Array of paths to delete. Paths must be files within a valid upload folder.
-
recursive(optional):
boolean
Remove directories and their contents recursively.
-
uploadType(optional):
string
Allowed Values:
[ "collectionImage", "crashReport", "general", "manualCollectionImage", "manualProductImage", "productImage", "thirdPartyFile", "bulkImport" ]
Indicates the type of uploaded file to be deleted. For example, when deleting an import file that was uploaded with uploadType=bulkImport, you must also specify uploadType=bulkImport when deleting it. Files uploaded with uploadType=bulkImport cannot be deleted with any other upload type.
Example:
{
"deletePaths":[
"/general/logo.png",
"/products/prod10032.jpg"
]
}
Nested Schema : deletePaths
Type:
array
Array of paths to delete. Paths must be files within a valid upload folder.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
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|
|------------------|------------------|
|33127|The deletePaths parameter cannot be empty.|
|33115|One or more files could not be deleted.|
|33126|The deletePaths parameter cannot be null.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code