Data

POST /ver2/DataService.svc/calculations/calculationperiods

envianceSdk.data.getCalculationPeriods

[
  {
    "start": {
      "relativity": "Current",
      "periodType": "CalendarDay"
    },
    "end": {
      "relativity": "Current",
      "periodType": "Day",
      "periodCount": 1
    },
    "intervalType": "Hourly",
    "factor": 1,
    "limit": 100,
    "timezones": []
  },
  "onsuccess",
  "onerror"
]

[
  {
    "start": {
      "relativity": "Absolute",
      "absoluteDate": "2012-01-01T00:00:00"
    },
    "end": {
      "relativity": "Current",
      "periodType": "Day",
      "periodCount": 1
    },
    "intervalType": "Hourly",
    "factor": 1,
    "limit": 100,
    "timezones": []
  },
  "onsuccess",
  "onerror"
]

[
  {
    "start": {
      "relativity": "Following",
      "periodType": "Day",
      "periodCount": 2
    },
    "end": {
      "relativity": "AfterStart",
      "periodType": "Month",
      "periodCount": 6
    },
    "intervalType": "Weekly",
    "factor": 2,
    "limit": 100,
    "timezones": []
  },
  "onsuccess",
  "onerror"
]

Request

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Request body

intervalType'Minutes' | 'Hourly' | 'HourlyTimeBased' | 'Daily' | 'DailyTimeBased' | 'Weekly' | 'WeeklyTimeBased' | 'Monthly' | 'MonthlyTimeBased' | 'QuarterlyTimeBased' | 'Yearly' | 'YearlyTimeBased' enum
factorinteger
limitinteger
timezonesinteger[]

Response

not available

beginDatestring date-time
endDatestring date-time
saveDatestring date-time
dontExistInTimeZoneinteger[]

Changes

No recorded changes to this operation across all 1 revision of this API.