Jump to

• Request
• Response

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

• application/json

Body ()

Root Schema : startFileUpload_request

Type: object

Show Source

• filename: string
  The target filename. May be modified by upload type.
• segments: integer
  The number of segments that will be uploaded.
• uploadtype(optional): string
  The (optional) upload type.

{
    "properties":{
        "filename":{
            "description":"The target filename. May be modified by upload type.",
            "type":"string"
        },
        "uploadtype":{
            "description":"The (optional) upload type.",
            "type":"string"
        },
        "segments":{
            "description":"The number of segments that will be uploaded.",
            "type":"integer"
        }
    },
    "required":[
        "filename",
        "segments"
    ],
    "example":{
        "filename":"sampleFile.png",
        "segments":4
    }
}

Example:

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : startFileUpload_response

Type: object

Show Source

• segmentsNeeded(optional): array segmentsNeeded
  The array of segment numbers needed.
• token(optional): string
  The token to use when uploading segments.

{
    "properties":{
        "segmentsNeeded":{
            "description":"The array of segment numbers needed.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "token":{
            "description":"The token to use when uploading segments.",
            "type":"string"
        }
    }
}

Nested Schema : segmentsNeeded

Type: array

The array of segment numbers needed.

Show Source

• Array of: string

{
    "description":"The array of segment numbers needed.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

• 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