Skip to content

industrydata-yeartimeperioddefinition.md

Latest commit

 

History

History
64 lines (50 loc) · 4.67 KB

industrydata-yeartimeperioddefinition.md

File metadata and controls

64 lines (50 loc) · 4.67 KB
title yearTimePeriodDefinition resource type
description Represents annual time periods such as academic or fiscal years.
author mlafleur
ms.localizationpriority medium
ms.subservice industry-data-etl
doc_type resourcePageType
ms.date 07/22/2024

yearTimePeriodDefinition resource type

Namespace: microsoft.graph.industryData

[!INCLUDE beta-disclaimer]

Represents annual time periods such as academic or fiscal years. This resource allows the association of incoming data to a year to help build historical data, day-by-day, year-over-year, as time progresses. In the case of data domain for education rostering, this is commonly referred to as an academic year. The approach is aligned to an academic year versus a calendar year.

Methods

Method Return type Description
Create microsoft.graph.industryData.yearTimePeriodDefinition Create a new yearTimePeriodDefinition object.
List microsoft.graph.industryData.yearTimePeriodDefinition collection Get a list of the yearTimePeriodDefinition objects and their properties.
Get microsoft.graph.industryData.yearTimePeriodDefinition Read the properties and relationships of a yearTimePeriodDefinition object.
Update microsoft.graph.industryData.yearTimePeriodDefinition Update the properties of a yearTimePeriodDefinition object.
Delete None Delete a yearTimePeriodDefinition object.

Properties

Property Type Description
displayName String The name of the year. Maximum supported length is 100 characters.
endDate Date The last day of the year using ISO 8601 format for date.
startDate Date The first day of the year using ISO 8601 format for date.
year microsoft.graph.industryData.yearReferenceValue A pointer to a year entry in the referenceDefinition collection.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.industryData.yearTimePeriodDefinition",
  "displayName": "String",
  "endDate": "String (date)",
  "startDate": "String (date)",
  "year": {
    "@odata.type": "microsoft.graph.industryData.yearReferenceValue"
  }
}