Jump to

• Request
• Response

deleteFiles

post

/ccadmin/v1/files/deleteFiles

Delete Files. Delete one or more files by path

Request

Supported Media Types

• application/json

Body ()

Root Schema : deleteFiles_request

Type: object

Show Source

• 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.

{
    "properties":{
        "deletePaths":{
            "description":"Array of paths to delete. Paths must be files within a valid upload folder.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "uploadType":{
            "description":"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.",
            "type":"string",
            "enum":[
                "collectionImage",
                "crashReport",
                "general",
                "manualCollectionImage",
                "manualProductImage",
                "productImage",
                "thirdPartyFile",
                "bulkImport"
            ]
        },
        "recursive":{
            "description":"Remove directories and their contents recursively.",
            "type":"boolean"
        }
    },
    "required":[
        "deletePaths"
    ],
    "example":{
        "deletePaths":[
            "/general/logo.png",
            "/products/prod10032.jpg"
        ]
    }
}

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

• Array of: string

{
    "description":"Array of paths to delete. Paths must be files within a valid upload folder.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : deleteFiles_response

Show Source

{
    "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| |------------------|------------------| |33127|The deletePaths parameter cannot be empty.| |33115|One or more files could not be deleted.| |33126|The deletePaths parameter cannot be null.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top