Skip to content

Latest commit

 

History

History
151 lines (111 loc) · 6.33 KB

industrydata-yeartimeperioddefinition-post.md

File metadata and controls

151 lines (111 loc) · 6.33 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
Create yearTimePeriodDefinition
Create a new yearTimePeriodDefinition object.
mlafleur
medium
industry-data-etl
apiPageType

Create yearTimePeriodDefinition

Namespace: microsoft.graph.industryData

[!INCLUDE beta-disclaimer]

Create a new yearTimePeriodDefinition object.

[!INCLUDE national-cloud-support]

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.

[!INCLUDE permissions-table]

HTTP request

POST /external/industryData/years

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the microsoft.graph.industryData.yearTimePeriodDefinition object.

You can specify the following properties when you create a yearTimePeriodDefinition.

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

Response

If successful, this method returns a 201 Created response code and a microsoft.graph.industryData.yearTimePeriodDefinition object in the response body.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/external/industryData/years
Content-Type: application/json
Content-length: 242

{
  "displayName": "Fiscal Year 2022",
  "endDate": "2023-06-15",
  "startDate": "2022-09-01",
  "year": {
    "code": "2022"
  }
}

C#

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

CLI

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Go

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Java

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PHP

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

PowerShell

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Python

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/years/$entity",
  "displayName": "Fiscal Year 2022",
  "endDate": "2023-06-15",
  "id": "ebf18762-ab92-487e-21d1-08daddab28bb",
  "startDate": "2022-09-01",
  "year": {
    "code": "2022"
  }
}