Jump to

• Request
• Response

doSSEFileUploadMultipart

post

/ccadmin/v1/serverExtensions

Do SSE File Upload Multipart. Upload a file using multipart/form-data (not JSON).

Request

Supported Media Types

• multipart/form-data

Form Parameters

• fileUpload: file
  The file form input element.
• filename: string
  The file name.
• force: boolean
  an optional parameter that will allow to update an previously uploaded SSE file
• uploadType: string
  an optional parameter that can specify an optional upload type.

  Allowed Values: [ "extensions" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : doSSEFileUploadMultipart_response

Type: object

Show Source

• result(optional): object result
  Indicates the upload result
• success(optional): boolean
  Indicates whether at least one file uploaded successfully.
• token(optional): string
  Token generated for multipart upload.

{
    "properties":{
        "result":{
            "description":"Indicates the upload result",
            "type":"object",
            "properties":{
                "newFiles":{
                    "description":"Number of new files uploaded.",
                    "type":"integer"
                },
                "modifiedFiles":{
                    "description":"Number of files modified",
                    "type":"integer"
                },
                "unzipped":{
                    "description":"Indicates whether the file upload was unzipped or not.",
                    "type":"boolean"
                },
                "failedImages":{
                    "description":"Number of failed images.",
                    "type":"integer"
                },
                "allImagesFailed":{
                    "description":"Indicates whether upload for all images failed or not",
                    "type":"boolean"
                },
                "failedImagesReasons":{
                    "additionalProperties":{
                        "description":"The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'",
                        "type":"integer"
                    },
                    "type":"object"
                },
                "modifiedImages":{
                    "description":"Number of images modified",
                    "type":"integer"
                },
                "failedFilesReasons":{
                    "additionalProperties":{
                        "description":"The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'",
                        "type":"integer"
                    },
                    "type":"object"
                },
                "fileResults":{
                    "description":"File uploading results.",
                    "type":"array",
                    "items":{
                        "description":"The result of uploading one file.",
                        "type":"object",
                        "properties":{
                            "new":{
                                "description":"Whether this is a new file. A false value means it is replacing an existing file.",
                                "type":"boolean"
                            },
                            "rejected":{
                                "description":"Indicates whether the file was rejected.",
                                "type":"boolean"
                            },
                            "overwritten":{
                                "description":"Whether this file was overwritten by another in the same upload.",
                                "type":"boolean"
                            },
                            "success":{
                                "description":"Indicates whether file upload was successfull or not.",
                                "type":"boolean"
                            },
                            "destination":{
                                "description":"The destination file path.",
                                "type":"string"
                            },
                            "associatedItems":{
                                "description":"The list of URIs for the items this file was associated with.",
                                "type":"array",
                                "items":{
                                    "description":"The URI for the item this file was associated with.",
                                    "type":"string"
                                }
                            },
                            "source":{
                                "description":"The source file path.",
                                "type":"string"
                            },
                            "rejection":{
                                "description":"Reason for rejection.",
                                "type":"string"
                            }
                        }
                    }
                },
                "failedFiles":{
                    "description":"Number of failed files.",
                    "type":"integer"
                },
                "allFilesFailed":{
                    "description":"Indicates whether upload for all files failed or not",
                    "type":"boolean"
                },
                "uploadType":{
                    "description":"The type of upload for this result.",
                    "type":"string"
                },
                "newImages":{
                    "description":"Number of new images uploaded.",
                    "type":"integer"
                },
                "assignedImages":{
                    "description":"Number of assigned images",
                    "type":"integer"
                },
                "hadSuccess":{
                    "description":"Indicates whether at least one file uploaded successfully",
                    "type":"boolean"
                }
            }
        },
        "success":{
            "description":"Indicates whether at least one file uploaded successfully.",
            "type":"boolean"
        },
        "token":{
            "description":"Token generated for multipart upload.",
            "type":"string"
        }
    }
}

Nested Schema : result

Type: object

Indicates the upload result

Show Source

• allFilesFailed(optional): boolean
  Indicates whether upload for all files failed or not
• allImagesFailed(optional): boolean
  Indicates whether upload for all images failed or not
• assignedImages(optional): integer
  Number of assigned images
• failedFiles(optional): integer
  Number of failed files.
• failedFilesReasons(optional): object failedFilesReasons
  Additional Properties Allowed: additionalProperties
• failedImages(optional): integer
  Number of failed images.
• failedImagesReasons(optional): object failedImagesReasons
  Additional Properties Allowed: additionalProperties
• fileResults(optional): array fileResults
  File uploading results.
• hadSuccess(optional): boolean
  Indicates whether at least one file uploaded successfully
• modifiedFiles(optional): integer
  Number of files modified
• modifiedImages(optional): integer
  Number of images modified
• newFiles(optional): integer
  Number of new files uploaded.
• newImages(optional): integer
  Number of new images uploaded.
• unzipped(optional): boolean
  Indicates whether the file upload was unzipped or not.
• uploadType(optional): string
  The type of upload for this result.

{
    "description":"Indicates the upload result",
    "type":"object",
    "properties":{
        "newFiles":{
            "description":"Number of new files uploaded.",
            "type":"integer"
        },
        "modifiedFiles":{
            "description":"Number of files modified",
            "type":"integer"
        },
        "unzipped":{
            "description":"Indicates whether the file upload was unzipped or not.",
            "type":"boolean"
        },
        "failedImages":{
            "description":"Number of failed images.",
            "type":"integer"
        },
        "allImagesFailed":{
            "description":"Indicates whether upload for all images failed or not",
            "type":"boolean"
        },
        "failedImagesReasons":{
            "additionalProperties":{
                "description":"The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'",
                "type":"integer"
            },
            "type":"object"
        },
        "modifiedImages":{
            "description":"Number of images modified",
            "type":"integer"
        },
        "failedFilesReasons":{
            "additionalProperties":{
                "description":"The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'",
                "type":"integer"
            },
            "type":"object"
        },
        "fileResults":{
            "description":"File uploading results.",
            "type":"array",
            "items":{
                "description":"The result of uploading one file.",
                "type":"object",
                "properties":{
                    "new":{
                        "description":"Whether this is a new file. A false value means it is replacing an existing file.",
                        "type":"boolean"
                    },
                    "rejected":{
                        "description":"Indicates whether the file was rejected.",
                        "type":"boolean"
                    },
                    "overwritten":{
                        "description":"Whether this file was overwritten by another in the same upload.",
                        "type":"boolean"
                    },
                    "success":{
                        "description":"Indicates whether file upload was successfull or not.",
                        "type":"boolean"
                    },
                    "destination":{
                        "description":"The destination file path.",
                        "type":"string"
                    },
                    "associatedItems":{
                        "description":"The list of URIs for the items this file was associated with.",
                        "type":"array",
                        "items":{
                            "description":"The URI for the item this file was associated with.",
                            "type":"string"
                        }
                    },
                    "source":{
                        "description":"The source file path.",
                        "type":"string"
                    },
                    "rejection":{
                        "description":"Reason for rejection.",
                        "type":"string"
                    }
                }
            }
        },
        "failedFiles":{
            "description":"Number of failed files.",
            "type":"integer"
        },
        "allFilesFailed":{
            "description":"Indicates whether upload for all files failed or not",
            "type":"boolean"
        },
        "uploadType":{
            "description":"The type of upload for this result.",
            "type":"string"
        },
        "newImages":{
            "description":"Number of new images uploaded.",
            "type":"integer"
        },
        "assignedImages":{
            "description":"Number of assigned images",
            "type":"integer"
        },
        "hadSuccess":{
            "description":"Indicates whether at least one file uploaded successfully",
            "type":"boolean"
        }
    }
}

Nested Schema : failedFilesReasons

Type: object

Additional Properties Allowed

Show Source

• integer
  The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'

{
    "additionalProperties":{
        "description":"The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'",
        "type":"integer"
    },
    "type":"object"
}

Nested Schema : failedImagesReasons

Type: object

Additional Properties Allowed

Show Source

• integer
  The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'

{
    "additionalProperties":{
        "description":"The table of rejection reasons. Can be any of 'UNKNOWN_REASON', 'INVALID_NAME', 'INVALID_EXTENSION', 'VIRUS_DETECTED', 'VIRUS_SCAN_FAILED', 'INVALID_CONTENT', 'INVALID_ENCODING'",
        "type":"integer"
    },
    "type":"object"
}

Nested Schema : fileResults

Type: array

File uploading results.

Show Source

• Array of: object items
  The result of uploading one file.

{
    "description":"File uploading results.",
    "type":"array",
    "items":{
        "description":"The result of uploading one file.",
        "type":"object",
        "properties":{
            "new":{
                "description":"Whether this is a new file. A false value means it is replacing an existing file.",
                "type":"boolean"
            },
            "rejected":{
                "description":"Indicates whether the file was rejected.",
                "type":"boolean"
            },
            "overwritten":{
                "description":"Whether this file was overwritten by another in the same upload.",
                "type":"boolean"
            },
            "success":{
                "description":"Indicates whether file upload was successfull or not.",
                "type":"boolean"
            },
            "destination":{
                "description":"The destination file path.",
                "type":"string"
            },
            "associatedItems":{
                "description":"The list of URIs for the items this file was associated with.",
                "type":"array",
                "items":{
                    "description":"The URI for the item this file was associated with.",
                    "type":"string"
                }
            },
            "source":{
                "description":"The source file path.",
                "type":"string"
            },
            "rejection":{
                "description":"Reason for rejection.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

The result of uploading one file.

Show Source

• associatedItems(optional): array associatedItems
  The list of URIs for the items this file was associated with.
• destination(optional): string
  The destination file path.
• new(optional): boolean
  Whether this is a new file. A false value means it is replacing an existing file.
• overwritten(optional): boolean
  Whether this file was overwritten by another in the same upload.
• rejected(optional): boolean
  Indicates whether the file was rejected.
• rejection(optional): string
  Reason for rejection.
• source(optional): string
  The source file path.
• success(optional): boolean
  Indicates whether file upload was successfull or not.

{
    "description":"The result of uploading one file.",
    "type":"object",
    "properties":{
        "new":{
            "description":"Whether this is a new file. A false value means it is replacing an existing file.",
            "type":"boolean"
        },
        "rejected":{
            "description":"Indicates whether the file was rejected.",
            "type":"boolean"
        },
        "overwritten":{
            "description":"Whether this file was overwritten by another in the same upload.",
            "type":"boolean"
        },
        "success":{
            "description":"Indicates whether file upload was successfull or not.",
            "type":"boolean"
        },
        "destination":{
            "description":"The destination file path.",
            "type":"string"
        },
        "associatedItems":{
            "description":"The list of URIs for the items this file was associated with.",
            "type":"array",
            "items":{
                "description":"The URI for the item this file was associated with.",
                "type":"string"
            }
        },
        "source":{
            "description":"The source file path.",
            "type":"string"
        },
        "rejection":{
            "description":"Reason for rejection.",
            "type":"string"
        }
    }
}

Nested Schema : associatedItems

Type: array

The list of URIs for the items this file was associated with.

Show Source

• Array of: string
  The URI for the item this file was associated with.

{
    "description":"The list of URIs for the items this file was associated with.",
    "type":"array",
    "items":{
        "description":"The URI for the item this file was associated with.",
        "type":"string"
    }
}

Example Response (application/json)

{
    "result":{
        "unzipped":false,
        "failedImages":0,
        "allImagesFailed":false,
        "failedImagesReasons":{
        },
        "modifiedImages":1,
        "newImages":0,
        "assignedImages":0
    },
    "success":true,
    "links":[
        {
            "rel":"self",
            "href":"/serverExtensions"
        }
    ],
    "token":"ff8eba3a8a2c_16fe"
}

Example Response (description)

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| |------------------|------------------| |20306|The filename is invalid|

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