Create a search interface
post
/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}
Creates a new search interface with the specified name under the search interfaces folder.
Request
Supported Media Types
- application/json
- application/zip
Path Parameters
-
appName: string
Specifies the name of your application. For example, "cloud".
-
searchInterfaceName: string
The name of the search interface to be created.
The search interface to create in the specified folder.
Root Schema : SearchInterface
Type:
object
Represents a search interface in the ECR.
Show Source
-
crossFieldMatch(optional):
string
-
ecr:createDate(optional):
string
-
ecr:lastModified(optional):
string
-
ecr:lastModifiedBy(optional):
string
-
ecr:type(optional):
string
Default Value:
search-interface
-
fields(optional):
array fields
-
isAutoWildcardEnabled(optional):
boolean
If it's set to true, all attributes in this search interface would be enabled for wildcard search. If not defined or set to false, they are not enabled for wildcard search.
Security
-
basicAuth: basic
Type:
basic
Description:Basic username/password authentication.
Response
Supported Media Types
- application/json
201 Response
Search interface successfully created.
Examples
Request Body Example
The following shows a sample request body to create a search interface.
:content = { "ecr:lastModifiedBy": "admin", "ecr:lastModified": "2016-10-13T09:28:03.310+05:30", "ecr:createDate": "2016-10-13T09:28:03.310+05:30", "ecr:type": "search-interface", "crossFieldMatch": "always", "fields": [ {"attribute": "product.id"}, {"attribute": "product.sku"} {"attribute": "product.code"} {"attribute": "product.brand.name"}, {"attribute": "product.category"}, {"attribute": "product.name"}, {"snippetSize": 25, "attribute": "product.short_desc"}, {"attribute": "product.long_desc"}, {"attribute": "ecr:crossField"} ] }