Comment on page
Search An Entity
post
/api/v1/{entity-name}/search
Parameters
Path
entity-name*
Name of the entity to be searched
Header
content-type*
Set to
application/jsonBody
...*
Object
Filters to be sent in order to identify an entity
Responses
200: OK
Success Response of Search
Sample Request Body
{ "filters": { "school": { "eq": "UP Public School" } }, "limit": 1, "offset": 0 }
Important Fields in Request Body
Field | Type | Description |
|---|---|---|
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 |
curl --location \
--request POST \
--header 'Content-Type: application/json' \
'{registry-url}/api/v1/Place/search' \
--data-raw '{
"filters": {
"name": {
"eq": "UP Public School"
}
},
"limit": 1,
"offset": 0
}'
printf '{
"filters": {
"school": {
"eq": "UP Public School"
}
},
"limit": 1,
"offset": 0
}'| http POST '{registry-url}/api/v1/Place/search' \
Content-Type:'application/json' \
{registry-url}is usually http://localhost:{port}. The port can be found under theregistrysection in thedocker-compose.ymlfile and is usually8081.
Last modified 1yr ago