You can export a search interface in ZIP format in order to view it or back it up.

You can also retrieve a search interface in JSON format in order to edit and then save it. Typically, retrieving the default search interface All is the first step to take when you modify it to meet your requirements, or use it as the basis of a new search interface.

To export search interface configuration in a ZIP file, use the following endpoint:

GET /gsadmin/v1/cloud/searchInterfaces/All.zip

where:

To retrieve search interface configuration in JSON format, use the following GET request:

GET /gsadmin/v1/cloud/searchInterfaces/All.json

Note: The search interface name is not included in the JSON for the configuration of an individual search interface.

The following example illustrates the JSON representation of a search interface named All that can be returned by the GET requests above:

{
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-03-27T13:39:15.486Z",
    "ecr:createDate": "2016-03-27T13:39:15.486Z",
    "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"
        },
        {
            "attribute": "product.long_desc"
        },
        {
            "attribute": "ecr:crossField"
        }
    ]
}

Note: The requests GET /gsadmin/v1/cloud/searchInterfaces.zip and GET /gsadmin/v1/cloud/searchInterfaces.json return a list of search interfaces that does not include the full configurations of the individual search interfaces. Because only one search interface is currently supported, these requests are of minimal value; for example, they return results such as the following:

{
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-08-03T10:33:40.060-04:00",
    "ecr:createDate": "2016-08-03T10:33:40.060-04:00",
    "ecr:type": "search-interface-folder",
    "All": {
        "ecr:lastModifiedBy": "admin",
        "ecr:lastModified": "2016-08-03T10:33:40.061-04:00",
        "ecr:createDate": "2016-08-03T10:33:40.061-04:00",
        "ecr:type": "search-interface",
        "crossFieldMatch": "always"
    }
}