REST API for Oracle Commerce Cloud December 2017

resumeFileUpload

put

/ccadmin/v1/files/{id}

Resume File Upload. Resume an interrupted file upload. Uses the same input and output format as startFileUpload, except the segments needed list represents the remaining segments to upload.

Request

Supported Media Types

application/json

Path Parameters

id: Type: string

Required: true

ID of file to be uploaded which is same as token value.

Body Parameter

Root Schema : resumeFileUpload_request

Example


{
    "filename":"sampleFile.png",
    "token":"a668d885784_74",
    "segments":5
}

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.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : resumeFileUpload_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

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",
  "token": "a668d885784_74",
  "segments": 5
}

Sample Response Payload returned by endpoint:

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