Create a search interface folder

post

/gsadmin/v1/{appName}/searchInterfaces

Creates the search interface folder for the specified application.

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

Body Parameter

The search interface folder to create in the specified application.

Root Schema : SearchInterfaceFolder

Type: object

Represents the search interface folder in the ECR. Child nodes should represent search interfaces that conform to SearchInterface JSON schema.

Properties

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: search-interface-folder

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

201 Response

Search interface folder 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 the search interface folder.

:content = {
  "ecr:lastModifiedBy": "admin",
  "ecr:lastModified": "2016-01-13T08:21:15.372+05:30",
  "ecr:createDate": "2016-01-13T08:21:15.372+05:30",
  "ecr:type": "search-interface-folder",
  "All": {
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-01-13T09:28:03.310+05:30",
    "ecr:createDate": "2016-01-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"}
  ]
}