Configuration_GetPeriodDefinition (Get)
- Last UpdatedNov 13, 2025
- 1 minute read
| Get | Configuration_GetPeriodDefinition |
Resource Path:/api/v1/config/GetPeriodDefinition
| Name | Description | Data Type |
|---|---|---|
| periodName | Required. The period name. | string |
| sampleDateTime | Required. The date and time of the data collection, which may or may not be the same as the date and time of the record creation. | string |
The response body is of type PeriodDefinition.
Request
GET 'https://localhost:9003/api/v1/config/GetPeriodDefinition?PeriodName=Month&SampleDateTime=2019-12-23T10:10:10Z'Response
{
"PeriodName": "Month",
"Description": "December[0] from Sunday, 1 December 2019 12:00:00 AM until Wednesday, 1 January 2020 12:00:00 AM",
"StartDateTimeUtc": "2019-11-30T14:00:00Z",
"EndDateTimeUtc": "2019-12-31T14:00:00Z",
"PreviousPeriodStartDateTimeUtc": "2019-10-31T14:00:00Z",
"PreviousPeriodEndDateTimeUtc": "2019-11-30T14:00:00Z"
}