Jump to

• Request
• Response

doDeleteSSEFiles

post

/ccadmin/v1/serverExtensions/deleteFiles

Do Delete SSEFiles. Delete one or more files by path

Request

Supported Media Types

• application/json

Query Parameters

• restartExtensionServer: boolean
  If passed as false, then the extension server will not be restarted after deleting the extension
• trackProgress: boolean
  If true, then the response will contain workRequestId which can be used to track the extension server restart status.

Body ()

Root Schema : doDeleteSSEFiles_request

Type: object

Show Source

• paths(required): array paths
  Array of paths to delete. Paths must be files within a valid upload folder.

{
    "properties":{
        "paths":{
            "description":"Array of paths to delete. Paths must be files within a valid upload folder.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "paths"
    ],
    "example":{
        "paths":[
            "/productReview.zip",
            "/external%20ShippingCalculator.zip"
        ]
    }
}

Example:

{
    "paths":[
        "/productReview.zip",
        "/external%20ShippingCalculator.zip"
    ]
}

Nested Schema : paths

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

202 Response

The following model is returned when track progress query parameter is passed as true.

Body ()

Root Schema : doDeleteSSEFile_response_accepted

Type: object

Show Source

• message: string
  The message describing the status
• workRequestId: string
  The id of the restart request which can be used to track the extension server restart status.

{
    "properties":{
        "message":{
            "description":"The message describing the status",
            "type":"string"
        },
        "workRequestId":{
            "description":"The id of the restart request which can be used to track the extension server restart status.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "message":"The extension has been deleted. Please use the workRequestId to track the restart status.",
    "workRequestId":"mblNhrQ2D2"
}

204 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : doDeleteSSEFiles_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| |------------------|------------------| |100307|One or more files could not be deleted.| |14000|Extension Server could be down or not reachable. Please check your configuration or contact your system administrator.| |13014|Missing required property: {0}.| |100301|The paths parameter cannot be null.| |100302|The paths parameter cannot be empty.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "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: 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

{
    "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