EntityType element: TimesheetPeriod (ProjectServerData service)
In this article
Definition
Parent element
Child elements
Contains the properties that define the reporting data for a timesheet period in the ProjectData service.
Example
The following REST query uses the TimesheetPeriods entity set and the PeriodId key to get the specified timesheet period. The query is all on one line.
https://<pwa-url>/_api/ProjectData/TimesheetPeriods
?$filter=PeriodId eq guid'e536e2e2-6eaa-e111-99fe-00155d4a4104'
Definition
<EntityType Name="TimesheetPeriod">
<Key>
<PropertyRef Name="PeriodId" />
</Key>
<Property Name="PeriodId" Type="Edm.Guid" Nullable="false" />
. . .
</EntityType>
Parent element
Element |
Description |
|---|---|
The schema for the reporting data in the ProjectData service. |
Child elements
Child elements are properties of a timesheet period. Attributes of the Property elements specify the property name and type, and whether the property can be a null value. Unlike most entity types, there are no NavigationProperty child elements for the TimesheetPeriod entity type.
The Key element specifies the property that is the primary key for a timesheet period query. PeriodId is the timesheet period GUID.
Property elements
The following table lists the Property elements for the TimesheetPeriod entity. The Name, Type, and Nullable columns contain attribute values for each property.
Attribute values for the Property elements
Name |
Type |
Nullable |
Description |
|---|---|---|---|
Description |
Edm.String |
true |
The text field for the timesheet period description. |
EndDate |
Edm.DateTime |
false |
The end date and time of the timesheet period. |
LCID |
Edm.Int32 |
true |
The locale identifier. |
PeriodId |
Edm.Guid |
false |
Key |
PeriodName |
Edm.String |
true |
The name of the timesheet period. |
PeriodStatusId |
Edm.Byte |
false |
The status identifier of the timesheet period (open, closed, or all periods). |
StartDate |
Edm.DateTime |
false |
The start date and time of the timesheet period. |
NavigationProperty elements
There are no NavigationProperty child elements for the TimesheetPeriod entity type.