- Release notes
- Overview
- Getting started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Publishing Guidelines for Process Mining app templates
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams scope
- Create team
- Create team from group
- Get team
- Get teams
- Channels
- Create channel
- Delete channel
- Get channel
- Get channels
- Update channel
- Chats
- Get chat
- Get chats
- Get chat members
- Messages
- Get message
- Get messages
- Get message replies
- Reply to message
- Send message
- Events
- Create event
- Delete event
- Get event
- Get events
- Users
- Get user presence
- How it works
- Technical references
- Get started
- About
- Setup
- Technical references
- Azure Form Recognizer scope
- Activities
- Analyze form
- Analyze form async
- Get analyze form result
- Analyze receipt
- Analyze receipt async
- Get analyze receipt result
- Analyze layout
- Analyze layout async
- Get analyze layout result
- Train model
- Get models
- Get model keys
- Get model info
- Delete model
- Connectors
- How to create activities
- Build Your Integration
Marketplace user guide
Get events
Overview
Using your search parameters (QueryOptions) and specified team (TeamId), the Get Events activity calls the Microsoft Graph ListEvents API to retrieve the events that match your query.
After retrieving the events, the activity returns its properties and relationships in an Event[] object (Events) that you can use as input variables in subsequent activities.
How it works
The following steps and message sequence diagram is an example of how the activity works from design time (that is, the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
- Add an activity or run an external process that outputs a
Team.Idvalue (e.g., Get Teams). - Add the Get Events activity inside the Microsoft Teams Scope activity.
- Enter values for the Input properties.
- Create and enter a
Channel[]variable for your Output property. - Run the activity.
-
Your input property values are sent to the ListEvents API.
-
The API returns the
Event[]value to your output property variable.
-
Properties
The values for the following properties are specified when adding this activity to your project in UiPath Studio.
Common
DisplayName
The display name of the activity.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Get Events |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
Input
TeamId
The Id of the Team object that you want to retrieve events from.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (for example, Get Teams or external API call) |
Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
| Attributes | Details |
|---|---|
| Type | Checkbox |
| Required | No |
| Default value | Not Selected |
| Allowed values | Selected or Not Selected |
| Notes | N/A |
Options
QueryOptions
The search parameters that you want to apply when retrieving your list of channels.
| Attributes | Details |
|---|---|
| Type | QueryOption[] (OData syntax) |
| Required | No |
| Default value | Empty |
| Allowed values | Enter a QueryOption[] or QueryOption variable. |
| Notes | Enter your value using an OData system query option; the format is as follows: {New QueryOption("Option", "OptionParameter")}. For example, if you want to apply the $filter option, you would enter "filter" as the first string and then enter a filter parameter as the second string (e.g., {New QueryOption("filter", "displayName eq 'General'")}). |
Output
Events
An array of events (Event[] object) that match QueryOptions value.
| Attributes | Details |
|---|---|
| Type | Event[] |
| Required | No (required if you plan to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a Event[] variable. |
| Notes | The variable you create for this property can be used as an input variable in subsequent activities (for example, Delete Event). |