View a search interface



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.


Supported Media Types
Path Parameters
Back to Top


Supported Media Types

200 Response

The specified search interface.
Body ()
Root Schema : SearchInterface
Type: object
Represents a search interface in the ECR.
Show Source
Nested Schema : fields
Type: array
Show Source
Nested Schema : SearchInterfaceField
Type: object
Show Source
Back to Top


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": ""}, 
		{"attribute": "product.sku"}, 
		{"attribute": "product.code"}, 
		{"attribute": ""}, 
		{"attribute": "product.category"}, 
		{"attribute": ""}, 
		{"attribute": "product.short_desc"}, 
		{"attribute": "product.long_desc"}, 
		{"attribute": "ecr:crossField"}
Back to Top