ScheduleViewRequest¶
Example Json Object
1{
2 "principalPositionTypeStr": "LESSEE",
3 "unitId": 0,
4 "viewId": "lessee-all-columns",
5 "leaseMeasurementId": 0,
6 "activationGroupRevisionId": 10001,
7 "fromYear": 2020,
8 "toYear": 2020,
9 "scheduleAggregationLevel": "PER_ACTIVATION_GROUP"
10}
📄 Description: Data transfer object representing a request to view scheduling information related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for real estate property management.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
principalPositionTypeStr |
string |
true |
none |
Represents the type of principal position within the portfolio, asset, and real estate property analytics context. |
unitId |
integer(int64) |
false |
none |
If unit id is provided then system will return all posting related information |
viewId |
string |
true |
none |
Unique identifier for the view |
leaseMeasurementId |
integer(int64) |
true |
none |
Unique identifier for the lease measurement |
activationGroupRevisionId |
integer(int64) |
false |
none |
If Activation Group Revision Id is provided then system will check if the Revision Id is in relation with Provided Activation Group Id and then it will fetch the data base on Activation Group Revision Id |
fromYear |
integer(int32) |
true |
none |
Numeric value representing fromYear |
toYear |
integer(int32) |
true |
none |
Numeric value representing toYear |
scheduleAggregationLevel |
string |
false |
none |
If the aggregation level is provided. The schedule’s data will be aggregated according to the grouping level provided. |
Enumerated Values
Attribute |
Value |
|---|---|
scheduleAggregationLevel |
PER_ACTIVATION_GROUP, PER_UNIT |