Microsoft: Invoke action get Schedule — me Calendar Group calendar Groups Calendars Get Schedule

Microsoft meCalendarGroup.calendarGroupsCalendarsGetSchedule: arguments, response, policy and SDK examples.

← Me calendar group operations · Get started

Operation microsoft.me_calendargroups_calendargroup_calendars_calendar_getschedule

Provider route: POST /me/calendarGroups/{calendarGroup-id}/calendars/{calendar-id}/getSchedule. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/microsoft with npm, or alter-sdk-microsoft with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { MicrosoftIntegration } from "@alter-ai/microsoft";

async function execute(input: Parameters<MicrosoftIntegration["meCalendarGroup"]["calendarGroupsCalendarsGetSchedule"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new MicrosoftIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.meCalendarGroup.calendarGroupsCalendarsGetSchedule(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_microsoft import MicrosoftIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = MicrosoftIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.me_calendar_group.calendar_groups_calendars_get_schedule(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.calendarGroup-id`	string	Required within parent
`path.calendar-id`	string	Required within parent
`body`	Model	Required within parent	Expand Invoke action get Schedule — me Calendar get Schedule — request body — body

Referenced models: Invoke action get Schedule — me Calendar get Schedule — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	object	Root
`$ (allOf 1)`	Model	All variants apply	Expand List rules — response body — @odata count, @odata next Link
`$ (allOf 2)`	object	All variants apply
`$ (allOf 2).value`	array	Optional
`$ (allOf 2).value[]`	Model	Each item	Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item

Referenced models: List rules — response body — @odata count, @odata next Link, Invoke action get Schedule — me Calendar get Schedule — response body — value value item

Schemas

1 more schema is linked from the tables above, on the schema pages.

List rules — response body — @odata count, @odata next Link

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.count`	JSON	Optional
`@odata.count (anyOf 1)`	JSON	Alternative
`@odata.count (anyOf 1) (anyOf 1)`	integer	Alternative	Format: int64
`@odata.count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`@odata.count (anyOf 2)`	null	Alternative
`@odata.nextLink`	JSON	Optional
`@odata.nextLink (anyOf 1)`	string	Alternative
`@odata.nextLink (anyOf 2)`	null	Alternative

Invoke action get Schedule — me Calendar get Schedule — response body — value value item

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`availabilityView`	JSON	Optional
`availabilityView (anyOf 1)`	string	Alternative	Represents a merged view of availability of all the items in scheduleItems. The view consists of time slots. Availability during each time slot is indicated with: 0= free or working elswhere, 1= tentative, 2= busy, 3= out of office.Note: Working elsewhere is set to 0 instead of 4 for backward compatibility. For details, see the Q&A and Exchange 2007 and Exchange 2010 do not use the WorkingElsewhere value.
`availabilityView (anyOf 2)`	null	Alternative
`error`	JSON	Optional	Error information from attempting to get the availability of the user, distribution list, or resource.
`error (anyOf 1)`	Model	Alternative	Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item error @odata type, message, response Code
`error (anyOf 2)`	JSON	Alternative
`error (anyOf 2) (anyOf 1)`	object	Alternative
`error (anyOf 2) (anyOf 2)`	null	Alternative
`scheduleId`	JSON	Optional
`scheduleId (anyOf 1)`	string	Alternative	An SMTP address of the user, distribution list, or resource, identifying an instance of scheduleInformation.
`scheduleId (anyOf 2)`	null	Alternative
`scheduleItems`	array	Optional	Contains the items that describe the availability of the user or resource.
`scheduleItems[]`	Model	Each item	Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item schedule Items item
`workingHours`	JSON	Optional	The days of the week and hours in a specific time zone that the user works. These are set as part of the user's mailboxSettings.
`workingHours (anyOf 1)`	Model	Alternative	Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone
`workingHours (anyOf 2)`	JSON	Alternative
`workingHours (anyOf 2) (anyOf 1)`	object	Alternative
`workingHours (anyOf 2) (anyOf 2)`	null	Alternative

Referenced models: Invoke action get Schedule — me Calendar get Schedule — response body — value value item error @odata type, message, response Code, Invoke action get Schedule — me Calendar get Schedule — response body — value value item schedule Items item, Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone

Invoke action get Schedule — me Calendar get Schedule — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`AvailabilityViewInterval`	JSON	Optional
`AvailabilityViewInterval (anyOf 1)`	number	Alternative	Format: int32 Maximum: 2147483647 Minimum: -2147483648
`AvailabilityViewInterval (anyOf 2)`	null	Alternative
`EndTime`	JSON	Optional
`EndTime (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`EndTime (anyOf 2)`	JSON	Alternative
`EndTime (anyOf 2) (anyOf 1)`	object	Alternative
`EndTime (anyOf 2) (anyOf 2)`	null	Alternative
`Schedules`	array	Optional
`Schedules[]`	JSON	Each item
`Schedules[] (anyOf 1)`	string	Alternative
`Schedules[] (anyOf 2)`	null	Alternative
`StartTime`	JSON	Optional
`StartTime (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`StartTime (anyOf 2)`	JSON	Alternative
`StartTime (anyOf 2) (anyOf 1)`	object	Alternative
`StartTime (anyOf 2) (anyOf 2)`	null	Alternative

Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time

Invoke action get Schedule — me Calendar get Schedule — response body — value value item error @odata type, message, response Code

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`message`	JSON	Optional
`message (anyOf 1)`	string	Alternative	Describes the error.
`message (anyOf 2)`	null	Alternative
`responseCode`	JSON	Optional
`responseCode (anyOf 1)`	string	Alternative	The response code from querying for the availability of the user, distribution list, or resource.
`responseCode (anyOf 2)`	null	Alternative

Invoke action get Schedule — me Calendar get Schedule — response body — value value item schedule Items item

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`end`	JSON	Optional	The date, time, and time zone that the corresponding event ends.
`end (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`end (anyOf 2)`	JSON	Alternative
`end (anyOf 2) (anyOf 1)`	object	Alternative
`end (anyOf 2) (anyOf 2)`	null	Alternative
`isPrivate`	JSON	Optional
`isPrivate (anyOf 1)`	boolean	Alternative	The sensitivity of the corresponding event. True if the event is marked private, false otherwise. Optional.
`isPrivate (anyOf 2)`	null	Alternative
`location`	JSON	Optional
`location (anyOf 1)`	string	Alternative	The location where the corresponding event is held or attended from. Optional.
`location (anyOf 2)`	null	Alternative
`start`	JSON	Optional	The date, time, and time zone that the corresponding event starts.
`start (anyOf 1)`	Model	Alternative	Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
`start (anyOf 2)`	JSON	Alternative
`start (anyOf 2) (anyOf 1)`	object	Alternative
`start (anyOf 2) (anyOf 2)`	null	Alternative
`status`	JSON	Optional	The availability status of the user or resource during the corresponding event. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
`status (anyOf 1)`	string	Alternative	Known values: unknown, free, tentative, busy, oof, workingElsewhere
`status (anyOf 2)`	JSON	Alternative
`status (anyOf 2) (anyOf 1)`	object	Alternative
`status (anyOf 2) (anyOf 2)`	null	Alternative
`subject`	JSON	Optional
`subject (anyOf 1)`	string	Alternative	The corresponding event's subject line. Optional.
`subject (anyOf 2)`	null	Alternative

Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time

Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time

Field	Type	Presence	Description and constraints
`$`	object	Root
`@odata.type`	string	Optional
`dateTime`	string	Optional	A single point of time in a combined date and time representation ({date}T{time}; for example, 2017-08-29T04:00:00.0000000).
`timeZone`	JSON	Optional
`timeZone (anyOf 1)`	string	Alternative	Represents a time zone, for example, 'Pacific Standard Time'. See below for more possible values.
`timeZone (anyOf 2)`	null	Alternative

Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone time Zone @odata type, name

Field	Type	Presence	Description and constraints
`$`	object	Root	discriminator: {"mapping": {}, "propertyName": "@odata.type"}
`@odata.type`	string	Optional
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone.
`name (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: microsoft.me_calendargroups_calendargroup_calendars_calendar_getschedule. Catalog operation: me_calendargroups_calendargroup_calendars_calendar_getschedule. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page