GetVisibleSearchFields is used for fetching information about the filters that can be used for different searches. This is a search on the Digizuite product.Some searches support faceted search and filtering. This can be used to obtain more details about the filters available and provide a better user experience
Fetching the faceted filters
URL : /SearchService.js
Method : POST
Auth required : Yes
Required parameters
Name | Example | Description |
---|
SearchName | DigiZuite_System_Framework_Search | Fixed parameter that identifies the endpoint |
search. |
config | facet=true | Enables the faceting search. |
config | facet.limit=101 | Limits the number of options returned for each filter . |
config | facet.field={!ex=sAssetType}sAssetType | Enabled faceted result for the filter sAssetType. A list of all filters can be obtain using the DC 5.4.0 6.2.10 - GetVisibleSearchFields endpoint. |
config | f.sAssetType.facet.sort=count | Sorts the options returns or the sAssetType filter. Available values:
|
accessKey | 2d8319f4-7a57-4ca0-a027-c44c2f259aac | AccessKey for API |
Optional parameters
N/A
cUrl data example
Info | ||
---|---|---|
| ||
--data "methodSearchName=GetVisibleSearchFields&searchName=DigiZuite_System_Framework_Search&accessKey=d8eb5e9a-cf83-4cf0-a1f9-16d7a8e51cfb&config=facet=true&config=facet.field=%7B!ex=sAssetType%7DsAssetType&config=f.sAssetType.facet.sort=count" |
Success Response
Code : 200 OK
Content example
Code Block | ||
---|---|---|
| ||
{ "searchFieldssuccess":[true, { "itemIderror":0"", "metafieldItemIdtotal":0"3396", "dataTypeId":0, "parameterName":"sAssetType", "renderType":"assettype",items":[ /* ...items returned by the search... */ ], "extra":[ { "valueHandlerresponseHeader":"InList",{ "hardcodedValueswarnings":[] }, { "itemId":12996, "metafieldItemId":12994Raising facet.mincount from 0 to 1, because field sAssetType is Points-based.", "dataTypeId":61 ], "parameterNamestatus":"sBitInput0", "renderTypeQTime":"bool2", "valueHandlerparams":"Equals",{ "hardcodedValuesfacet.field":[] }, { "itemId":13000{!ex=sAssetType}sAssetType", "metafieldItemId":12998], "dataTypeId":68, "parameterNamef.sAssetType.facet.sort":"sComboValueInputcount", "renderTypestart":"combo0", "valueHandlersort":"EqualssortAssetidDesc desc", "hardcodedValuesrows":[] }"1", { "itemIdfacet.limit":0, "metafieldItemId":0"101", "dataTypeId":0, "parameterNamewt":"sDateBetweenxml", "renderTypefacet":"datebetweentrue", "valueHandler":"Between",} "hardcodedValues":[]} }, { "itemIdfacet_counts":9310,{ "metafieldItemIdfacet_queries":9309{}, "dataTypeIdfacet_fields":61,{ "parameterNamesAssetType":"sIsPublic",{ "renderType4":"bool3013", // Number of asset of asset type 4 "valueHandler1":"Equals135", "hardcodedValues":[] }, { // Number of asset of asset type 1 "itemId8":2481, "metafieldItemId":2380"72", "dataTypeId":169, "parameterName14":"sKeywords43", "renderType15":"multicombo37", "valueHandler9":"AllInList21", "hardcodedValues2":[]"17", }, { "itemId10":5722, "metafieldItemId":5719"13", "dataTypeId":300, "parameterName16":"sMenu10", "renderType17":"tree10", "valueHandler11":"InList9", "hardcodedValues5":[]"6", }, { "itemId7":13040, "metafieldItemId":13038"4", "dataTypeId":60, "parameterName18":"sStringInput2", "renderType19":"string2", "valueHandler100":"Equals2", "hardcodedValues":[] }, { "itemId":22406}, "metafieldItemIdfacet_ranges":22402{}, "dataTypeId":68, "parameterNamefacet_intervals":"sWorkflowStatus"{}, "renderType":"multicombo", "valueHandlerfacet_heatmaps":"InList",{} "hardcodedValues":[]} } ], "success":true, "errors":[] } |
Error Response
Code : 200 OK
...