Partial update a search interface folder

patch

/gsadmin/v1/{appName}/searchInterfaces

Partial updates a collection of search interfaces in the existing search interface folder.

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

Body Parameter

The request body represents the updated search interface folder.

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

202 Response

Search interface folder successfully updated.

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

{
  "ecr:type": "search-interface-folder",
  "TypeAhead": {
    "ecr:type": "search-interface",
    "crossFieldMatch": "always",
    "fields": [
      {
        "snippetSize": 35,
        "attribute": "product.short_desc"
      }
    ]
  }
}