Context Definition Filter By ID (DELETE, GET, PATCH)

Get, update, or delete a context definition filter for a specified context definition filter ID.

Resource

1/connect/context-definitions/${contextDefinitionId}/context-filters/${contextDefinitionFilterId}

The {contextDefinitionId} parameter is the ID of the context definition.

Resource Example

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/context-definitions/SimpleDef/context-filters/1Tlxx0000004DUuCAM

{yourInstance} is the domain name of your Salesforce instance.

Available Version

65.0

HTTP Methods

DELETE, GET, PATCH

Response Body for GET

Context Definition Filter

Request Body for PATCH

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    }

Properties

Name	Type	Description	Required or Optional	Available Version
`contextDefinitionVersionId`	String	Unique identifier of the specific context definition version to which this filter belongs.	Required	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.	Optional	65.0
`filterApiName`	String	Unique API name identifier for the context definition filter.	Required	65.0
`filterName`	String	Display name for the context definition filter.	Required	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.	Required	65.0
`inheritedFrom`	String	Source context definition if filter is inherited in the GET request. This field is not applicable for POST request.	Optional	65.0

Response Body for PATCH

Context Definition Filter