Search Events

UiPath.MicrosoftOffice365.Activities.Calendar.SearchEvents

Description

Uses the Microsoft Graph List events API to retrieve the matching events from the specified calendar (Calendar). If the Calendar property is left empty, the activity searches your default calendar for events.

After performing the search, the activity returns the matching Event[] objects (Events) that you can use as an input variable in subsequent activities (Modify Event, Add Location, etc.).

Scopes

This activity requires the following scopes:

• Calendars.ReadWrite

OR

• Calendars.ReadWrite.Shared

Project compatibility

Windows - Legacy | Windows

Configuration

Properties

Common

• DisplayName - The display name of the activity. This property supports String variables and string formatted values.

Input

• Account - (Optional) The email address with which to interact. This may include any shared mailbox to which the current user has access rights. If left blank, the current user's account is assumed. This property supports String variables and string formatted values.
  Note: Account field is mandatory for ApplicationIdAndSecret authentication type.
• Calendar - The calendar in which to search. This can be retrieved using the Get Calendars activity. If you don't provide a value, your default calendar is used. This field supports only Calendar variables. If entering a value, use an output property variable from the Get Calendars activity (Calendar or Default Calendar). If you're using the Calendar output property variable, specify the item in the array that you want to use (e.g., myCalendar(0)).

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level. This field supports Boolean values.

Options

• End Date - The end date of the events that you want to search. When specified, the search only returns events that occur before this date (events occurring on this date are not searched). This field supports only DateTime variables. Your DateTime value must be formatted as MM/DD/YYYY (e.g., 11/01/2019).
• Event ID - The ID of the event to look for. When specified, the Account parameter is taken into consideration while the other filter parameters in Options category are ignored. If the event with the specified ID is found, the output array contains exactly one element. If not found, the activity throws an exception. This property supports String variables and string formatted values.
• Max Results - The maximum amount of events that you want to be returned in your search results. This field supports only integer and Int32 variables. The default value is 50.
• Return Recurring - If selected, events in a series are returned as well. This field supports Boolean values.
• Search Query - If provided, only events whose subject, body, locations, or attendees contain this string are returned. Enter your String using OData query parameters or enter the event's title (e.g., "Office365-Quickstart").
• Start Date - The start date of the events that you want to search. When specified, the search only returns events that occur after this date (events occurring on this date are not searched). This field supports only DateTime variables. Your DateTime value must be formatted as MM/DD/YYYY (e.g., 10/30/2019).

Output

• Events - An array of events (Event objects) that match your SearchQuery value. This field supports only Event[] variables. Required if you plan to use the output data in subsequent activities. The variable you create for this property can be used as an input variable in other activities, such as Modify Event, Add Location, etc. When using this variable as an input property value, be sure to specify the item in the array that you want to use (e.g., myEvents(0)). The Event object includes multiple properties that you can use in other activities; not all properties are supported. The Body.Content property is returned in HTML format only.

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the steps.
2. Add the Microsoft Office 365 Scope activity to your project.
3. (Optional) Add an activity or run an external process that outputs a Calendar object (e.g., Get Calendars).
4. Add the Search Events activity inside the Microsoft Office 365 Scope activity.
5. Enter values for the Input properties.
6. Create and enter a Event[] variable for the Output property.

7. Run the activity.

   • Your input property values are sent to the ListEvents API.
   • The API returns the Event[] value to your output property variable.