Context Definition Filter Input

Input representation details of context definition filter.

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
contextDefinitionVersionIdStringUnique identifier of the specific context definition version to which this filter belongs.Required65.0
descriptionStringDetails of the context definition filter such as the purpose of the filter. Use this field to document the filter’s business logic, intended use case, or any important implementation details for future reference.Optional65.0
filterApiNameStringUnique API name identifier for the context definition filter.Required65.0
filterNameStringDisplay name for the context definition filter.Required65.0
filtersPerNodeStringA JSON string representation of the filter condition logic that defines the filter criteria. This field contains the structured query conditions that’s evaluated to determine which records match the filter. The JSON structure typically includes field names, operators, and values that form the filter expression.Required65.0
inheritedFromStringSource context definition if filter is inherited in the GET request. This field is not applicable for POST request.Optional65.0

JSON Example 

This example shows a sample request to create, get, or update a context definition filter.

1{
2      "description": "Updated",
3      "filterApiName": "FilterAccount",
4      "filterName":"FilterAccount",
5      "filtersPerNode": "{\"Account\":{\"filterCondition\":{\"attribute\":\"City\",\"operator\":\"EQUALS\",\"operands\":[{\"value\":\"Bengaluru\",\"type\":\"STRING\"}],\"composite\":false},\"orderByConditions\":[{\"orderByAttribute\":\"Name\",\"ascending\":false,\"nullsFirst\":false}],\"limit\":5}}",
6      "contextDefinitionVersionId": "11pxx0000004VmmAAE"
7    }