Jump to

• Request
• Response
• Examples

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

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• searchInterfaceName: string
  The name of the search interface to retrieve.

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The specified search interface.

Body ()

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.

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"search-interface"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        },
        "isAutoWildcardEnabled":{
            "type":"boolean",
            "description":"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."
        },
        "crossFieldMatch":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SearchInterfaceField"
            }
        }
    },
    "description":"Represents a search interface in the ECR."
}

Nested Schema : fields

Type: array

Show Source

• Array of: object SearchInterfaceField

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SearchInterfaceField"
    }
}

Nested Schema : SearchInterfaceField

Type: object

Show Source

• attribute(optional): string
• snippetSize(optional): string

{
    "type":"object",
    "properties":{
        "attribute":{
            "type":"string"
        },
        "snippetSize":{
            "type":"string"
        }
    }
}

Back to Top

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

Back to Top