Search Interfaces REST Endpoints
Admin/Search Admin and Configuration/Search Interfaces
Search interfaces enable users to perform a record search on a group of dimensions or properties as if they were a single property. It is configured by a JSON document that includes attributes and fields. This section describes how to create, modify, view, and delete search interface configurations.
- Create a search interface
- Method: postPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Create a search interface folder
- Method: postPath:
/gsadmin/v1/{appName}/searchInterfaces
- Delete a search interface
- Method: deletePath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Delete a search interface folder
- Method: deletePath:
/gsadmin/v1/{appName}/searchInterfaces
- Partial update a search interface
- Method: patchPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Partial update a search interface folder
- Method: patchPath:
/gsadmin/v1/{appName}/searchInterfaces
- Update a search interface
- Method: putPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- Update a search interface folder
- Method: putPath:
/gsadmin/v1/{appName}/searchInterfaces
- View a search interface
- Method: getPath:
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
- View a search interface folder
- Method: getPath:
/gsadmin/v1/{appName}/searchInterfaces