timeCard: clockIn
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Clock in to start a 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 the Schedule.ReadWrite.All application permission, you must include the MS-APP-ACTS-AS
header in the request.
HTTP request
POST /teams/{teamId}/schedule/timeCards/clockIn
Request headers
Header | Value |
---|---|
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 |
---|---|---|
atApprovedLocation | Edm.boolean |
Indicate if this action happens at an approved location. |
onBehalfOfUserId | String | Optional parameter used by the manager to clock in on behalf of a user. |
notes | itemBody | Notes for the clock in. |
Response
If successful, this method returns a 201 Created
response code and a timeCard object in the response body.
Example
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/schedule/timeCards/clockin
Content-type: application/json
{
"atAprovedLocation": true,
"notes": {
"contentType": "text",
"content": "clock in notes"
}
}
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-type: application/json
{
"id": "TCK_cc09588d-d9d2-4fa0-85dc-2aa5ef983972",
"createdDateTime": "2021-05-27T22:58:41.327Z",
"lastModifiedDateTime": "2021-05-27T22:58:41.327Z",
"userId": "70e47528-2fae-42b5-9d8e-ee73ccd90603",
"state": "clockedIn",
"confirmedBy": "none",
"clockOutEvent": null,
"notes": null,
"lastModifiedBy": {
"application": null,
"device": null,
"conversation": null,
"user": {
"id": "70e47528-2fae-42b5-9d8e-ee73ccd90603",
"displayName": "Jing Jing GuTwo"
}
},
"clockInEvent": {
"dateTime": "2021-05-27T22:58:41.327Z",
"atApprovedLocation": null,
"notes": {
"contentType": "text",
"content": "clock in notes"
}
},
"breaks": [],
"originalEntry": {
"clockOutEvent": null,
"clockInEvent": {
"dateTime": "2021-05-27T22:58:41.327Z",
"atApprovedLocation": null,
"notes": {
"contentType": "text",
"content": "clock in notes"
}
},
"breaks": []
},
"createdBy": {
"application": null,
"device": null,
"conversation": null,
"user": {
"id": "70e47528-2fae-42b5-9d8e-ee73ccd90603",
"displayName": "Jing Jing GuTwo"
}
}
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for