QuickSearch
Runs a quick search for assets.
Defined in: quickSearch.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
QuickSearch(search, directory, pageSize, pageIndex, sortField, sortDirection, verbose, FILTERS, fields)
Runs a quick search and displays the asset info for each result
|
Class Detail
QuickSearch(search, directory, pageSize, pageIndex, sortField, sortDirection, verbose, FILTERS, fields)
Runs a quick search and displays the asset info for each result
- Parameters:
- search
- a string to search on.
- directory Optional, Default: theUsersRootDirectory
- the directory path to limit the search results to.
- pageSize Optional, Default: 100
- the number of assets to give in the response
- pageIndex Optional, Default: 0
- the index of the page to return
- sortField Optional
- the namespace of the desired field ex "http://purl.org/dc/elements/1.1/ subject"
- sortDirection Optional
- "ASC" or "DESC". the order in which the sortFiled should be applied
- verbose Optional, Default: false
- Setting this to true will collect a variety of default values for each asset.
- FILTERS Optional
- Filtering can be applied to the "id", "name", "path", "height", "width", "bytes", "lastModified", "mimeType", and "resolver" properties if verbose=true.
- fields Optional
- An array of field id's to collect the values for each asset
- Returns:
- [{AssetData}, ... ]
/wf/restapi/v2/quickSearch
Parameters:
search=REST
verbose=true
fields=["http://purl.org/dc/elements/1.1/ contributor"]
Response:
[
{
"id": 201629349,
"name": "REST.xmp",
"path": "REST.xmp",
"height": 1,
"width": 1,
"bytes": 2048,
"lastModified": 1508164732000,
"mimeType": "application/octet-stream",
"previews": {
"thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363239333439",
"viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363239333439",
"downloadUrl": "../servlet/dload?id=pe_323031363239333439"
},
"fields": {
"http://purl.org/dc/elements/1.1/ contributor": null
}
},
{
"id": 201624280,
"name": "opo0123_orig.tif",
"path": "hubble/opo0123_orig.tif",
"height": 732,
"width": 1435,
"bytes": 3153629,
"lastModified": 1506953377000,
"mimeType": "image/tiff",
"previews": {
"thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363234323830",
"viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363234323830",
"downloadUrl": "../servlet/dload?id=pe_323031363234323830"
},
"fields": {
"http://purl.org/dc/elements/1.1/ contributor": [
"REST"
]
}
}
]
/wf/restapi/v2/quickSearch
Parameters:
search=REST
directory=hubble/
verbose=true
Response:
[
{
"id": 201624280,
"name": "opo0123_orig.tif",
"path": "hubble/opo0123_orig.tif",
"height": 732,
"width": 1435,
"bytes": 3153629,
"lastModified": 1506953377000,
"mimeType": "image/tiff",
"previews": {
"thumbnail": "../servlet/jb.view?table=thumbnails&col=thumbnails&id=pe_323031363234323830",
"viewex": "../servlet/jb.view?table=viewex&col=viewex&id=pe_323031363234323830",
"downloadUrl": "../servlet/dload?id=pe_323031363234323830"
},
"fields": {
"http://purl.org/dc/elements/1.1/ contributor": [
"REST"
]
}
}
]