REST API for Oracle Commerce Cloud December 2017

getUploadTypes

get

/ccadmin/v1/files/uploadTypes

Get Upload Types. Get a description of the available upload types.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getUploadTypes_response

Properties

items: Type: array items

Additional Properties Allowed:

Parameters with respect to upload types.

Nested Schema : items

Type: array

Parameters with respect to upload types.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

class: Type: string

Class of the file upload type.
displayName: Type: string

Display name of file upload type.
mayUnzip: Type: boolean

May we unzip the file.
name: Type: string

Name of the file upload type.
overrideTargetDirectory: Type: string

Target directory to override the file.

Example application/json


{
    "items":[
        {
            "displayName":"Category Image(s)",
            "name":"categoryImage",
            "mayUnzip":true,
            "overrideTargetDirectory":"/category"
        },
        {
            "displayName":"Product Image(s)",
            "name":"productImage",
            "mayUnzip":true,
            "overrideTargetDirectory":"/product"
        }
    ]
}

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 Response Payload returned by endpoint:

{"items": [
  {
    "displayName": "Category Image(s)",
    "name": "categoryImage",
    "mayUnzip": true,
    "overrideTargetDirectory": "/category"
  },
  {
    "displayName": "Product Image(s)",
    "name": "productImage",
    "mayUnzip": true,
    "overrideTargetDirectory": "/product"
  }
]}