Read the Event
Read Office 365 Calendar event information from an authorized user or for another user's calendar using an Event ID.
Options
Field | Definition | Type | Required |
---|---|---|---|
Calendar |
Choose the calendar type:
|
Dropdown |
TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Read From |
|||
Calendar |
Choose a calendar from the list. Appears when you select My Calendars for the Calendar option. |
Dropdown |
TRUE |
User ID or Username: |
Unique ID of the user or username. Appears when you select User Calendars for the Calendar option. |
Text |
TRUE |
Calendar ID |
Unique ID of the calendar. Appears when you select User Calendars for the Calendar option. |
Text |
TRUE |
Read By |
|||
Event ID |
Unique ID of the event. |
Text |
TRUE |
Output
Field | Definition | Type |
---|---|---|
Result |
||
Created |
Date and time information about when the event was created. This field is in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-18T16:06:59.8274625Z |
Date & Time |
Last Modified |
Date and time information about when the event was modified. This field is in ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-18T16:06:59.8274625Z |
Date & Time |
Categories |
Categories associated with the event. |
List of Text |
Original Start Time Zone |
Represents the time zone used during event creation. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
Text |
Original End Time Zone |
Represents the time zone used during event completion. |
Text |
iCalUId |
Unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. |
Text |
Reminder Minutes Before Start |
Number of minutes before the event start time that the reminder alert occurs. |
Number |
Is Reminder On? |
True if an alert is set to remind the user of the event. Otherwise False. |
True/False |
Has Attachments? |
True if the event has attachments. Otherwise False. |
True/False |
Subject |
Text of the event's subject line. |
Text |
Body Preview |
The preview of the message associated with the event. |
Text |
Importance |
Indicates the importance of the event.
|
Text |
Sensitivity |
Indicates the sensitivity of the event.
|
Text |
Is All Day? |
True if the event lasts all day. Otherwise False. If true, regardless of whether it's a single-day or multi-day event, the start and end time must be set to midnight and be in the same time zone. |
True/False |
Is Cancelled? |
True if the event has been canceled. Otherwise False. |
True/False |
Is Organizer? |
True if the calendar owner is the organizer of the event. Otherwise False. This also applies if a delegate organized the event on behalf of the owner. |
True/False |
Response Requested? |
True if the organizer would like an invitee to send a response to the event. Otherwise False. |
True/False |
Show As |
Status to show. |
Text |
Type |
Event type. |
Text |
Web Link |
URL to open the event in Outlook on the web. Outlook on the web opens the event in the browser if you're signed in to your mailbox. Otherwise, Outlook on the web prompts you to sign in. |
Text |
Online Meeting URL |
URL for an online meeting. |
Text |
Is Online Meeting? |
True when this event has online meeting information. For example, an online meeting points to an online meeting info resource (phones). Otherwise False. |
True/False |
Online Meeting Provider |
Represents the online meeting service provider. |
Text |
Allow New Time Proposals? |
True when the meeting organizer allows invitees to propose a new time when responding. Otherwise False. |
True/False |
Occurrence ID |
An identifier for an occurrence in a recurring event series. Null if the event isn't part of a recurring series, |
Text |
Is Draft? |
True if the user has updated the meeting in Outlook but hasn't sent the updates to attendees. Otherwise False. |
True/False |
Hide Attendees? |
True if each attendee only sees themselves in the meeting request and meeting Tracking list. Otherwise False. |
True/False |
Response Status |
||
Response |
Response status from attendee. |
Text |
Time |
Date and time that the response was returned. It uses the ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
Date & Time |
Body |
||
Content Type |
Type of the body content. |
Text |
Content |
Unformatted content of the body of the event. |
Text |
Start |
||
Date Time |
Start of the event in a combined date and time representation {date}T{time}. For example, 2017-08-29T04:00:00.0000000. |
Date & Time |
Time Zone |
Represents a time zone. For example, Pacific Standard Time. |
Text |
End |
||
Date Time |
End of the event in a combined date and time representation {date}T{time}. For example, 2017-08-29T04:00:00.0000000. |
Date & Time |
Time Zone |
Represents a time zone. For example, Pacific Standard Time. |
Text |
Location |
||
Display Name |
Name associated with the location. |
Text |
Location URI |
URI representing the location. |
Text |
Location Type |
Type of location. |
Text |
Unique ID |
Unique identifier of the event. |
Text |
Unique ID Type |
Unique identifier type of the location. |
Text |
Street |
Street address of the user's place of business. |
Text |
City |
City in which the event is located. |
Text |
State |
State of the event. |
Text |
Country or Region |
Country or region of the event. |
Text |
Postal Code |
Postal code of the location. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code. |
Text |
Latitude |
Latitude of the location. |
Number |
Longitude |
Latitude of the location. |
Number |
Locations |
||
Display Name |
Name associated with the location. |
Text |
Location URI |
URI representing the location. |
Text |
Location Type |
Type of location. |
Text |
Unique ID |
Unique identifier of the event. |
Text |
Unique ID Type |
Unique identifier type of the location. |
Text |
Street |
Street address of the user's place of business. |
Text |
City |
City in which the event is located. |
Text |
State |
State of the event. Appears when multiple locations are returned. |
Text |
Country or Region |
Country or region of the event. |
Text |
Postal Code |
Postal code of the location. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code. |
Text |
Latitude |
Latitude of the location. |
Number |
Longitude |
Latitude of the location. |
Number |
Recurrence |
||
Pattern |
Frequency of the event repeating. |
Text |
Type |
Recurrence pattern type. |
Text |
Interval |
Number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. |
Number |
Month |
Month in which the event occurs. This is a number from 1 to 12. |
Number |
Day of Month |
Day of the month on which the event occurs. |
Text |
First Day of Week |
The first day of the week. |
Text |
Index |
Specifies on which instance of the allowed days specified in days of week the event occurs, counted from the first instance in the month. |
Text |
Range |
||
Type |
Recurrence range. |
Text |
Start Date |
Date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. This must be the same value as the start property of the recurring event. For example, YYYY-MM-DD |
Text |
End Date |
Date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. For example, YYYY-MM-DD |
Text |
Recurrence Time Zone |
Time zone for the Start Date and End Date properties. |
Text |
Number of Occurrences |
Number of times to repeat the event. Required and must be positive if the type is numbered. |
Number |
Attendees |
||
Type |
Attendee type. |
Text |
Status |
||
Response |
Response type. |
Text |
Time |
The date and time that the response was returned. It uses the ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
Date & Time |
Email Address |
||
Name |
Display name of the person or entity. |
Text |
Address |
Email address of the person or entity. |
Text |
Organizer |
||
Email Address |
Email address of owner of calendar. |
Text |
Name |
Name of organizer. |
Text |
Address |
Email address of the organizer. |
Text |
Online Meeting |
||
Conference ID |
ID of the conference. |
Text |
Join URL |
External link that launches the online meeting. This is a URL that clients enter into a browser that redirects the user to join the meeting. |
Text |
Phones |
All phone numbers associated with this conference. |
List of Objects |
Number |
Phone number. |
Text |
Type |
Type of phone number. |
Text |
Quick Dial |
Pre-formatted quick dial for this call. |
Text |
Toll Free Number |
Toll-free numbers that can be used to join the conference. |
List of Text |
Toll Number |
Toll number that can be used to join the conference. |
Text |
Additional information
-
You can specify the time zone for each of the start and end times of the event.
-
An Exchange administrator can set up a mailbox and an email address for a resource such as a meeting room, or equipment like a projector. Users can then invite the resource as an attendee to a meeting.
-
Location output fields depend on the number of locations.
-
When organizing an event that involves a meeting location:
-
Set the location property of the event accordingly.
-
Set the optional location Email Address property if the meeting location has an email address.
-