timeCard resource type
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.
Represents a timecard entry in the schedule.
Methods
| Method | Return type | Description |
|---|---|---|
| List | timeCard collection | Get the list of timecard objects in this schedule. |
| Create | timeCard | Create a new timecard object. |
| Get | timeCard | Get a timecard object by ID. |
| Replace | None | Replace a timecard object. |
| Delete | None | Delete a timecard object from the schedule. |
| Clock in | timeCard | Clock in to start a timecard. |
| Clock out | None | Clock out to end an open timecard. |
| Start break | None | Start a timeCardBreak in a specific timecard. |
| End break | None | End the open timeCardBreak in a specific timecard. |
| Confirm | None | Confirm a timecard record. |
Properties
| Property | Type | Description |
|---|---|---|
| breaks | timeCardBreak collection | The list of breaks associated with the timeCard. |
| clockInEvent | timeCardEvent | The clock-in event of the timeCard. |
| clockOutEvent | timeCardEvent | The clock-out event of the timeCard. |
| confirmedBy | confirmedBy | Indicates whether this timeCard entry is confirmed. Possible values are none, user, manager, unknownFutureValue. |
| createdBy | identitySet | Identity of the person who created the entity. |
| createdDateTime | DateTimeOffset | The timestamp in which the timeCard was created. |
| id | String | Unique identifier for the timeCard. |
| lastModifiedBy | identitySet | Identity of the person who last modified the entity. |
| lastModifiedDateTime | DateTimeOffset | The timestamp in which the timeCard was last modified. |
| notes | itemBody | Notes about the timeCard. |
| originalEntry | timeCardEntry | The original timeCardEntry of the timeCard, before user edits. |
| state | timeCardState | The current state of the timeCard during its life cycle.Possible values are: clockedIn, onBreak, clockedOut, unknownFutureValue. |
| userId | String | User ID to which the timeCard belongs. |
JSON representation
The following JSON representation shows the resource type.
{
"breaks": [{"@odata.type":"microsoft.graph.timeCardEvent"}],
"clockInEvent": {"@odata.type":"microsoft.graph.timeCardEvent"},
"clockOutEvent": {"@odata.type":"microsoft.graph.timeCardEvent"},
"confirmedBy": "String",
"createdBy": {"@odata.type":"microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"lastModifiedBy": {"@odata.type":"microsoft.graph.identitySet"},
"lastModifiedDateTime": "String (timestamp)",
"notes": {"@odata.type":"microsoft.graph.itemBody"},
"originalEntry": {"@odata.type":"microsoft.graph.timeCardEntry"},
"state": "String",
"userId": "String"
}