# Update Criteria

Updates a specific Criteria.

Endpoint: PUT /criterias/{criteriaKey}
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `criteriaKey` (integer, required)
    Criteria Key

## Request fields (application/json):

  - `searchConfigId` (string,null)
    The SaerchConfig for which this Criteria will be applied.

  - `criteria_Key` (integer)
    Key value identifying a specific criteria. Omit this field when creating a new record.

  - `criteria_Type` (string,null)
    Identifies the type associated with the criteria. Use the name of the SearchConfig for which you want to apply this Criteria.

  - `criteria_User` (string,null)
    Identifies the User associated with the criteria.

  - `description` (string,null)
    Description of the criteria.

  - `criteriaDetails` (array,null)
    List of details applied to the Criteria.

  - `criteriaDetails.criteria_Key` (integer)
    Unique identifier of the Criteria for which this Criteria Details object belongs.  
When creating a new Critiera object, omit this from the payload.

  - `criteriaDetails.criteria_Seq` (integer, required)
    The sequential order that the criteria details will be applied. 
If you have multiple criteria details to add, this is important as it dictates the order in which they are applied and constructed (eg, if you have parenthesis or concatenate with AND's / OR's).

  - `criteriaDetails.criteria_AndOr` (string,null)
    Specifies the AND/OR when multiple conditions are specified for a criteria.
If making a complex query, use this to concatenate multiple criteria.  For example, use the value "Or" if you want to match either this criteria or the next criteria.  If not needed, use null or omit.

  - `criteriaDetails.criteria_Column` (string,null)
    Column containing the value for the criteria condition specified,
The column within the Criteria_Table for whcih this criteria will be applied.

  - `criteriaDetails.criteria_Data_Type` (string,null)
    Data type of the value for the criteria condition specified
The data type of the column value MUST be populated and MUST be one of the following values: string, date, or number

  - `criteriaDetails.criteria_From_Value` (string,null)
    First value of a range or only value for a single value of the criteria condition specified
The value to use against the Criteria_Operator when comparing values (eg, >, >=, etc).  If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the beginning value. If not needed, use null or omit.

  - `criteriaDetails.criteria_Left_Paren` (string,null)
    Optional field used to hold a parenthesis for nesting criteria conditions
Allows you to start a parenthetical expression.  Add "(" to start the parenthesis grouping.  If not needed, use null or omit. An example of a criteria using parenthesis would be (x=1 OR x=2) OR (y=1 OR y=2).

  - `criteriaDetails.criteria_Operator` (string,null)

  - `criteriaDetails.criteria_Right_Paren` (string,null)
    Optional field used to hold a parenthesis for nesting criteria conditions
Allows you to end a parenthetical expression.  Add ")" to end the parenthesis grouping.  If not needed, use null or omit. An example of a criteria using parenthesis would be (x=1 OR x=2) OR (y=1 OR y=2).

  - `criteriaDetails.criteria_Table` (string,null)
    Table where a column for criteria condition is found
The table for which this criteria will be applied.  The table should exist within the SearchConfig that this criteria is being applied.

  - `criteriaDetails.criteria_Thru_Value` (string,null)
    Optional ending value of a range for the criteria condition specified
If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the ending value. If not needed, use null or omit.

  - `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.

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.searchConfigId` (string,null)
    The SaerchConfig for which this Criteria will be applied.

  - `data.criteria_Key` (integer)
    Key value identifying a specific criteria. Omit this field when creating a new record.

  - `data.criteria_Type` (string,null)
    Identifies the type associated with the criteria. Use the name of the SearchConfig for which you want to apply this Criteria.

  - `data.criteria_User` (string,null)
    Identifies the User associated with the criteria.

  - `data.description` (string,null)
    Description of the criteria.

  - `data.criteriaDetails` (array,null)
    List of details applied to the Criteria.

  - `data.criteriaDetails.criteria_Key` (integer)
    Unique identifier of the Criteria for which this Criteria Details object belongs.  
When creating a new Critiera object, omit this from the payload.

  - `data.criteriaDetails.criteria_Seq` (integer, required)
    The sequential order that the criteria details will be applied. 
If you have multiple criteria details to add, this is important as it dictates the order in which they are applied and constructed (eg, if you have parenthesis or concatenate with AND's / OR's).

  - `data.criteriaDetails.criteria_AndOr` (string,null)
    Specifies the AND/OR when multiple conditions are specified for a criteria.
If making a complex query, use this to concatenate multiple criteria.  For example, use the value "Or" if you want to match either this criteria or the next criteria.  If not needed, use null or omit.

  - `data.criteriaDetails.criteria_Column` (string,null)
    Column containing the value for the criteria condition specified,
The column within the Criteria_Table for whcih this criteria will be applied.

  - `data.criteriaDetails.criteria_Data_Type` (string,null)
    Data type of the value for the criteria condition specified
The data type of the column value MUST be populated and MUST be one of the following values: string, date, or number

  - `data.criteriaDetails.criteria_From_Value` (string,null)
    First value of a range or only value for a single value of the criteria condition specified
The value to use against the Criteria_Operator when comparing values (eg, >, >=, etc).  If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the beginning value. If not needed, use null or omit.

  - `data.criteriaDetails.criteria_Left_Paren` (string,null)
    Optional field used to hold a parenthesis for nesting criteria conditions
Allows you to start a parenthetical expression.  Add "(" to start the parenthesis grouping.  If not needed, use null or omit. An example of a criteria using parenthesis would be (x=1 OR x=2) OR (y=1 OR y=2).

  - `data.criteriaDetails.criteria_Operator` (string,null)

  - `data.criteriaDetails.criteria_Right_Paren` (string,null)
    Optional field used to hold a parenthesis for nesting criteria conditions
Allows you to end a parenthetical expression.  Add ")" to end the parenthesis grouping.  If not needed, use null or omit. An example of a criteria using parenthesis would be (x=1 OR x=2) OR (y=1 OR y=2).

  - `data.criteriaDetails.criteria_Table` (string,null)
    Table where a column for criteria condition is found
The table for which this criteria will be applied.  The table should exist within the SearchConfig that this criteria is being applied.

  - `data.criteriaDetails.criteria_Thru_Value` (string,null)
    Optional ending value of a range for the criteria condition specified
If a Criteria_Operator requires two values (eg, for BETWEEN) then this is the ending value. If not needed, use null or omit.

  - `data.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.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields