Find RESTful API
Presentation
Indigo provides a minimal search API. It indexes the names of collections or data objects and the name and values of metadata.
Find objects matching a term
Synopsys:
We have defined a minimal find API accessible under /api/find. It can search in names or metadata of collections and data objects and returns matching objects.
The following HTTP GET query the registry:
GET <root URI>/api/find?findTerms=<term>
GET <root URI>/api/find?findTerms=<term>&where=<where>
where:
<root URI>is the URL of the web server.<term>is the keyword we are looking for.<where>is the place we are looking, it can be “name”, “metadata” or “both”. The default value is “both”.
Response Body:
| Field Name | Type | Description | Requirement |
|---|---|---|---|
| result | JSON Array of JSON Strings | List of URI for the matching object. | Mandatory |
Response Status:
| HTTP Status | Description |
|---|---|
| 200 OK | The result are returned in the response body |
| 400 Bad Request | The request contains invalid parameters |
| 401 Unauthorized | The authentication credentials are missing or invalid |
| 403 Forbidden | The client lacks the proper authorization |
Example:
GET to the find URI to get matching objects:
GET /api/find?findTerms=test HTTP/1.1
Host: 192.168.12.12
Response:
HTTP/1.1 200 OK
{
“result” : [“/MyContainer/”,
“/MyCollection/MyDataObject.txt”,
…,
]
}