startFileUpload

put

/ccadmin/v1/files

Start a resumable file upload that allows uploading the file in segments. Individual file segments can be uploaded via the 'doFileSegmentUpload' endpoint.

NOTE: Use the appropriate uploadType for the type of data being uploaded. For example, if uploading a file containing a very large number of records for bulk import, use 'uploadType=bulkImport' to greatly improve overall system performance.

Request

Supported Media Types
Body ()
Root Schema : startFileUpload_request
Type: object
Show Source
Example:
{
    "filename":"sampleFile.png",
    "segments":4
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : startFileUpload_response
Type: object
Show Source
Nested Schema : segmentsNeeded
Type: array
The array of segment numbers needed.
Show Source
Example Response (application/json)
{
    "segmentsNeeded":[
        0,
        1,
        2,
        3
    ],
    "token":"a668d885784_74"
}

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| |------------------|------------------| |13014|Missing required property: {0}| |20306|The filename is invalid|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top