Using the MS Office 365 Get Events activity
Use the Get Events activity to retrieve different types of events along with their attachments if required from calendar in MS Office 365.
Use this task to retrieve all events within a specific time range from default calendar or a calendar_id provided. The call to this activity is a synchronous call where the input data is sent to the activity for processing and the response is sent back to the orchestration.
To configure the MS Office 365 Get Events activity:
- In an active orchestration, open the Activities tab and expand the MS Office 365 folder contents.
- Drag the Get Events activity icon onto the orchestration. The MS Office 365 Get Events checklist is displayed.
- In the checklist, click Summary.
- Review the contents of the Activity Name field, and make the required changes.
- In the checklist, click Pick Endpoint.
- Click Browse and use the Project Explorer dialog box to select the relevant MS Office 365 endpoint.
- To make required changes to the selected endpoint configuration, click Edit to access the options in a separate window. Any changes you make globally affects all uses of the endpoint in active orchestrations.
Note: Additional configuration is not required for this activity.
- Select Map Inputs in the checklist. The XML schemas generated from the selected object of the Get Events activity are displayed as nodes under the request input parameter in the To Activity panel.
- Create a map between the orchestration variables and the input parameter of the activity.
Mandatory Fields: The activity has following mandatory fields:
- InputType: This has following four values:
- Select ALL_EVENTS_WITHIN_SPECIFIED_TIME to fetch all the events within specific time range.
- Select All_RECURRINGEVENTS_FOR_CALENDAR_ID to fetch all recurring events from default primary calendar or from the calendar id provided.
- Select SINGLE_EVENTOCCURRENCES_WITHIN_SPECIFIED_TIME to fetch specific event occurrence within specified time range.
- Select SINGLE_EVENT to fetch specific event.
Optional Fields: The activity has following optional fields:
- calendarid: This is used to set the ID of the specific calendar to fetch the details from MS Office 365.
- startDateTime: Starting date and time of the time range is specified in this parameter.
- endDateTime: End date and time of the time range is specified in this parameter.
- event_id: ID of the specific event to be fetched.
- include_attachments: Specify True if attachments are required to be fetched along with events, otherwise False.
- Customize: This is used to set the Odata query parameters in following fields:
- Top
- Skip
- FilterRequests
- SelectProperties
- Orderby
Note:
- Refer ‘ODATA Query Parameters’ document for filtering, sorting, and paging parameters.
- Values must be provided at run time for any mandatory elements of the input structure. A value can be provided by specifying a default value for element or by linking the element with an input node. During run time if no value is provided for a mandatory element, the activity throws an exception, which is reported by the Web Management Console. If a value is not provided at run time for an optional input parameter, no exception is thrown during run time.
- Select Map Outputs in the checklist. The XML schema generated to hold the response of the activity is displayed as nodes under the response output parameter in the From Activity panel.
- Create a map between the output parameters and orchestration variables.
User has configured the MS Office 365 Get Events activity.
Note: You can add more than one object as input to this activity. To add more than one object as input, right-click the object in the To Activity pane of Map Inputs, and select Expand Occurrences. Only multiple objects of the same type are supported.