Zoho: Related records schemas
18 Zoho schemas with complete fields and constraints.
← Related records operations · All schemas
Delink a related record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response structure for bulk operations, containing per-record result codes and operation details. Additional keys: not allowed |
data | array | Required within parent | Array of operation results per record. Maximum items: 100 |
data[] | object | Each item | Individual operation result. Additional keys: not allowed |
data[].code | string | Required within parent | Result code for the operation. Known values: SUCCESS, INVALID_DATA, DUPLICATE_DATA, MANDATORY_NOT_FOUND |
data[].details | Model | Optional | Expand Delink a related record — response body — data item details |
data[].message | string | Optional | Represents the operation result message for the record. Maximum length: 500 |
data[].status | string | Required within parent | Operation status. Known values: success, error |
Referenced models: Delink a related record — response body — data item details
Delink a related record — response body — data item details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation details including affected record ID. Additional keys: allowed |
api_name | string | Optional | API name of the field that caused the error (if applicable). Maximum length: 100 |
id | string | Optional | ID of the affected record. Maximum length: 20 Pattern: ^[0-9]+$ |
json_path | string | Optional | JSONPath to the field in request payload (if applicable). Maximum length: 500 |
param_name | string | Optional | Parameter name that caused the error (if applicable). Maximum length: 100 |
Related Records — request body — query / filters / group_operator: AND, OR, and, or
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a grouped filter criterion containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic. Additional keys: not allowed |
group | array | Required within parent | Contains an array of filter conditions grouped together and evaluated with the specified logical operator. Maximum items: 25 Minimum items: 2 |
group[] | JSON | Each item | |
group[] (anyOf 1) | Model | Alternative | Expand Related Records — request body — query filters value |
group[] (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or |
group_operator | string | Required within parent | Represents the logical operator applied between the filter conditions in the group. Possible values: AND - All conditions in the group must be satisfied. OR - At least one condition in the group must be satisfied. and - Equivalent to AND; all conditions in the group must be satisfied. or - Equivalent to OR; at least one condition in the group must be satisfied. One of: AND, OR, and, or |
Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value
Related Records — request body — query / filters / value / comparator: between, not between, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the between and not_between comparators. The value must be an array of exactly two elements — [lower_bound, upper_bound]. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Resolve the data_type from the field's FieldSchema. For formula fields, use formula.return_type as the effective data_type; for rollup_summary fields, use rollup_summary.return_type. Additional keys: not allowed |
comparator | string | Required within parent | Represents the range comparison operator applied to the criterion, indicating whether the field value falls within or outside the specified bounds. Possible values: between - Matches records where the field value falls within the specified range. not_between - Matches records where the field value falls outside the specified range. One of: between, not_between |
field | JSON | Required within parent | Represents the target field definition to which the range filter criterion is applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the range filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | array | Required within parent | Contains the two boundary values — [lower_bound, upper_bound] — against which the field is evaluated for the between or not_between comparator. Maximum items: 2 Minimum items: 2 |
value[] | JSON | Each item | |
value[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value[] (anyOf 2) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the in and not_in comparators. The value must be an array of primitive values. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text-based types, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Additional keys: not allowed |
comparator | string | Required within parent | Represents the set membership comparison operator applied to the criterion. Possible values: in - Matches records where the field value is in the specified set of values. not_in - Matches records where the field value is not in the specified set of values. One of: in, not_in |
field | JSON | Required within parent | Represents the target field definition to which the set filter criterion is applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the set filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | array | Required within parent | Contains an array of primitive filter values used in the set comparison. Maximum items: 500 Minimum items: 1 |
value[] | JSON | Each item | |
value[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value[] (anyOf 2) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the base field reference used in filter operations, containing minimal required properties. The field's data_type is not part of this object; resolve it from the corresponding FieldSchema. For formula fields, use formula.return_type as the effective data_type; for rollup_summary fields, use rollup_summary.return_type. Additional keys: allowed |
api_name | string | Optional | Represents the API name of the field used for filter application. Supports relationship notation, for example, Deals__r.Stage. |
id | string | Optional | Represents the unique ID of the field used for filter operations. Format: int64 |
Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the include_all, include_any, exclude_all, and exclude_any comparators. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. The value must be an array of SimpleFilterCriterionValueObjectRequest lookup objects. Additional keys: not allowed |
comparator | string | Required within parent | Represents the multi-select lookup comparison operator applied to the criterion. Applicable only when the field's data_type is multiuserlookup or multiselectlookup. Possible values: include_all - Matches records that include all specified lookup values. include_any - Matches records that include at least one of the specified lookup values. exclude_all - Matches records that exclude all specified lookup values. exclude_any - Matches records that exclude at least one of the specified lookup values. One of: include_all, include_any, exclude_all, exclude_any |
field | JSON | Required within parent | Represents the target field definition to which the multi-select lookup filter criterion is applied. The field must have a data_type of multiuserlookup or multiselectlookup. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the multi-select lookup filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | array | Required within parent | Contains an array of lookup object references used in the multi-select comparison. Maximum items: 5 Minimum items: 1 |
value[] | Model | Each item | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents a lookup object filter criterion value for request bodies, applicable when the field's data_type is lookup, ownerlookup, or userlookup. The ID property is required. |
$ (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item id, name |
$ (allOf 2) | object | All variants apply | Represents the constraint that the ID property is required for the lookup object filter criterion value in request bodies. Additional keys: allowed |
$ (allOf 2).id | JSON | Required within parent |
Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the base minified record structure of a lookup module, containing the record's unique identifier and display name. Additional keys: allowed |
id | string | Optional | Represents the unique ID of the lookup module record. Format: int64 |
name | string | Optional | Represents the display name of the lookup module record. Maximum length: 255 |
Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the less_than, less_equal, greater_than, and greater_equal comparators. The value must be a scalar; arrays and objects are not supported. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for date or datetime fields, and SimpleFilterCriterionValueNumber for integer, currency, or double fields. Additional keys: not allowed |
comparator | string | Required within parent | Represents the ordering comparison operator applied to the criterion. Possible values: less_than - Matches records where the field value is less than the specified filter value. less_equal - Matches records where the field value is less than or equal to the specified filter value. greater_than - Matches records where the field value is greater than the specified filter value. greater_equal - Matches records where the field value is greater than or equal to the specified filter value. One of: less_than, less_equal, greater_than, greater_equal |
field | JSON | Required within parent | Represents the target field definition to which the ordering filter criterion is applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the ordering filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | JSON | Required within parent | Represents the scalar filter value used in the ordering comparator. Arrays and objects are not supported for ordering comparators. |
value (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 2) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
value (anyOf 3) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string
Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Represents a predefined age or due-in-days placeholder value applicable only when the field's data_type is date or datetime. Follows the pattern ${AGEINDAYS}+<n> for records where the date field was exactly n days in the past, or ${DUEINDAYS}+<n> for records where the date field is exactly n days in the future. Supported comparators are equal, not_equal, less_than, greater_than, less_equal, and greater_equal. Maximum length: 255 Pattern: ^\$\{(AGEINDAYS|DUEINDAYS)\}\+[0-9]+$ |
Related Records — request body — query / filters / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the like, not_like, starts_with, ends_with, contains, and not_contains comparators. The value must be a string scalar or array; use SimpleFilterCriterionValueString for text-based field types. Object and Boolean values are not supported. Resolve the data_type from the field's FieldSchema. Additional keys: not allowed |
comparator | string | Required within parent | Represents the text comparison operator applied to the criterion. Possible values: like - Matches records where the field value contains the specified pattern. not_like - Matches records where the field value does not contain the specified pattern. starts_with - Matches records where the field value begins with the specified string. ends_with - Matches records where the field value ends with the specified string. contains - Matches records where the field value contains the specified string. not_contains - Matches records where the field value does not contain the specified string. One of: like, not_like, starts_with, ends_with, contains, not_contains |
field | JSON | Required within parent | Represents the target field definition to which the text filter criterion is applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the text filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | JSON | Required within parent | Represents the string filter value used in the text comparator. Accepts a scalar string or an array of string values. |
value (anyOf 1) | array | Alternative | Contains an array of primitive string values for the text filter comparator. Maximum items: 500 Minimum items: 1 |
value (anyOf 1)[] | JSON | Each item | |
value (anyOf 1)[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 2) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the equal comparator. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime fields; SimpleFilterCriterionValueNumber for integer, currency, or double fields; SimpleFilterCriterionValueBoolean for Boolean fields; SimpleFilterCriterionValueObjectRequest for lookup, ownerlookup, or userlookup fields; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Accepts scalar or array values. Resolve the data_type from the field's FieldSchema. Additional keys: not allowed |
comparator | string | Required within parent | Represents the equal comparison operator applied to the criterion. Possible values: equal - Matches records where the field value equals the specified filter value. One of: equal |
field | JSON | Required within parent | Represents the target field definition to which the equal filter criterion is applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the equal filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | JSON | Required within parent | Represents the filter value used in the equal comparator. Accepts a scalar or an array of values, depending on the field's data_type. |
value (anyOf 1) | array | Alternative | Contains an array of filter values for the equal comparator. Maximum items: 500 Minimum items: 1 |
value (anyOf 1)[] | JSON | Each item | |
value (anyOf 1)[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 1)[] (anyOf 2) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
value (anyOf 1)[] (anyOf 3) | JSON | Alternative | |
value (anyOf 1)[] (anyOf 3) (anyOf 1) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 1)[] (anyOf 3) (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value |
value (anyOf 2) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 3) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
value (anyOf 4) | boolean | Alternative | Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field). |
value (anyOf 5) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 6) | Model | Alternative | Expand Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value |
value (anyOf 7) | string | Alternative | Represents a predefined placeholder value applicable to any field data_type with the equal comparator. Possible values: ${EMPTY} - Matches records where the field has no value. ${NOTEMPTY} - Matches records where the field has any non-empty value. One of: ${EMPTY}, ${NOTEMPTY} |
value (anyOf 8) | string | Alternative | Represents a predefined placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. One of: ${TODAY}, ${TOMORROW}, ${TOMORROWPLUS}, ${YESTERDAY}, ${YESTERDAYMINUS}, ${LASTMONTH}, ${THISMONTH}, ${NEXTMONTH}, ${LASTWEEK}, ${THISWEEK}, ${NEXTWEEK}, ${THISYEAR}, ${THISFY}, ${THISFQ}, ${LASTYEAR}, ${PREVFY}, ${PREVFQ}, ${NEXTYEAR}, ${NEXTFY}, ${NEXTFQ}, ${EMPTY}, ${NOTEMPTY} |
value (anyOf 9) | string | Alternative | Represents a predefined N-period range placeholder value applicable only when the field's data_type is date or datetime, with the equal comparator. Follows the pattern ${NEXT_N_<PERIOD>:<n>} or ${LAST_N_<PERIOD>:<n>}, where PERIOD is DAYS, WEEKS, MONTHS, or YEARS and n is a positive integer. The current period is always excluded from the range. Maximum length: 255 Pattern: ^\$\{(LAST_N_|NEXT_N_)(DAYS|WEEKS|MONTHS|YEARS):([0-9]+)\}$ |
value (anyOf 10) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item, Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value
Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents a predefined placeholder object filter criterion value for lookup fields, applicable with equal or not_equal comparators when the field's data_type is ownerlookup or userlookup. Two forms are supported: (1) the currently logged-in user, represented by passing only the name property with the predefined value ${CURRENTUSER} and no ID property; and (2) the logged-in user's role, represented by passing the ID property with the predefined value ${CURRENTUSERROLE} and an optional display label in the name property. For specific real users or roles that are not predefined, use SimpleFilterCriterionValueObjectRequest, which requires the ID property. |
$ (anyOf 1) | object | Alternative | Represents the predefined object form for the currently logged-in user, in which only the name property carries the predefined value ${CURRENTUSER} and no ID property is included. Additional keys: not allowed |
$ (anyOf 1).name | string | Required within parent | Represents the predefined placeholder for the currently logged-in user. Possible values: ${CURRENTUSER} - Represents the currently logged-in user. One of: ${CURRENTUSER} |
$ (anyOf 2) | object | Alternative | Represents the predefined object form for the currently logged-in user's role, in which the ID property carries the predefined value ${CURRENTUSERROLE} and the name property is an optional display label. Additional keys: allowed |
$ (anyOf 2).id | string | Required within parent | Represents the predefined placeholder for the logged-in user's role record ID. Possible values: ${CURRENTUSERROLE} - Represents the role of the currently logged-in user. One of: ${CURRENTUSERROLE} |
$ (anyOf 2).name | string | Optional | Represents an optional display label for the predefined role, such as Logged in User Role. Maximum length: 255 |
Related Records — request body — query / filters / value / value / comparator: not equal, type: merge field, pre defined, value, field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a filter criterion for the not_equal comparator. The value type is determined by the field's data_type: use SimpleFilterCriterionValueString for text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime fields; SimpleFilterCriterionValueNumber for integer, currency, or double fields; SimpleFilterCriterionValueBoolean for Boolean fields; SimpleFilterCriterionValueObjectRequest for lookup, ownerlookup, or userlookup fields; and SimpleFilterCriterionValueObjectPredefined for predefined user or role object placeholders. Additional keys: not allowed |
comparator | string | Required within parent | Represents the not-equal comparison operator applied to the criterion. Possible values: not_equal - Matches records where the field value does not equal the specified filter value. One of: not_equal |
field | JSON | Required within parent | Represents the target field definition to which the not-equal filter criterion is applied, conforming to the base field structure. |
field (allOf 1) | Model | All variants apply | Expand Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id |
field (allOf 2) | object | All variants apply | Represents the field reference constraint that requires the api_name property to be present for the not-equal filter criterion. Additional keys: allowed |
type | string | Optional | Indicates the value resolution mode of the criterion, distinguishing whether the filter value is a literal value, a merge field reference, a predefined system variable, or another field reference. Possible values: value - The value is a direct literal. merge_field - The value is a merge field reference. pre_defined - The value is a predefined system variable placeholder. field - The value references another field. Default: value One of: merge_field, pre_defined, value, field |
value | JSON | Required within parent | Represents the filter value used in the not_equal comparator. Accepts a scalar or an array of values, depending on the field's data_type. |
value (anyOf 1) | array | Alternative | Contains an array of filter values for the not_equal comparator. Maximum items: 500 Minimum items: 1 |
value (anyOf 1)[] | JSON | Each item | |
value (anyOf 1)[] (anyOf 1) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 1)[] (anyOf 2) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
value (anyOf 1)[] (anyOf 3) | JSON | Alternative | |
value (anyOf 1)[] (anyOf 3) (anyOf 1) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 1)[] (anyOf 3) (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value |
value (anyOf 2) | string | Alternative | Represents a string filter criterion value applicable to fields with a data_type of text, textarea, email, phone, website, autonumber, picklist, multiselectpicklist, date, or datetime, as well as any data_type not explicitly covered by SimpleFilterCriterionValueNumber, SimpleFilterCriterionValueBoolean, SimpleFilterCriterionValueObjectRequest, SimpleFilterCriterionValueObjectResponse, or the multiselect lookup value schemas. Maximum length: 255 |
value (anyOf 3) | number | Alternative | Represents a numeric filter criterion value applicable to fields with a data_type of integer, currency, or double. |
value (anyOf 4) | boolean | Alternative | Represents a Boolean filter criterion value. Applicable only when the field has a Boolean data type (checkbox field). |
value (anyOf 5) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item |
value (anyOf 6) | Model | Alternative | Expand Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value |
value (anyOf 7) | Model | Alternative | Expand Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string |
Referenced models: Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field value string, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field value item, Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field value value
Related Records — request body — query filters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators. |
$ (anyOf 1) | Model | Alternative | Expand Related Records — request body — query filters value |
$ (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or |
Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value
Related Records — request body — query filters value
Referenced models: Related Records — request body — query / filters / value / comparator: between, not between, type: merge field, pre defined, value, field, Related Records — request body — query filters value value, Related Records — request body — query / filters / value / comparator: include all, include any, exclude all, exclude any, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / comparator: less than, less equal, greater than, greater equal, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / comparator: like, not like, starts with, ends with, contains, not contains, type: merge field, pre defined, value, field
Related Records — request body — query filters value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents an equality filter criterion that dispatches to either the EqualFilterCriterionRequest or NotEqualFilterCriterionRequest schema based on the comparator value. |
$ (anyOf 1) | Model | Alternative | Expand Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field |
$ (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / value / value / comparator: not equal, type: merge field, pre defined, value, field |
Referenced models: Related Records — request body — query / filters / value / value / comparator: equal, type: merge field, pre defined, value, field, Related Records — request body — query / filters / value / value / comparator: not equal, type: merge field, pre defined, value, field