get https://{your-domain}.com/list
List the root directory
200 (Success)
The list of assets and directories contained within a directory.
The following fields appear within an array[object]
directory with each item representing the assets and subdirectories available.
Field Name | Type | Description |
---|---|---|
name | string | The name of the asset. |
type | string Allowed Values: jpeg, png, directory, 3g2, 3gp, 3gpp, asf, avi, dat, divx, dv, f4v, flv, m2ts, m4v, mkv, mov, mp4, mpe, mpeg, mpeg4, mpg, mts, nsv, ogm, ogv, qt, tod, ts, vob, wmv, mod | The type of the asset. Either a specific media format or directory . |
size | integer Format: int64 Minimum: 0 | |
id | string | The id of the asset or directory. This can be any string, but typically is either a static alpha-numeric or absolute path representing the asset or directory. |
400 (Generic Error)
Field Name | Type | Description |
---|---|---|
error* | string Example: ASSET_NOT_FOUND | Name of the error or code. This should be a short string or number which will make sense to the middleware or connected DAM. |
message* | string Example: The asset does not exist, please select another asset. | The message that will be related to the user in Khoros Marketing. This should be a human understandable description of what happened and ideally what steps the user can take next. |
401 (Invalid Authentication)
Authentication method is invalid or has become de-authenticated.
404 (Not Found)
Specified resource path was not found or does not exist.
500 (Unexpected Error)
Unexpected error.
Field Name | Type | Description |
---|---|---|
error* | string Example: ASSET_NOT_FOUND | Name of the error or code. This should be a short string or number which will make sense to the middleware or connected DAM. |
message* | string Example: The asset does not exist, please select another asset. | The message that will be related to the user in Khoros Marketing. This should be a human understandable description of what happened and ideally what steps the user can take next. |