1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Agent
  4. Files

doFileSegmentUpload

post

/ccagent/v1/files/{id}

Do File Segment Upload. Upload a segment as part of a resumable file upload. Requires a token obtained from startFileUpload or resumeFileUpload. Note that all responses except for the response to the last segment will only have a success property (no result property).

Request

Supported Media Types
Path Parameters
  • ID of file to be uploaded which is same as token value.
Body ()
Root Schema : doFileSegmentUpload_request
Type: object
Show Source
  • The base64 encoded file content for the segment.
  • The target file name.
  • The index of the segment being uploaded.
  • Allowed Values: [ "collectionImage", "crashReport", "general", "manualCollectionImage", "manualProductImage", "productImage", "thirdPartyFile", "bulkImport" ]
    (optional) Identifies the type of file upload to be performed. For example, if uploading a file containing a very large number (bulk) of records for import, use 'uploadType: bulkImport'.
Example:
{
    "filename":"sampleFile.png",
    "file":"/9j/4AAQSkZJRgABAQEASABIAAD/4gIcSUNDX1BST0ZJTEUAAQEAAAIMbGNtcwIQAABtbnRyUkdCIFhZWiAH3AABABkAAwApADlhY3NwQVBQTAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA9tYAAQAAAADTLWxjbXMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAApkZXNjAAAA/AAAAF5jcHJ0AAABXAAAAAt3dHB0AAABaAAAABRia3B0AAABfAAAABRyWFlaAAABkAAAABRnWFlaAAABpAAAABRiWFlaAAABuAAAABRyVFJDAAABzAAAAEBnVFJDAAABzAAAAEBiVFJDAAABzAAAAEBkZXNjAAAAAAAAAANjMgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB0ZXh0AAAAAEZCAABYWVogAAAAAAAA9tYAAQAAAADTLVhZWiAAAAAAAAADFgAAAzMAAAKkWFlaIAAAAAAAAG+iAAA49QAAA5BYWVogAAAAAAAAYpkAALeFAAAY2lhZWiAAAAAAAAAkoAAAD4QAALbPY3VydgAAAAAAAAAaAAAAywHJA2MFkghrC/YQPxVRGzQh8SmQMhg7kkYFUXdd7WtwegWJsZp8rGm/fdPD6TD////hAIBFeGlmAABNTQAqAAAACAAFARIAAwAAAAEAAQAAARoABQAAAAEAAABKARsABQAAAAEAAABSASgAAwAAAAEAAgAAh2kABAAAAAEAAABaAAAAAAAAAEgAAAABAAAASAAAAAEAAqACAAQAAAABAAAAAqADAAQAAAABAAAAAwAAAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHhofHx0aHRwhJS8oISMsIxwdKTgpLDEyNTU1ICc6PjkzPS80NTP/2wBDAQkJCQwLDBgNDRgzIh0iMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzMzP/wgARCAADAAIDASIAAhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAX/xAAUAQEAAAAAAAAAAAAAAAAAAAAC/9oADAMBAAIQAxAAAAGwAv/EABYQAQEBAAAAAAAAAAAAAAAAAAECEv/aAAgBAQABBQKQx//EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQMBAT8Bf//EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAIAQIBAT8Bf//EABcQAAMBAAAAAAAAAAAAAAAAAAABIUH/2gAIAQEABj8CUw//xAAWEAEBAQAAAAAAAAAAAAAAAAABADH/2gAIAQEAAT8hcqMX/9oADAMBAAIAAwAAABDz/8QAFhEAAwAAAAAAAAAAAAAAAAAAAAER/9oACAEDAQE/EKz/xAAUEQEAAAAAAAAAAAAAAAAAAAAA/9oACAECAQE/EH//xAAXEAEAAwAAAAAAAAAAAAAAAAABACEx/9oACAEBAAE/EHkFRU2p/9k=",
    "index":3,
    "token":"a668d885784_74"
}
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : doFileSegmentUpload_response
Type: object
Show Source
Example Response (application/json)
{
    "success":true
}

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| |------------------|------------------| |413|Please upload a file smaller than one GB| |13004|The token value is missing for this upload| |13005|Could not save file segment for unknown filename. The startUpload() or resumeUpload() method must be called before uploading individual file segments| |13014|Missing required property: {0}| |20306|The filename is invalid| |13006|The token value for this upload is no longer valid. Discontinue upload attempts for segments of this file|
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