Bewerken

Delen via

timeCard: startBreak

  • Artikel

Namespace: microsoft.graph

Start a break in a specific timeCard.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ❌ ❌ ❌

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) Schedule.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Schedule.ReadWrite.All Not available.

Important

When you use Schedule.ReadWrite.All application permission, you must include the MS-APP-ACTS-AS header in the request.

HTTP request

POST /teams/{teamsId}/schedule/timeCards/{timeCardId}/startBreak

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-type application/json. Required.
MS-APP-ACTS-AS The ID of the user on behalf of whom the app is acting. Required when you use the application permission scope.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
isAtApprovedLocation Boolean Indicates whether this action happens at an approved location.
notes itemBody Notes for the start of the break.

Response

If successful, this method returns a 204 No Content response code.

Example

Request

The following example shows a request.

POST https://graph.microsoft.com/v1.0/teams/871dbd5c-3a6a-4392-bfe1-042452793a50/schedule/timeCards/TCK_29ad0a09-b97a-49a2-9490-141cb7602540/startbreak

{
  "isAtApprovedLocation": true,
  "notes": {
    "content": "Starting break late to make up for late clockin",
    "contentType": "text"
  }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content