QuickSearch

Runs a quick search for assets.
Defined in: quickSearch.js.

Class Summary
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}, ... ]

A published renditions section will be sent in response with preset names and public S3 URLs as keys
and values respectively if a license for renditions is enabled.
/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"
	   },
	   "publishedRenditions": {
            "webPNG": "https://aws-cloud-host-s3Bucket/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a.png",
            "webJpeg": "https://aws-cloud-host-s3Bucket/9ff45e98-dcc0-7823-9e45-c3be6390d3bf/9ff45e98-dcc0-7823-9e45-c3be6390d3bf.jpeg",
            "webGif": "https://aws-cloud-host-s3Bucket/11a081b2-53cf-7823-bb08-2a7f75c4ccee/11a081b2-53cf-7823-bb08-2a7f75c4ccee.gif"
       },
	   "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"
	   },
	   "publishedRenditions": {
            "webPNG": "https://aws-cloud-host-s3Bucket/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a.png",
            "webJpeg": "https://aws-cloud-host-s3Bucket/9ff45e98-dcc0-7823-9e45-c3be6390d3bf/9ff45e98-dcc0-7823-9e45-c3be6390d3bf.jpeg",
            "webGif": "https://aws-cloud-host-s3Bucket/11a081b2-53cf-7823-bb08-2a7f75c4ccee/11a081b2-53cf-7823-bb08-2a7f75c4ccee.gif"
       },
	   "fields": {
		 "http://purl.org/dc/elements/1.1/ contributor": [
		   "REST"
		 ]
	   }
	 }
 ]

 A published renditions section will be sent in response with preset names and public S3 URLs as keys
and values respectively if a license for renditions is enabled.
/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"
	   },
	   "publishedRenditions": {
            "webPNG": "https://aws-cloud-host-s3Bucket/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a.png",
            "webJpeg": "https://aws-cloud-host-s3Bucket/9ff45e98-dcc0-7823-9e45-c3be6390d3bf/9ff45e98-dcc0-7823-9e45-c3be6390d3bf.jpeg",
            "webGif": "https://aws-cloud-host-s3Bucket/11a081b2-53cf-7823-bb08-2a7f75c4ccee/11a081b2-53cf-7823-bb08-2a7f75c4ccee.gif"
       },
	   "fields": {
		 "http://purl.org/dc/elements/1.1/ contributor": [
		   "REST"
		 ]
	   }
	 }
 ]

 The data block filed  will be sent in response if present in fields parameter
 /wf/restapi/v2/quickSearch

 Parameters:
 search=REST
 fields=["http://ns.mediabeacon.com/datablock/1.0/ datablock"]
 verbose=true

 Response:
 [

        "id": 201633049,
        "name": "SamplePNGImage_200kbmb.png",
        "path": "upload/root/2023.04.28 14.00.31/SamplePNGImage_200kbmb.png",
        "directoryId": 131,
        "height": 250,
        "width": 400,
        "bytes": 515716,
        "lastModified": 1682671155552,
        "mimeType": "image/png",
        "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"
	    },
	   "publishedRenditions": {
            "webPNG": "https://aws-cloud-host-s3Bucket/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a/c1ba4a79-2a82-7823-ab28-5a0a1fa8220a.png",
            "webJpeg": "https://aws-cloud-host-s3Bucket/9ff45e98-dcc0-7823-9e45-c3be6390d3bf/9ff45e98-dcc0-7823-9e45-c3be6390d3bf.jpeg",
            "webGif": "https://aws-cloud-host-s3Bucket/11a081b2-53cf-7823-bb08-2a7f75c4ccee/11a081b2-53cf-7823-bb08-2a7f75c4ccee.gif"
        },
        "replaceDate": 0,
        "versionNumber"{: 0,
        "fields": {
            "http://ns.mediabeacon.com/datablock/1.0/ datablock": [
                {
                    "http://ns.adobe.com/pdf/1.3/ Keywords": "REST"
                }
            ]
        }
    }
 ]

Classes

QuickSearch