Skip to content

Create a search Criteria

Request

Creates a new search Criteria.

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
searchConfigIdstring or null, <= 32 characters

The SaerchConfig for which this Criteria will be applied.

criteria_Keyinteger, (int32)

Key value identifying a specific criteria. Omit this field when creating a new record.

criteria_Typestring or null, <= 32 characters

Identifies the type associated with the criteria. Use the name of the SearchConfig for which you want to apply this Criteria.

criteria_Userstring or null, <= 20 characters

Identifies the User associated with the criteria.

descriptionstring or null, <= 512 characters

Description of the criteria.

criteriaDetailsArray of objects or null

List of details applied to the Criteria.

temporaryboolean

If true, criteria is not included as a "saved search", if false, the criteria is persisted as a "saved search" in accordance to the comapny's criteria persistance settings.

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/criterias \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "searchConfigId": "string",
    "criteria_Key": 0,
    "criteria_Type": "string",
    "criteria_User": "string",
    "description": "string",
    "criteriaDetails": [
      {
        "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"
      }
    ],
    "temporary": true
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}