GetVisibleSearchFields is used for fetching information about the filters that can be used for different searches. This is a search on the Digizuite product.
URL : /SearchService.js
Method : POST
Auth required : Yes
Required parameters
| Name | Example | Description |
|---|---|---|
| method | GetVisibleSearchFields | Fixed parameter that identifies the endpoint method. |
| SearchName | DigiZuite_System_Framework_Search | The search name for which filters should be returned. |
| accessKey | 2d8319f4-7a57-4ca0-a027-c44c2f259aac | AccessKey for API |
Optional parameters
N/A
cUrl data example
Success Response
Code : 200 OK
Content example
{
"searchFields":[
{
"itemId":0,
"metafieldItemId":0,
"dataTypeId":0,
"parameterName":"sAssetType",
"renderType":"assettype",
"valueHandler":"InList",
"hardcodedValues":[
]
},
{
"itemId":12996,
"metafieldItemId":12994,
"dataTypeId":61,
"parameterName":"sBitInput",
"renderType":"bool",
"valueHandler":"Equals",
"hardcodedValues":[
]
},
{
"itemId":13000,
"metafieldItemId":12998,
"dataTypeId":68,
"parameterName":"sComboValueInput",
"renderType":"combo",
"valueHandler":"Equals",
"hardcodedValues":[
]
},
{
"itemId":0,
"metafieldItemId":0,
"dataTypeId":0,
"parameterName":"sDateBetween",
"renderType":"datebetween",
"valueHandler":"Between",
"hardcodedValues":[
]
},
{
"itemId":9310,
"metafieldItemId":9309,
"dataTypeId":61,
"parameterName":"sIsPublic",
"renderType":"bool",
"valueHandler":"Equals",
"hardcodedValues":[
]
},
{
"itemId":2481,
"metafieldItemId":2380,
"dataTypeId":169,
"parameterName":"sKeywords",
"renderType":"multicombo",
"valueHandler":"AllInList",
"hardcodedValues":[
]
},
{
"itemId":5722,
"metafieldItemId":5719,
"dataTypeId":300,
"parameterName":"sMenu",
"renderType":"tree",
"valueHandler":"InList",
"hardcodedValues":[
]
},
{
"itemId":13040,
"metafieldItemId":13038,
"dataTypeId":60,
"parameterName":"sStringInput",
"renderType":"string",
"valueHandler":"Equals",
"hardcodedValues":[
]
},
{
"itemId":22406,
"metafieldItemId":22402,
"dataTypeId":68,
"parameterName":"sWorkflowStatus",
"renderType":"multicombo",
"valueHandler":"InList",
"hardcodedValues":[
]
}
],
"success":true,
"errors":[
]
}
Error Response
Code : 200 OK
Content example
{
"success": false,
"total": 0,
"error": "A critical exception occurred while we executed the search.\r\n",
"items": null,
"warnings": [{
"Severity": 150,
"Code": 420,
"Description": "A critical exception occurred while we executed the search."
}]
}