Search Criteria

Create a search Criteria

Creates a new search Criteria.

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
searchConfigId
string or null <= 32 characters

The SaerchConfig for which this Criteria will be applied.

criteria_Key
integer <int32>

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

criteria_Type
string 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_User
string or null <= 20 characters

Identifies the User associated with the criteria.

description
string or null <= 512 characters

Description of the criteria.

Array of objects or null (CriteriaDetail)

List of details applied to the Criteria.

temporary
boolean

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.

Responses
200

Success

401

Unauthorized

post/criterias
Request samples
{
  • "searchConfigId": "string",
  • "criteria_Key": 0,
  • "criteria_Type": "string",
  • "criteria_User": "string",
  • "description": "string",
  • "criteriaDetails": [
    ],
  • "temporary": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Criteria

List Criteria. Optional

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
searchConfigId
string

Search Config Id

criteriaUser
string

Criteria User

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/criterias
Request samples 
Response samples 
No sample
Get Criteria
Gets Criteria


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
criteriaKey
required
integer <int32> 
Criteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/criterias/{criteriaKey}
Request samples 
Response samples 
No sample
Update Criteria
Updates a specific Criteria.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
criteriaKey
required
integer <int32> 
Criteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
searchConfigId
string or null  <= 32 characters 
The SaerchConfig for which this Criteria will be applied.


 
criteria_Key
integer <int32> 
Key value identifying a specific criteria. Omit this field when creating a new record.


 
criteria_Type
string 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_User
string or null  <= 20 characters 
Identifies the User associated with the criteria.


 
description
string or null  <= 512 characters 
Description of the criteria.


 
Array of objects or null (CriteriaDetail) 
List of details applied to the Criteria.


 
temporary
boolean
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.


 
Responses 
200
Success


401
Unauthorized


put/criterias/{criteriaKey}
Request samples 
{
  • "searchConfigId": "string",
  • "criteria_Key": 0,
  • "criteria_Type": "string",
  • "criteria_User": "string",
  • "description": "string",
  • "criteriaDetails": [
    ],
  • "temporary": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Criteria
Deletes a Criteria


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
criteriaKey
required
integer <int32> 
Criteria Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/criterias/{criteriaKey}
Request samples 
Create or Update Batch Criteria
Creates or Updates multiple Criteria.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
searchConfigId
string or null  <= 32 characters 
The SaerchConfig for which this Criteria will be applied.


 
criteria_Key
integer <int32> 
Key value identifying a specific criteria. Omit this field when creating a new record.


 
criteria_Type
string 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_User
string or null  <= 20 characters 
Identifies the User associated with the criteria.


 
description
string or null  <= 512 characters 
Description of the criteria.


 
Array of objects or null (CriteriaDetail) 
List of details applied to the Criteria.


 
temporary
boolean
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.


 
Responses 
207
Success


401
Unauthorized


put/criterias-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}