Skip to content

schedule-get.md

Latest commit

 

History

History
157 lines (116 loc) · 5.55 KB

schedule-get.md

File metadata and controls

157 lines (116 loc) · 5.55 KB
title Get schedule
description Retrieve the properties and relationships of a **schedule** object.
author shanemalone
ms.date 12/04/2024
ms.localizationpriority medium
ms.subservice teams
doc_type apiPageType

Get schedule

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve the properties and relationships of a schedule object.

The schedule creation process conforms to the One API guideline for resource based long running operations (RELO). When clients use the PUT method, if the schedule is provisioned, the operation updates the schedule; otherwise, the operation starts the schedule provisioning process in the background.

During schedule provisioning, clients can use the GET method to get the schedule and look at the provisionStatus property for the current state of the provisioning. If the provisioning failed, clients can get additional information from the provisionStatusCode property.

Clients can also inspect the configuration of the schedule.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

GET /teams/{teamId}/schedule

Optional query parameters

This method does not support OData query parameters to customize the response.

Request headers

Header Value
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.
MS-APP-ACTS-AS (deprecated) A user ID (GUID). Required only if the authorization token is an application token; otherwise, optional. The MS-APP-ACTS-AS header is deprecated and no longer required with application tokens.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a schedule object in the response body.

Example

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/teams/{teamId}/schedule

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "833fc4df-c88b-4398-992f-d8afcfe41df2",
  "enabled": true,
  "timeZone": "America/Chicago",
  "provisionStatus": "Completed",
  "provisionStatusCode": null,
  "timeClockEnabled": true,
  "openShiftsEnabled": true,
  "swapShiftsRequestsEnabled": true,
  "offerShiftRequestsEnabled": true,
  "timeOffRequestsEnabled": true,
  "startDayOfWeek": "Monday",
  "activitiesIncludedWhenCopyingShiftsEnabled": true,
  "isActivitiesIncludedWhenCopyingShiftsEnabled": true,
  "isCrossLocationShiftsEnabled": true,
  "isCrossLocationShiftRequestApprovalRequired": true
}

Related content

Microsoft Graph service-specific throttling limits