Partial update a search interface

patch

/gsadmin/v1/{appName}/searchInterfaces/{searchInterfaceName}

Partial updates an existing search interface under the 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.

searchInterfaceName

Type: string

Required: true

The name of the search interface to be partially updated.

Body Parameter

The request body represents the partially updated search interface configuration.

Root Schema : SearchInterface

Type: object

Represents a search interface in the ECR.

Properties

crossFieldMatch

Type: string

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Default Value: search-interface

fields

Type: array fields

Additional Properties Allowed:

isAutoWildcardEnabled

Type: 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.

Nested Schema : fields

Type: array

Items

• Type: object SearchInterfaceField
  Additional Properties Allowed:

Nested Schema : SearchInterfaceField

Type: object

Properties

attribute

Type: string

snippetSize

Type: string

Security

basicAuth

Type: basic

Description: Basic username/password authentication.

Response

Supported Media Types

• application/json

202 Response

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

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