Get Calendars

UiPath.MicrosoftOffice365.Activities.Calendar.GetCalendars

Description

Uses the Microsoft Graph Get calendar API to get the properties and relationships of a calendar. The calendar can be a user's, or the default calendar of an Office 365 group (User).

After retrieving the calendars, the activity outputs a Calendar object that represents the user's default calendar (Default Calendar) and an array of Calendar[] objects that represents all the user's calendars (Calendars). These output Calendar objects can be used as input property variables in the Create Event and Search Events activities.

This activity is not limited to retrieving your calendar. You can also retrieve another user's calendar if the registered application in the Microsoft Office 365 Scope (ApplicationId) has permissions, or the appropriate delegated permissions from the user.

Scopes

This activity requires the following scopes:

Calendars.Read

Calendars.Read.Shared

Calendars.ReadWrite

Calendars.ReadWrite.Shared

Group.Read.All

Group.ReadWrite.All

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 and ApplicationIdAndCertificate authentication types.
User - The email address of the person whose calendar is retrieved. If none is provided, the user's own calendar is used. The user must have API permissions to read calendars. For more information, see in the Setup guide. This property supports String variables and string formatted values.

Misc

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

Output

Calendars - An array of the user's calendars. This field supports only Calendar[] variables. Required if you plan to use the output data in subsequent activities. You can also use this variable as an input variable in other activities (e.g., Create Event and Search Events).
Default Calendar - The authenticated user's default calendar, in case the User property is empty. This field supports only Calendar variables. Required if you plan to use the output data in subsequent activities. You can also use this variable as an input variable in other activities (e.g., Create Event and Search Events).

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.

Complete the steps.
Add the Microsoft Office 365 Scope activity to your project.
Add the Get Calendars activity inside the Microsoft Office 365 Scope activity.
Enter values for the Input properties.
Create and enter Calendar and Calendar[] variables for your Output property.
Run the activity.
- Your input property values are sent to the GetCalendar API.
- The API returns the Calendar and Calendar[] values to your output property variable.