activities
latest
false
UiPath logo, featuring letters U and I in white
Productivity Activities
Last updated Nov 21, 2024

Search Events

UiPath.GSuite.Activities.SearchEvent

Description

Returns events from the specified calendar that match the search parameters.

Scopes

This activity requires the following scopes:

  • https://www.googleapis.com/auth/calendar.readonly

OR

  • https://www.googleapis.com/auth/calendar.events.readonly

OR

  • https://www.googleapis.com/auth/calendar.events

OR

  • https://www.googleapis.com/auth/calendar

Project compatibility

Windows - Legacy | Windows

Configuration

Properties

Common
  • ContinueOnError - If set, the remaining activities are executed if the current activity fails. This field supports Boolean values.
  • DisplayName - The display name of the activity. This property supports String variables and string formatted values.
Input
  • CalendarID - The Id of the calendar that you want to search for events. This property supports String variables and string formatted values. If this field is empty, the property uses the primary calendar of the authenticated user specified in the GSuite Application Scope.
Misc
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level. This field supports Boolean values.
Options
  • EndDate - If specified, the activity searches for events that occur before the given date. This property supports DateTime variables and DateTime formatted values.
  • EventID - The ID of the event to look for. When specified, the CalendarID parameter is taken into consideration and the filter parameters in the 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.
  • MaxResults - The number of results that you want to return. This property supports Int32 variables and Int32 formatted values. The default value is 50.
  • ReturnReccuring - If selected, the response includes all recurring event instances matching the search parameters; otherwise, the response includes a single instance from the recurring event series.
  • SearchQuery - If specified, the response includes only events whose title, description, location, or attendee list fields matching the free text query. This property supports String variables and string formatted values.
  • StartDate - If specified, the activity searches for events occurring after the specified date. This property supports String variables and string formatted values.
Output
  • ReturnedEvents - The events that match your search parameters. This property supports Event[] array variables. You can use this variable as an input property value in other Google Workspace activites. For more information, see Events in the Google Calendar API documentation.
  • Description
  • Project compatibility
  • Configuration

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.