Adapter - Microsoft Office 365 - Exchange Online
This page describes version 2.0.3 of the adapter.
Overview
This adapter is used to search for schedules registered with Microsoft Exchange Online.
Configuration
This adapter requires a tenantId and clientId and clientSecret. These can be created on the Azure portal page.
Warning
- When using this adapter, it is necessary to register the application to access Exchange Online and read the user's schedule.
- It is necessary to grant the permission "Calendars.Read" to the registered application to read the user's schedule.
- Up to 50 schedules can be searched with this adapter. If 51 or more schedules are registered in the search range, 50 will be get in ascending order of start time. Schedules with the same start time are sorted in ascending order by subject.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| tenantId | Tenant ID | True | An identifier for identifying the tenant. You can find your Tenant ID on the Azure portal page. | string | |||||
| clientId | Client ID | True | An identifier for identifying the client application. You can find your Client ID on the Azure portal page. | string | |||||
| clientSecret | Client Secret | True | The client application private key. You can find the Client Secret on the Azure portal page. | password | |||||
| timeZone | TimeZone Information | True | IANA timezone. For Example: Japan: Asia/Tokyo | string |
Commands
Get Schedule (listCalendarView)
Get Schedule for specified user.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| username | User Name | User that get schedules.(Email Address) | True | string |
| start | Start Date and Time | Start Date and Time that get schedules. Format: yyyy-MM-ddTHH:mm:ssK | False | string |
| end | End Date and Time | End Date and Time that get schedules. Format: yyyy-MM-ddTHH:mm:ssK | False | string |
| searchFilter | Search Filter | Search filter condition. Multiple specification is possible. 1: Started, 2: Scheduling, 4: Canceled, 8: All Day. For example 3=Started+Scheduling Schedules. | False | string |
| number | Number | Max number that get schedules. | False | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| codenum | '1' input parameter error, '2' authentication error, '3' system error, '4' Graph API call error | string |
| start | Start for searching. Format: yyyy-MM-ddTHH:mm:ssK | string |
| end | End for searching. Format: yyyy-MM-ddTHH:mm:ssK | string |
| schedules.subject | Subject for schedule | string |
| schedules.start | Start for schedule. Format: yyyy-MM-ddTHH:mm:ssK | string |
| schedules.end | End for schedule. Format: yyyy-MM-ddTHH:mm:ssK | string |
| schedules.location | Location for schedule | string |
| schedules.isStarted | Schedule is started or not. 1: Started, 0: Not Started | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.2 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.3 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |