DC 5.3.0 6.2 - Search
- Tobias Thornfeldt Wolters
- Anonymous
Digizuite API offers a highly customizeable and rich endpoint for searching in metadata. The search service has a number of static searches and may be extended and customized after most custom wishes. As explained in the authentication section, a product definition contains configuration and a number of searches that may be changed to accommodate special needs. These searches may be found under System tools → Config Manager → Product (e.g. Digizuite DAM Center). The config manager has a searches tab in which all customizeable searches are available.
A search is defined by a set of input parameters and a set of output parameters. The input parameters are parameters that are used to search on and the output parameters is what is returned in the result. An example of this could be have the input parameter could as assetid and the output the title and description of the asset. This enables the search service to search on assetids and return the title and description of the asset.
See documentation on the search editor for a good explanation on what a search is and how it may be customized.
The documentation does NOT document all the searches. It explains how the search service is used and then it is up to the reader to explore the capabilities.
For Search Service there are a number of optional parameters that may be used for all endpoints:
| Name | Example | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Page | 1 | Used in conjunction with the parameter Limit to control which page of the result set you want | ||||||||||
| Limit | 99 | Used in conjunction with the parameter Page to control the size of each page If no limit is specified, it defaults to 25 | ||||||||||
| accessKey | b77ca504-4335-4343-9109-11166a11ea0f | Valid access key from Digizuite | ||||||||||
#param#_type_MultiStrings | 1 | Bool (0/1) parameter that tells whether the input parameter #param# can be duplicated to perform a multiple OR search using strings.
In order to use this parameter, the #param# must have a comparison type of type InList | ||||||||||
| #param#_type_MultiIds | 1 | Bool (0/1) parameter that tells whether the input parameter #param# can specify multiple comma separated integers in order to perform a multiple OR search.
In order to use this parameter, the #param# must have a comparison type of type InList |