Search An Entity
Last updated
Last updated
Copyright (c) 2023 EkStep Foundation under MIT License
POST
/api/v1/{entity-name}/search
Or GET
/api/v1/{entity-name}/search?search=<base64 encoded payload>
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Sample Request Body
{ "filters": { "school": { "eq": "UP Public School" } }, "limit": 1, "offset": 0 }
Important Fields in Request Body
{registry-url}
is usually http://localhost:{port}. The port can be found under theregistry
section in thedocker-compose.yml
file and is usually8081
.
Field | Type | Description |
---|---|---|
entity-name*
String
Name of the entity to be searched
content-type*
String
Set to application/json
search
base64 encoded payload
Sets the query for searching and pagination of the data.
example:
eyJvZmZzZXQiOjIsImxpbWl0IjoyLCJmaWx0ZXJzIjp7fSwiZW50aXR5VHlwZSI6WyJJbnN1cmFuY2UiXX0=
contains { "offset": 2, "limit": 2, "filters": { } }
...*
Object
Filters to be sent in order to identify an entity
limit
Number
Number of responses to be retrieved out of total number of search results
offset
Number
Starting point for responses to be returned
viewTemplateId
String
Any operation to be carried on the response before it is returned via API, that can be provided here. For eg: Combining First Name and Last Name into Single Field Name
Filter Operators
String
eq, neq, gte, gt, lte, lt, contains, notContains, between, or, startsWith, notStartsWith, endsWith, notEndsWith, queryString are some of the operators provided