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
• Response
• Examples

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application, for example, Discover.

searchInterfaceName

Type: string

Required: true

The name of the search interface to be created.

Body Parameter

The search interface to create in the specified folder.

Root Schema : SearchInterface

Type: object

Represents a search interface in the ECR.

Properties

crossFieldMatch

Type: string

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: search-interface

fields

Type: array fields

isAutoWildcardEnabled

Type: 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.

Nested Schema : fields

Type: array

Items

• Type: object SearchInterfaceField

Nested Schema : SearchInterfaceField

Type: object

Properties

attribute

Type: string

snippetSize

Type: string

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

201 Response

Search interface successfully created.

Body

Root Schema : Response

Type: object

Properties

message

Type: string

status

Type: integer (int32)

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"}
  ]
}