View a search interface

get

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

View the specified search interface in JSON format. If zip extension is specified (add ".zip" at the end of the path), the search interface is exported as a zip file.

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

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 retrieve.

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json
• application/zip

200 Response

The specified search interface.

Body

Represents a search interface in the ECR.

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

Additional Properties Allowed:

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
  Additional Properties Allowed:

Nested Schema : SearchInterfaceField

Type: object

Properties

attribute

Type: string

snippetSize

Type: string

Examples

The following example shows how to view the search interface folder of an ECR application by submitting a GET request on the REST resource using cURL:

curl -u <username>:<password> http://localhost:8006/ifcr/gsadmin/v1/{appName}/searchInterfaces

Response Body Example

The following example shows the response returned in JSON format.

{
  "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"}, 
		{"attribute": "product.short_desc"}, 
		{"attribute": "product.long_desc"}, 
		{"attribute": "ecr:crossField"}
  ]
}