Skip to content

Export API getRetainedMessages update to include additional $filter params #9322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 20, 2024
Merged

Export API getRetainedMessages update to include additional $filter params #9322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9405f11
Adding document about $filter
leewon2021 Apr 19, 2024
9f9ed1e
Update channel-getallretainedmessages.md
Lauragra Apr 20, 2024
1dba48e
Update chat-getallretainedmessages.md
Lauragra Apr 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions api-reference/beta/api/channel-getallretainedmessages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,16 @@ This method supports the following OData query parameters to help customize the
| $filter | The [$filter](/graph/query-parameters#filter-parameter) query parameter supports date and time range queries on the **lastModifiedDateTime** property.|
| $top | Use the [$top](/graph/query-parameters#top-parameter) query parameter to control the number of items per response.|

The following table lists examples that show how to use the `$filter` parameter.

|Scenario | `$filter` parameter |Possible values |
|:-----------------------------------------|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------|
|Get messages sent by user identity type |$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' |aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser|
|Get messages sent by application type |$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' |aadApplication, bot, tenantBot, office365Connector, outgoingWebhook |
|Get messages sent by user ID |$filter=from/user/id eq '{oid}' ||
|Get control (system event) messages |$filter=messageType eq 'systemEventMessage' ||
|Exclude control (system event) messages |$filter=messageType ne 'systemEventMessage' ||

## Request headers

|Name|Description|
Expand Down
11 changes: 11 additions & 0 deletions api-reference/beta/api/chat-getallretainedmessages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ The following example shows a request that uses the `$top` and `$filter` query p
```http
GET /users/{id}/chats/getAllRetainedMessages?$top=50&$filter=lastModifiedDateTime gt 2020-06-04T18:03:11.591Z and lastModifiedDateTime lt 2020-06-05T21:00:09.413Z
```

The following table lists examples that show how to use the `$filter` parameter.

|Scenario | `$filter` parameter |Possible values |
|:-----------------------------------------|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------|
|Get messages sent by user identity type |$filter=from/user/userIdentityType eq '{teamworkUserIdentityType}' |aadUser, onPremiseAadUser, anonymousGuest, federatedUser, personalMicrosoftAccountUser, skypeUser, phoneUser|
|Get messages sent by application type |$filter=from/application/applicationIdentityType eq '{teamworkApplicationIdentity}' |aadApplication, bot, tenantBot, office365Connector, outgoingWebhook |
|Get messages sent by user ID |$filter=from/user/id eq '{oid}' ||
|Get control (system event) messages |$filter=messageType eq 'systemEventMessage' ||
|Exclude control (system event) messages |$filter=messageType ne 'systemEventMessage' ||

## Request headers

|Name|Description|
Expand Down
Loading