Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Registre a entrada para iniciar um timeCard.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global |
Governo dos EUA L4 |
US Government L5 (DOD) |
China operada pela 21Vianet |
| ✅ |
❌ |
❌ |
❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão |
Permissões menos privilegiadas |
Permissões com privilégios mais elevados |
| Delegado (conta corporativa ou de estudante) |
Schedule.ReadWrite.All |
Indisponível. |
| Delegado (conta pessoal da Microsoft) |
Sem suporte. |
Sem suporte. |
| Application |
Schedule.ReadWrite.All |
Indisponível. |
Solicitação HTTP
POST /teams/{teamId}/schedule/timeCards/clockIn
| Cabeçalho |
Valor |
| Autorização |
{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-type |
application/json. Obrigatório. |
| MS-APP-ACTS-AS (preterido) |
Uma ID de usuário (GUID). Necessário somente se o token de autorização for um token de aplicativo; caso contrário, opcional. O MS-APP-ACTS-AS cabeçalho foi preterido e não é mais necessário com tokens de aplicativo. |
Corpo da solicitação
Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.
| Parâmetro |
Tipo |
Descrição |
| isAtApprovedLocation |
Booliano |
Indica se essa ação ocorre em um local aprovado. |
| notes |
itemBody |
Notas para o registro de entrada. |
| atApprovedLocation (preterido) |
Booliano |
Indica se essa ação ocorre em um local aprovado. Esta propriedade será removida até 27 de novembro de 2027. Use isAtApprovedLocation em vez disso.
atApprovedLocation e isAtApprovedLocation sempre tiverem o mesmo valor, portanto, definir um define automaticamente o valor do outro. Se ambos estiverem incluídos na solicitação com valores diferentes, o valor para isAtApprovedLocation terá precedência. |
| onBehalfOfUserId |
string |
A ID do usuário que você está registrando em nome. |
Resposta
Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto timeCard no corpo da resposta.
Exemplos
Exemplo 1: registrar entrada como você mesmo
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/beta/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/schedule/timeCards/clockin
Content-type: application/json
{
"isAtApprovedLocation": true,
"notes": {
"contentType": "text",
"content": "clocking in"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Teams.Item.Schedule.TimeCards.ClockIn;
using Microsoft.Graph.Beta.Models;
var requestBody = new ClockInPostRequestBody
{
IsAtApprovedLocation = true,
Notes = new ItemBody
{
ContentType = BodyType.Text,
Content = "clocking in",
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teams["{team-id}"].Schedule.TimeCards.ClockIn.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphteams "github.com/microsoftgraph/msgraph-beta-sdk-go/teams"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphteams.NewClockInPostRequestBody()
isAtApprovedLocation := true
requestBody.SetIsAtApprovedLocation(&isAtApprovedLocation)
notes := graphmodels.NewItemBody()
contentType := graphmodels.TEXT_BODYTYPE
notes.SetContentType(&contentType)
content := "clocking in"
notes.SetContent(&content)
requestBody.SetNotes(notes)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
clockIn, err := graphClient.Teams().ByTeamId("team-id").Schedule().TimeCards().ClockIn().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.teams.item.schedule.timecards.clockin.ClockInPostRequestBody clockInPostRequestBody = new com.microsoft.graph.beta.teams.item.schedule.timecards.clockin.ClockInPostRequestBody();
clockInPostRequestBody.setIsAtApprovedLocation(true);
ItemBody notes = new ItemBody();
notes.setContentType(BodyType.Text);
notes.setContent("clocking in");
clockInPostRequestBody.setNotes(notes);
var result = graphClient.teams().byTeamId("{team-id}").schedule().timeCards().clockIn().post(clockInPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const timeCard = {
isAtApprovedLocation: true,
notes: {
contentType: 'text',
content: 'clocking in'
}
};
await client.api('/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/schedule/timeCards/clockin')
.version('beta')
.post(timeCard);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Teams\Item\Schedule\TimeCards\ClockIn\ClockInPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\ItemBody;
use Microsoft\Graph\Beta\Generated\Models\BodyType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ClockInPostRequestBody();
$requestBody->setIsAtApprovedLocation(true);
$notes = new ItemBody();
$notes->setContentType(new BodyType('text'));
$notes->setContent('clocking in');
$requestBody->setNotes($notes);
$result = $graphServiceClient->teams()->byTeamId('team-id')->schedule()->timeCards()->clockIn()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Teams
$params = @{
isAtApprovedLocation = $true
notes = @{
contentType = "text"
content = "clocking in"
}
}
Invoke-MgBetaClockTeamScheduleTimeCardIn -TeamId $teamId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.teams.item.schedule.timecards.clock_in.clock_in_post_request_body import ClockInPostRequestBody
from msgraph_beta.generated.models.item_body import ItemBody
from msgraph_beta.generated.models.body_type import BodyType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ClockInPostRequestBody(
is_at_approved_location = True,
notes = ItemBody(
content_type = BodyType.Text,
content = "clocking in",
),
)
result = await graph_client.teams.by_team_id('team-id').schedule.time_cards.clock_in.post(request_body)
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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": true,
"isAtApprovedLocation": true,
"notes": {
"contentType": "text",
"content": "clocking in"
}
},
"breaks": [],
"originalEntry": {
"clockOutEvent": null,
"clockInEvent": {
"dateTime": "2021-05-27T22:58:41.327Z",
"atApprovedLocation": true,
"isAtApprovedLocation": true,
"notes": {
"contentType": "text",
"content": "clocking in"
}
},
"breaks": []
},
"createdBy": {
"application": null,
"device": null,
"conversation": null,
"user": {
"id": "70e47528-2fae-42b5-9d8e-ee73ccd90603",
"displayName": "Jing Jing GuTwo"
}
}
}
Exemplo 2: registrar entrada em nome de outro usuário
Solicitação
O exemplo a seguir mostra uma solicitação.
POST https://graph.microsoft.com/beta/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/schedule/timeCards/clockin
Content-type: application/json
{
"isAtApprovedLocation": true,
"onBehalfOfUserId": "3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Teams.Item.Schedule.TimeCards.ClockIn;
var requestBody = new ClockInPostRequestBody
{
IsAtApprovedLocation = true,
OnBehalfOfUserId = "3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teams["{team-id}"].Schedule.TimeCards.ClockIn.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphteams "github.com/microsoftgraph/msgraph-beta-sdk-go/teams"
//other-imports
)
requestBody := graphteams.NewClockInPostRequestBody()
isAtApprovedLocation := true
requestBody.SetIsAtApprovedLocation(&isAtApprovedLocation)
onBehalfOfUserId := "3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e"
requestBody.SetOnBehalfOfUserId(&onBehalfOfUserId)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
clockIn, err := graphClient.Teams().ByTeamId("team-id").Schedule().TimeCards().ClockIn().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.teams.item.schedule.timecards.clockin.ClockInPostRequestBody clockInPostRequestBody = new com.microsoft.graph.beta.teams.item.schedule.timecards.clockin.ClockInPostRequestBody();
clockInPostRequestBody.setIsAtApprovedLocation(true);
clockInPostRequestBody.setOnBehalfOfUserId("3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e");
var result = graphClient.teams().byTeamId("{team-id}").schedule().timeCards().clockIn().post(clockInPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const timeCard = {
isAtApprovedLocation: true,
onBehalfOfUserId: '3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e'
};
await client.api('/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/schedule/timeCards/clockin')
.version('beta')
.post(timeCard);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Teams\Item\Schedule\TimeCards\ClockIn\ClockInPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new ClockInPostRequestBody();
$requestBody->setIsAtApprovedLocation(true);
$requestBody->setOnBehalfOfUserId('3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e');
$result = $graphServiceClient->teams()->byTeamId('team-id')->schedule()->timeCards()->clockIn()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Teams
$params = @{
isAtApprovedLocation = $true
onBehalfOfUserId = "3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e"
}
Invoke-MgBetaClockTeamScheduleTimeCardIn -TeamId $teamId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.teams.item.schedule.timecards.clock_in.clock_in_post_request_body import ClockInPostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = ClockInPostRequestBody(
is_at_approved_location = True,
on_behalf_of_user_id = "3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e",
)
result = await graph_client.teams.by_team_id('team-id').schedule.time_cards.clock_in.post(request_body)
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 201 Created
Content-type: application/json
{
"id": "TCK_95c44dff-bc12-4de2-8a9a-9772e4421eb4",
"createdDateTime": "2025-05-07T21:35:36.311Z",
"lastModifiedDateTime": "2025-05-07T21:35:36.311Z",
"userId": "3f29c8e7-7a41-4d8e-99d6-2b1f76c9421e",
"state": "clockedIn",
"confirmedBy": "none",
"clockOutEvent": null,
"notes": null,
"lastModifiedBy": {
"application": null,
"device": null,
"user": {
"id": "d56f3e8a-2b0f-42b1-88b9-e2dbd12a34d2",
"displayName": "Alice Bradford"
}
},
"clockInEvent": {
"dateTime": "2025-05-07T21:35:36.311Z",
"isAtApprovedLocation": true,
"notes": null
},
"breaks": [],
"originalEntry": {
"clockOutEvent": null,
"clockInEvent": {
"dateTime": "2025-05-07T21:35:36.311Z",
"isAtApprovedLocation": true,
"notes": null
},
"breaks": []
},
"createdBy": {
"application": null,
"device": null,
"user": {
"id": "d56f3e8a-2b0f-42b1-88b9-e2dbd12a34d2",
"displayName": "Alice Bradford"
}
}
}