Context Definition Filter

Output representation details of a context definition filter.

JSON Example

This example shows a sample response for the Context Definition Filter by ID (GET) request.

1{
2  "contextDefinitionFilterId": "1Tlxx0000004DUuCAM",
3  "contextDefinitionVersionId": "11pxx0000004VmmAAE",
4  "filterName": "FilterAccount2",
5  "filterApiName": "FilterAccount2",
6  "filtersPerNode": "{&quot;Account&quot;:{&quot;filterCondition&quot;:{&quot;attribute&quot;:&quot;City&quot;,&quot;operator&quot;:&quot;EQUALS&quot;,&quot;operands&quot;:[{&quot;value&quot;:&quot;Bengaluru&quot;,&quot;type&quot;:&quot;STRING&quot;}],&quot;composite&quot;:false},&quot;orderByConditions&quot;:[{&quot;orderByAttribute&quot;:&quot;Name&quot;,&quot;ascending&quot;:false,&quot;nullsFirst&quot;:false}],&quot;limit&quot;:5}}"
7  "isSuccess": true
8}

This example shows a sample response for the Context Definition Filter By ID (PATCH) request.

1{
2  "contextDefinitionFilterId": "1Tlxx0000004DUuCAM",
3  "contextDefinitionVersionId": "11pxx0000004VmmAAE",
4  "description": "Updated",
5  "filterName": "FilterAccount2",
6  "filterApiName": "FilterAccount2",
7  "filtersPerNode": "{&quot;Account&quot;:{&quot;filterCondition&quot;:{&quot;attribute&quot;:&quot;City&quot;,&quot;operator&quot;:&quot;EQUALS&quot;,&quot;operands&quot;:[{&quot;value&quot;:&quot;Bengaluru&quot;,&quot;type&quot;:&quot;STRING&quot;}],&quot;composite&quot;:false},&quot;orderByConditions&quot;:[{&quot;orderByAttribute&quot;:&quot;Name&quot;,&quot;ascending&quot;:false,&quot;nullsFirst&quot;:false}],&quot;limit&quot;:5}}",
8  "isSuccess": true
9}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`contextDefinitionFilterId`	String	ID of the context definition filter.	Small, 65.0	65.0
`contextDefinitionVersionId`	String	Unique identifier of the specific context definition version to which this filter belongs.	Small, 65.0	65.0
`description`	String	Details 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.	Small, 65.0	65.0
`filterApiName`	String	Unique API name identifier for the context definition filter.	Small, 65.0	65.0
`filterName`	String	Display name for the context definition filter.	Small, 65.0	65.0
`filtersPerNode`	String	A 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.	Small, 65.0	65.0
`inheritedFrom`	String	Source context definition if filter is inherited in the GET request. This field is not applicable for POST request.	Small, 65.0	65.0
`isSuccess`	Boolean	Indicates whether the API request is successful (`true`) or not (`false`).	Small, 65.0	65.0