| title | timeCard: startBreak |
|---|---|
| description | Start break in a specific timecard. |
| author | lemike |
| ms.date | 01/17/2025 |
| ms.localizationpriority | medium |
| ms.subservice | teams |
| doc_type | apiPageType |
Namespace: microsoft.graph
Start a break in a specific timeCard.
[!INCLUDE national-cloud-support]
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]
Important
When you use Schedule.ReadWrite.All application permission, you must include the MS-APP-ACTS-AS header in the request.
POST /teams/{teamsId}/schedule/timeCards/{timeCardId}/startBreak| 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. |
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. |
If successful, this method returns a 204 No Content response code.
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"
}
}[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
HTTP/1.1 204 No Content