Jump to

• Request
• Response
• Examples

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

Supported Media Types

• application/json

Path Parameters

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

Body ()

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.

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

202 Response

Search interface folder successfully updated.

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

Back to Top