Search Interfaces REST Endpoints

Sort by

Task Path Method

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: post

Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}

Create a search interface folder

Method: post

Path: /gsadmin/v1/{appName}/searchInterfaces

Delete a search interface

Method: delete

Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}

Delete a search interface folder

Method: delete

Path: /gsadmin/v1/{appName}/searchInterfaces

Partial update a search interface

Method: patch

Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}

Partial update a search interface folder

Method: patch

Path: /gsadmin/v1/{appName}/searchInterfaces

Update a search interface

Method: put

Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}

Update a search interface folder

Method: put

Path: /gsadmin/v1/{appName}/searchInterfaces

View a search interface

Method: get

Path: /gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}

View a search interface folder

Method: get

Path: /gsadmin/v1/{appName}/searchInterfaces