Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getUploadTypes_response

Type: object

Show Source

• items(optional): array items
  Parameters with respect to upload types.

{
    "properties":{
        "items":{
            "description":"Parameters with respect to upload types.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"Display name of file upload type.",
                        "type":"string"
                    },
                    "name":{
                        "description":"Name of the file upload type.",
                        "type":"string"
                    },
                    "mayUnzip":{
                        "description":"May we unzip the file.",
                        "type":"boolean"
                    },
                    "overrideTargetDirectory":{
                        "description":"Target directory to override the file.",
                        "type":"string"
                    },
                    "class":{
                        "description":"Class of the file upload type.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Parameters with respect to upload types.

Show Source

• Array of: object items

{
    "description":"Parameters with respect to upload types.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"Display name of file upload type.",
                "type":"string"
            },
            "name":{
                "description":"Name of the file upload type.",
                "type":"string"
            },
            "mayUnzip":{
                "description":"May we unzip the file.",
                "type":"boolean"
            },
            "overrideTargetDirectory":{
                "description":"Target directory to override the file.",
                "type":"string"
            },
            "class":{
                "description":"Class of the file upload type.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• class(optional): string
  Class of the file upload type.
• displayName(optional): string
  Display name of file upload type.
• mayUnzip(optional): boolean
  May we unzip the file.
• name(optional): string
  Name of the file upload type.
• overrideTargetDirectory(optional): string
  Target directory to override the file.

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Display name of file upload type.",
            "type":"string"
        },
        "name":{
            "description":"Name of the file upload type.",
            "type":"string"
        },
        "mayUnzip":{
            "description":"May we unzip the file.",
            "type":"boolean"
        },
        "overrideTargetDirectory":{
            "description":"Target directory to override the file.",
            "type":"string"
        },
        "class":{
            "description":"Class of the file upload type.",
            "type":"string"
        }
    }
}

Example Response (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

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