APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
The unique Criteria_Key that contains the search criteria that will be applied to a SearchConfig.
The unique id of the SearchConfig for which the Criteria will be applied.
Fields to return in the search results. These must be a subset of the SearchConfig Fields.
This flag indicates you want your search to return a random sample or records matching your search criteria. If you flag this as true, Random_Sample_Count must also be a value >= 0 or it will throw an exception.
This value is the raw count of random records you want as a sample based on your search. Value must be between 0-1000 (because search has paging, this value will default limit to 750 if you do not pass in a larger page size). As noted below, this value must be between 0-100 if you are flagging this as a percent sample.
This flag indicates that the value in Random_Sample_Count is a Percent value between 0-100. If true, the Random_Sample_Count is used as the Pct sample of the full result set. As noted, if this is true, the value in Random_Sample_Count must be between 0-100 or an exception will be thrown.
This flag indicates you want your search to return a the Nth result of the results of the search.
This value is the Nth result you would like returned from the search results. Value must be >= 0 and less than the total number of results. If greater than the total number of results, it will return the last result.
Identifies the sort priority of the column. If null, the column will not be sorted.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/search
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://vbapi.vbasoftware.com/vbasoftware/search \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"criteria_Key": 0,
"searchConfigId": "string",
"user_ID": "string",
"page": 0,
"pageCount": 0,
"include_Result_Details": true,
"use_Random_Sample": true,
"random_Sample_Count": 0,
"random_Sample_Count_Is_Percent": true,
"use_Nth_Result": true,
"nth_Result": 0,
"criterias": [
{
"criteria_Key": 0,
"criteria_Seq": 0,
"criteria_AndOr": "str",
"criteria_Column": "string",
"criteria_Data_Type": "string",
"criteria_From_Value": "string",
"criteria_Left_Paren": "string",
"criteria_Operator": "string",
"criteria_Right_Paren": "string",
"criteria_Table": "string",
"criteria_Thru_Value": "string"
}
],
"selectedFields": [
{
"tableName": "string",
"columnName": "string",
"sortPriority": 0,
"sortDescending": true
}
]
}'No response example