Adapter - Exchange
This page describes version 2.0.8 of the adapter.
Overview
This adapter is used to search for schedules registered with Microsoft Exchange. This adapter requires a valid Exchange account.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| ExchangeVersion | Exchange Server Version | True | Exchange2013 = 5, Exchange2013_SP1 or later = 6, Exchange2016/2019 = 8 | integer | 1 | ||||
| CredentialsId | User Name | True | Format: |
string | |||||
| CredentialsPass | Password | True | Password | password | |||||
| ConnectionPoints | EWS Url | True | For Example: https:// |
string | |||||
| TimeZone | TimeZone Information | True | IANA timezone. For Example: Japan: Asia/Tokyo | string | |||||
| Timeout | Connection Timeout | False | Default Value is 15 second. | integer | |||||
| HealthCheckInterval | Health Check Interval (Second) | False | 0: Disable. Default value is 0. | integer |
Commands
Get Schedule (GetSchedule)
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 | Enable if command request fails. | 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.6 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.7 | Bug fix | Unable to start Exchange adapter | NAP-22448 | |
| 2.0.8 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |