Chatter REST API Developer Guide
jNewer Version Available
exclude
To exclude specific properties from a response body, use
the exclude request parameter.
The exclude parameter is available
in API version 27.0 and later.
The value for the exclude query is a list of properties separated by bars (|). You must URL encode the bars as %7C. You must include a forward slash before each property name.
The following request excludes both
the aboutMe and address properties from a response body:
The following table lists rules for using the exclude query parameter, as well as additional
examples.
| Description | Original Output | Exclude Value | Filtered Output |
|---|---|---|---|
| Include a forward slash (/) before property names or the request returns an error. |
|
exclude=bar | 400 error with error code INVALID_FILTER_VALUE |
| Filter properties by name. |
|
exclude=/bar |
|
| Top-level properties cannot be filtered. Note that this query string doesn’t return an error. |
|
exclude=/foo |
|
| Use a bar (|) delimiter to filter multiple properties. URL encode the delimiter as %7C. |
|
exclude=/foo%7C/bar |
|
| Filtering a response body filters everything in the response body. |
|
exclude=/someObject |
|
| To filter a property nested in a response body, include the parent response body name as a filter segment. |
|
exclude=/someObject/sub |
|
| Identify an item in a list by its property name. This example uses XML. |
|
exclude=/someList/item/id |
|
| Identify an item in a list by its property name. This example uses JSON. |
|
exclude=/someList/item/id |
|