Jump to

• Request
• Response

getFiles

get

/ccadmin/v1/files

Get Files. Get a list of uploaded files. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

• application/json

Query Parameters

• assetType(optional): string
  Asset type to fetch. One of: all, file or folder. If omitted, defaults to 'file'.
• filter(optional): string
  Text string to apply to name field to filter results.
• folder: string
  The folder to list. Must be a valid upload folder.
• limit(optional): integer
  Query limit.
• offset(optional): integer
  Query offset.
• sort: string
  A sort directive in the form: field:direction where direction is asc or desc.
• uploadType(optional): string
  Indicates the type of upload performed for the files.

  Allowed Values: [ "collectionImage", "crashReport", "general", "manualCollectionImage", "manualProductImage", "productImage", "thirdPartyFile", "bulkImport" ]

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getFiles_response

Type: object

Show Source

• items(optional): array items
  Result items.
• limit(optional): integer
  Query limit.
• links(optional): array links
  List of navigation links.
• offset(optional): integer
  Query offset.
• sort(optional): array sort
  Sort directive.
• total(optional): integer
  Total items found by query. Deprecated.
• totalResults(optional): integer
  Total items found by query.

{
    "properties":{
        "total":{
            "description":"Total items found by query. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total items found by query.",
            "type":"integer"
        },
        "offset":{
            "description":"Query offset.",
            "type":"integer"
        },
        "limit":{
            "description":"Query limit.",
            "type":"integer"
        },
        "links":{
            "description":"List of navigation links.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "rel":{
                        "description":"The link's relation to the current page of results: next, prev or self.",
                        "type":"string"
                    },
                    "href":{
                        "description":"The URL of the link.",
                        "type":"string"
                    }
                }
            }
        },
        "sort":{
            "description":"Sort directive.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"Sort property.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Sort order.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"Result items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "path":{
                        "description":"Full path to file, including name.",
                        "type":"string"
                    },
                    "extension":{
                        "description":"File extension.",
                        "type":"string"
                    },
                    "metadata":{
                        "description":"Seo meta info for file.",
                        "type":"object",
                        "properties":{
                            "altText":{
                                "description":"Alt text for image file.",
                                "type":"string"
                            },
                            "titleText":{
                                "description":"Title text for image file.",
                                "type":"string"
                            }
                        }
                    },
                    "size":{
                        "description":"File size in bytes.",
                        "type":"integer"
                    },
                    "name":{
                        "description":"File name without path.",
                        "type":"string"
                    },
                    "checksum":{
                        "description":"File checksum. ",
                        "type":"integer"
                    },
                    "repositoryId":{
                        "description":"The repository id of the file.",
                        "type":"string"
                    },
                    "lastModified":{
                        "description":"Last modified date and time.",
                        "type":"string"
                    },
                    "type":{
                        "description":"The item type. Set to 'file' for files.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Result items.

Show Source

• Array of: object items

{
    "description":"Result items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "path":{
                "description":"Full path to file, including name.",
                "type":"string"
            },
            "extension":{
                "description":"File extension.",
                "type":"string"
            },
            "metadata":{
                "description":"Seo meta info for file.",
                "type":"object",
                "properties":{
                    "altText":{
                        "description":"Alt text for image file.",
                        "type":"string"
                    },
                    "titleText":{
                        "description":"Title text for image file.",
                        "type":"string"
                    }
                }
            },
            "size":{
                "description":"File size in bytes.",
                "type":"integer"
            },
            "name":{
                "description":"File name without path.",
                "type":"string"
            },
            "checksum":{
                "description":"File checksum. ",
                "type":"integer"
            },
            "repositoryId":{
                "description":"The repository id of the file.",
                "type":"string"
            },
            "lastModified":{
                "description":"Last modified date and time.",
                "type":"string"
            },
            "type":{
                "description":"The item type. Set to 'file' for files.",
                "type":"string"
            }
        }
    }
}

Nested Schema : links

Type: array

List of navigation links.

Show Source

• Array of: object items

{
    "description":"List of navigation links.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "rel":{
                "description":"The link's relation to the current page of results: next, prev or self.",
                "type":"string"
            },
            "href":{
                "description":"The URL of the link.",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

Sort directive.

Show Source

• Array of: object items

{
    "description":"Sort directive.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"Sort property.",
                "type":"string"
            },
            "order":{
                "description":"Sort order.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• checksum(optional): integer
  File checksum.
• extension(optional): string
  File extension.
• lastModified(optional): string
  Last modified date and time.
• metadata(optional): object metadata
  Seo meta info for file.
• name(optional): string
  File name without path.
• path(optional): string
  Full path to file, including name.
• repositoryId(optional): string
  The repository id of the file.
• size(optional): integer
  File size in bytes.
• type(optional): string
  The item type. Set to 'file' for files.

{
    "type":"object",
    "properties":{
        "path":{
            "description":"Full path to file, including name.",
            "type":"string"
        },
        "extension":{
            "description":"File extension.",
            "type":"string"
        },
        "metadata":{
            "description":"Seo meta info for file.",
            "type":"object",
            "properties":{
                "altText":{
                    "description":"Alt text for image file.",
                    "type":"string"
                },
                "titleText":{
                    "description":"Title text for image file.",
                    "type":"string"
                }
            }
        },
        "size":{
            "description":"File size in bytes.",
            "type":"integer"
        },
        "name":{
            "description":"File name without path.",
            "type":"string"
        },
        "checksum":{
            "description":"File checksum. ",
            "type":"integer"
        },
        "repositoryId":{
            "description":"The repository id of the file.",
            "type":"string"
        },
        "lastModified":{
            "description":"Last modified date and time.",
            "type":"string"
        },
        "type":{
            "description":"The item type. Set to 'file' for files.",
            "type":"string"
        }
    }
}

Nested Schema : metadata

Type: object

Seo meta info for file.

Show Source

• altText(optional): string
  Alt text for image file.
• titleText(optional): string
  Title text for image file.

{
    "description":"Seo meta info for file.",
    "type":"object",
    "properties":{
        "altText":{
            "description":"Alt text for image file.",
            "type":"string"
        },
        "titleText":{
            "description":"Title text for image file.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
  The URL of the link.
• rel(optional): string
  The link's relation to the current page of results: next, prev or self.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"The link's relation to the current page of results: next, prev or self.",
            "type":"string"
        },
        "href":{
            "description":"The URL of the link.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  Sort order.
• property(optional): string
  Sort property.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"Sort property.",
            "type":"string"
        },
        "order":{
            "description":"Sort order.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":40,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadminui/v1/files?folder=%2Fgeneral&sort=name%3Aasc&filter=city&offset=0&limit=40"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "path":"/general/city-background.jpg",
            "extension":"jpg",
            "metadata":{
            },
            "size":102568,
            "repositoryId":"/general/city-background.jpg",
            "name":"city-background.jpg",
            "checksum":4.9987243387919718E18,
            "lastModified":"2017-01-04T09:08:08.000Z",
            "type":"file",
            "url":"http://localhost:9080/file/v4998724338791971926/general/city-background.jpg"
        }
    ]
}

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| |------------------|------------------| |33136|The "assetType" parameter value is invalid.| |33110|The "folder" param must be a valid folder.| |33109|The "folder" param is required.| |33108|The "q" param is not allowed.|

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