Jump to

• Request
• Response
• Examples

Create a search interface folder

post

/gsadmin/v1/{appName}/searchInterfaces

Creates the search interface folder for the specified application.

Request

Supported Media Types

• application/json
• application/zip

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".

Body ()

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.

Show Source

• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type(optional): string
  Default Value: search-interface-folder

{
    "type":"object",
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"search-interface-folder"
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        }
    },
    "description":"Represents the search interface folder in the ECR. Child nodes should represent search interfaces that conform to SearchInterface JSON schema."
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Search interface folder successfully created.

Body ()

Root Schema : Response

Type: object

Show Source

• message(optional): string
• status(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

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

Back to Top