This API gives you the search list for the given term across OvalEdge. There is an option to display the results based on specific searches like table, column, chart, story, file, story, query, schema.
The following are operational APIs associated with the Search Services API:
1. Get Search Details
The Get Search Details method requires parameters {limit} -Number of records to display on a single search. {Objecttype} - Table or column or chart or file {Search Term} - Term you want to search.{Start Index} - Starting Index of your search that returns the response as search results.
Mandatory Fields: limit, searchTerm, startIndex.
| Method | Url | Parameter |
| getSearchDetails | /api/search/{searchTerm} | {limit},{Objecttype},{Search Term},{Start Index} |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"searchterm": "table",
"count table": 2,
"searchList table": [
{
"id": 1394,
"type": "Table",
"rowcount": 4669,
"description": "customer",
"title": "SuperStoreODS.dbo.customer",
"url": "https://demo.ovaledge.net/#nav/table?id=1394"
},
{
"id": 4648,
"type": "Table",
"rowcount": 0,
"description": "string",
"title": "Manual.manual.NewTableFromAPI",
"url": "https://demo.ovaledge.net/#nav/table?id=4648"
}
]
}
}
2. Get List From Charts
Mandatory Fields: endIndex, startIndex, term.
| Method | Url | Parameter |
|
getListFromCharts |
/api/search/charts |
startindex, endindex, term |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Charts": []
}
3. Get List From Columns
Mandatory Fields: endIndex, startIndex, term.
| Method | Url | Parameter |
|
getListFromColumns |
/api/search/columns |
startindex, endindex, term, oetableid |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Columns": []
}
}
4. Search Files
Mandatory Fields: endIndex, startIndex, term.
| Method | Url | Parameter |
| getListFromCharts | /api/search/charts | startindex, endindex, term, isNFSonly |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Files": []
}
}
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Files": []
}
}
5. Get All The Business Terms By Search Word
Mandatory Fields: endIndex, searchCriteria, searchTerm, searchType, startIndex.
| Method | Url | Parameter |
| getAllTheBusinessTermsBySearchWord | /api/search/searchExploreAll | startindex,endindex, searchCriteria, searchType, searchTerm |
Response
{
"status": true,
"statusCode": "",
"statusMsg": "",
"response": {
"responsedata": []
}
}
6. Get List From Story
Mandatory Fields: endIndex, startIndex, term.
| Method | Url | Parameter |
| getListFromStory | /api/search/story | startindex, endindex, term |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Story": []
}
}
7. Get List From Tables
Mandatory Fields: endIndex, startIndex, term.
| Method | Url | Parameter |
| getListFromTables | /api/search/tables | startindex, endindex, term |
Response
{
"status": false,
"statusCode": "",
"statusMsg": "",
"response": {
"Tables": []
}
}