REST API for Oracle Commerce Cloud December 2017

startFileUpload

put

/ccadmin/v1/files

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

Request

Supported Media Types

application/json

Body Parameter

Root Schema : startFileUpload_request

Example


{
    "filename":"sampleFile.png",
    "segments":4
}

Properties

filename: Type: string

Required: true

The target filename. May be modified by upload type.
segments: Type: integer

Required: true

The number of segments that will be uploaded.
uploadType: Type: string

The (optional) upload type.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : startFileUpload_response

Properties

segmentsNeeded: Type: array segmentsNeeded

Additional Properties Allowed:

The array of segment numbers needed.
token: Type: string

The token to use when uploading segments.

Nested Schema : segmentsNeeded

Type: array

The array of segment numbers needed.

Items

Type: string

Example 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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "filename": "sampleFile.png",
  "segments": 4
}

Sample Response Payload returned by endpoint:

{
  "segmentsNeeded": [
    0,
    1,
    2,
    3
  ],
  "token": "a668d885784_74"
}