UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Search Events

Overview

Using your search parameters (Query, StartDate, EndDate), the Search Events activity calls the Microsoft Graph ListEvents 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.).

How it works

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

  1. Complete the Setup 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 Teams 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.

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

Search Events

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Calendar

The calendar that you want to use to search for events.

Attributes
Details

Type

Calendar

Required

No

Default value

Empty

Allowed values

Enter a Calendar variable.

Notes

  • If you don't provide a value, your default calendar is used.
  • 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.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Options

EndDate

The end date of the events that you want to search.

Attributes
Details

Type

DateTime

Required

No

Default value

Empty

Allowed values

Enter a DateTime or DateTime variable.

Notes

  • When specified, the search only returns events that occur before this date (events occurring on this date are not searched).
  • Your DateTime value must be formatted as MM/DD/YYYY (e.g., 11/01/2019).

MaxResults

The maximum amount of events that you want returned in your search results.

Attributes
Details

Type

Int32

Required

No

Default value

50

Allowed values

Enter a Int32 or Int32 variable.

Notes

N/A


ReturnRecurring

If selected, the results include all events in a series.

Attributes
Details

Type

Check-box

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


SearchQuery

Your search parameters.

Attributes
Details

Type

String (OData syntax)

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes


StartDate

The start date of the events that you want to search.

Attributes
Details

Type

DateTime

Required

No

Default value

Empty

Allowed values

Enter a DateTime or DateTime variable.

Notes

  • When specified, the search only returns events that occur after this date (events occurring on this date are not searched).
  • 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.

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 (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 example image below shows some of the properties that you can return.
    • The Body.Content property is returned in HTML format only

Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guides.

Updated 5 months ago


Search Events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.