Jump to

• Request
• Response
• Examples

View a search interface folder

get

/gsadmin/v1/{appName}/searchInterfaces

Returns the search interface folder for the specified application. Returns metadata about the folder (e.g. who created it and when) along with a list of child search interface configurations contained within that folder. If zip extension is specified (add ".zip" at the end of the path), the search interface folder is exported as a zip file.

Request

Supported Media Types

• application/json

Path Parameters

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

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json
• application/zip

200 Response

The search interface folder.

Body ()

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

Back to Top

Examples

The following example shows how to view the search interface folder of an ECR application by submitting a GET request on the REST resource using cURL:

curl -u <username>:<password> http://localhost:8006/ifcr/gsadmin/v1/{appName}/searchInterfaces

Response Body Example

The following example shows the response returned in JSON format.

{
  "ecr:lastModifiedBy": "admin",
  "ecr:lastModified": "2016-10-27T11:53:38.649+05:30",
  "ecr:createDate": "2016-10-27T11:53:38.649+05:30",
  "ecr:type": "search-interface-folder",
  "All": {
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-10-27T11:53:38.652+05:30",
    "ecr:createDate": "2016-10-27T11:53:38.652+05:30",
    "ecr:type": "search-interface",
    "crossFieldMatch": "always"
  },
  "TypeAhead": {
    "ecr:lastModifiedBy": "admin",
    "ecr:lastModified": "2016-10-27T11:53:38.654+05:30",
    "ecr:createDate": "2016-10-27T11:53:38.654+05:30",
    "ecr:type": "search-interface",
    "crossFieldMatch": "always"
  }
} 

Back to Top