Search Request

Run a search

Runs a search usng the provided Search Request

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
criteria_Key
required
integer <int32>

The unique Criteria_Key that contains the search criteria that will be applied to a SearchConfig.

searchConfigId
required
string non-empty

The unique id of the SearchConfig for which the Criteria will be applied.

user_ID
string or null

Fields to return in the search results. These must be a subset of the SearchConfig Fields.

page
integer or null <int32>
pageCount
integer or null <int32>
include_Result_Details
boolean or null
use_Random_Sample
boolean or null

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.

random_Sample_Count
integer or null <int32>

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.

random_Sample_Count_Is_Percent
boolean or null

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.

use_Nth_Result
boolean or null

This flag indicates you want your search to return a the Nth result of the results of the search.

nth_Result
integer or null <int32>

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.

Array of objects or null (CriteriaDetail)
required
Array of objects (SelectedField)
Responses
200

Success

401

Unauthorized

post/search
Request samples
{
  • "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": [
    ],
  • "selectedFields": [
    ]
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}