Area¶
Area - Get Area¶
HTTP Request
GET /api/areas/{id}
📋 Description: Retrieves detailed information about a specific area within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset performance in the context of real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "typeId": 0,
10 "unitId": 0,
11 "sourceId": 0,
12 "proShareTypeId": 0,
13 "documentId": 0,
14 "grossUp": 0,
15 "lot": "string",
16 "cadaster": "string",
17 "name": "string",
18 "verified": true,
19 "toBeMeasured": true,
20 "gla": true,
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "source": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 },
77 "proShareType": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitType": {
106 "createdBy": "string",
107 "lastModifiedBy": "string",
108 "createdDate": "2019-08-24T14:15:22Z",
109 "lastModifiedDate": "2019-08-24T14:15:22Z",
110 "archived": true,
111 "externalId": "string",
112 "id": 0,
113 "priority": 0,
114 "internalId": 0,
115 "pickListCode": "string",
116 "pickListLabel": "string",
117 "label": "string",
118 "cultureId": 0,
119 "labelDtos": [
120 {
121 "createdBy": "string",
122 "lastModifiedBy": "string",
123 "createdDate": "2019-08-24T14:15:22Z",
124 "lastModifiedDate": "2019-08-24T14:15:22Z",
125 "archived": true,
126 "externalId": "string",
127 "id": 0,
128 "cultureId": 0,
129 "value": "string"
130 }
131 ]
132 },
133 "historiesDto": [
134 {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "startDate": "2019-08-24",
143 "endDate": "2019-08-24",
144 "measure": 0,
145 "details": "string",
146 "floor": "string",
147 "suite": "string",
148 "areaId": 0,
149 "versionId": 0
150 }
151 ],
152 "archivedAssociation": true
153}
Area - Update Area¶
HTTP Request
PUT /api/areas/{id}
📋 Description: Updates the details of a specific area within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated details of the specified area, including portfolio attributes and analytics relevant to real estate property management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "typeId": 0,
10 "unitId": 0,
11 "sourceId": 0,
12 "proShareTypeId": 0,
13 "documentId": 0,
14 "grossUp": 0,
15 "lot": "string",
16 "cadaster": "string",
17 "name": "string",
18 "verified": true,
19 "toBeMeasured": true,
20 "gla": true,
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "source": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 },
77 "proShareType": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitType": {
106 "createdBy": "string",
107 "lastModifiedBy": "string",
108 "createdDate": "2019-08-24T14:15:22Z",
109 "lastModifiedDate": "2019-08-24T14:15:22Z",
110 "archived": true,
111 "externalId": "string",
112 "id": 0,
113 "priority": 0,
114 "internalId": 0,
115 "pickListCode": "string",
116 "pickListLabel": "string",
117 "label": "string",
118 "cultureId": 0,
119 "labelDtos": [
120 {
121 "createdBy": "string",
122 "lastModifiedBy": "string",
123 "createdDate": "2019-08-24T14:15:22Z",
124 "lastModifiedDate": "2019-08-24T14:15:22Z",
125 "archived": true,
126 "externalId": "string",
127 "id": 0,
128 "cultureId": 0,
129 "value": "string"
130 }
131 ]
132 },
133 "historiesDto": [
134 {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "startDate": "2019-08-24",
143 "endDate": "2019-08-24",
144 "measure": 0,
145 "details": "string",
146 "floor": "string",
147 "suite": "string",
148 "areaId": 0,
149 "versionId": 0
150 }
151 ],
152 "archivedAssociation": true
153}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "typeId": 0,
10 "unitId": 0,
11 "sourceId": 0,
12 "proShareTypeId": 0,
13 "documentId": 0,
14 "grossUp": 0,
15 "lot": "string",
16 "cadaster": "string",
17 "name": "string",
18 "verified": true,
19 "toBeMeasured": true,
20 "gla": true,
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "source": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 },
77 "proShareType": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitType": {
106 "createdBy": "string",
107 "lastModifiedBy": "string",
108 "createdDate": "2019-08-24T14:15:22Z",
109 "lastModifiedDate": "2019-08-24T14:15:22Z",
110 "archived": true,
111 "externalId": "string",
112 "id": 0,
113 "priority": 0,
114 "internalId": 0,
115 "pickListCode": "string",
116 "pickListLabel": "string",
117 "label": "string",
118 "cultureId": 0,
119 "labelDtos": [
120 {
121 "createdBy": "string",
122 "lastModifiedBy": "string",
123 "createdDate": "2019-08-24T14:15:22Z",
124 "lastModifiedDate": "2019-08-24T14:15:22Z",
125 "archived": true,
126 "externalId": "string",
127 "id": 0,
128 "cultureId": 0,
129 "value": "string"
130 }
131 ]
132 },
133 "historiesDto": [
134 {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "startDate": "2019-08-24",
143 "endDate": "2019-08-24",
144 "measure": 0,
145 "details": "string",
146 "floor": "string",
147 "suite": "string",
148 "areaId": 0,
149 "versionId": 0
150 }
151 ],
152 "archivedAssociation": true
153}
Area - Delete Area¶
HTTP Request
DELETE /api/areas/{id}
📋 Description: Deletes a specified area from the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Area - Update History¶
HTTP Request
PUT /api/areas/{areaId}/histories/{id}
📋 Description: Updates the specified history record for a given area within the Nakisa Portfolio Management Suite, enabling users to maintain accurate and up-to-date analytics related to portfolio and asset management in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
areaId |
path |
integer(int64) |
true |
Unique identifier for the area |
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the historical data for a specified area, including relevant asset analytics and portfolio insights. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "measure": 0,
12 "details": "string",
13 "floor": "string",
14 "suite": "string",
15 "areaId": 0,
16 "versionId": 0
17}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "measure": 0,
12 "details": "string",
13 "floor": "string",
14 "suite": "string",
15 "areaId": 0,
16 "versionId": 0
17}
Area - Get Areas¶
HTTP Request
GET /api/areas
📋 Description: Retrieves a list of areas within the Nakisa Portfolio Management Suite, providing insights into portfolio and asset distribution relevant to real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the asset areas query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and real estate analytics. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific portfolio, asset, or real estate property data within the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Unique identifier for the type of area being queried, essential for retrieving specific portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite. |
unit-id |
query |
string |
false |
Unique identifier for a specific unit within the Nakisa Portfolio Management Suite, used to retrieve detailed information about portfolio assets and analytics related to real estate properties. |
source-id |
query |
string |
false |
Unique identifier for the source of the portfolio or asset data being queried in the Nakisa Portfolio Management Suite. |
pro-share-type-id |
query |
string |
false |
Unique identifier for the type of professional share associated with portfolio assets in the Nakisa Portfolio Management Suite. |
document-id |
query |
string |
false |
Unique identifier for the specific document within the Nakisa Portfolio Management Suite, facilitating access to detailed portfolio and asset analytics related to real estate properties. |
gross-up |
query |
string |
false |
Specifies the gross-up amount for financial calculations related to portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
lot |
query |
string |
false |
Identifier for the specific lot within the portfolio, used to retrieve detailed analytics and information related to real estate properties. |
cadaster |
query |
string |
false |
String representing the cadaster identifier, used to retrieve specific real estate property data within the Nakisa Portfolio Management Suite. |
verified |
query |
string |
false |
Indicates whether the portfolio asset has been verified, facilitating accurate analytics and reporting within the Nakisa Portfolio Management Suite. |
to-be-measured |
query |
string |
false |
Specifies the asset or portfolio element to be measured for analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "areas": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "typeId": 0,
13 "unitId": 0,
14 "sourceId": 0,
15 "proShareTypeId": 0,
16 "documentId": 0,
17 "grossUp": 0,
18 "lot": "string",
19 "cadaster": "string",
20 "name": "string",
21 "verified": true,
22 "toBeMeasured": true,
23 "gla": true,
24 "type": {
25 "createdBy": "string",
26 "lastModifiedBy": "string",
27 "createdDate": "2019-08-24T14:15:22Z",
28 "lastModifiedDate": "2019-08-24T14:15:22Z",
29 "archived": true,
30 "externalId": "string",
31 "id": 0,
32 "priority": 0,
33 "internalId": 0,
34 "pickListCode": "string",
35 "pickListLabel": "string",
36 "label": "string",
37 "cultureId": 0,
38 "labelDtos": [
39 {
40 "createdBy": "string",
41 "lastModifiedBy": "string",
42 "createdDate": "2019-08-24T14:15:22Z",
43 "lastModifiedDate": "2019-08-24T14:15:22Z",
44 "archived": true,
45 "externalId": "string",
46 "id": 0,
47 "cultureId": 0,
48 "value": "string"
49 }
50 ]
51 },
52 "source": {
53 "createdBy": "string",
54 "lastModifiedBy": "string",
55 "createdDate": "2019-08-24T14:15:22Z",
56 "lastModifiedDate": "2019-08-24T14:15:22Z",
57 "archived": true,
58 "externalId": "string",
59 "id": 0,
60 "priority": 0,
61 "internalId": 0,
62 "pickListCode": "string",
63 "pickListLabel": "string",
64 "label": "string",
65 "cultureId": 0,
66 "labelDtos": [
67 {
68 "createdBy": "string",
69 "lastModifiedBy": "string",
70 "createdDate": "2019-08-24T14:15:22Z",
71 "lastModifiedDate": "2019-08-24T14:15:22Z",
72 "archived": true,
73 "externalId": "string",
74 "id": 0,
75 "cultureId": 0,
76 "value": "string"
77 }
78 ]
79 },
80 "proShareType": {
81 "createdBy": "string",
82 "lastModifiedBy": "string",
83 "createdDate": "2019-08-24T14:15:22Z",
84 "lastModifiedDate": "2019-08-24T14:15:22Z",
85 "archived": true,
86 "externalId": "string",
87 "id": 0,
88 "priority": 0,
89 "internalId": 0,
90 "pickListCode": "string",
91 "pickListLabel": "string",
92 "label": "string",
93 "cultureId": 0,
94 "labelDtos": [
95 {
96 "createdBy": "string",
97 "lastModifiedBy": "string",
98 "createdDate": "2019-08-24T14:15:22Z",
99 "lastModifiedDate": "2019-08-24T14:15:22Z",
100 "archived": true,
101 "externalId": "string",
102 "id": 0,
103 "cultureId": 0,
104 "value": "string"
105 }
106 ]
107 },
108 "unitType": {
109 "createdBy": "string",
110 "lastModifiedBy": "string",
111 "createdDate": "2019-08-24T14:15:22Z",
112 "lastModifiedDate": "2019-08-24T14:15:22Z",
113 "archived": true,
114 "externalId": "string",
115 "id": 0,
116 "priority": 0,
117 "internalId": 0,
118 "pickListCode": "string",
119 "pickListLabel": "string",
120 "label": "string",
121 "cultureId": 0,
122 "labelDtos": [
123 {
124 "createdBy": "string",
125 "lastModifiedBy": "string",
126 "createdDate": "2019-08-24T14:15:22Z",
127 "lastModifiedDate": "2019-08-24T14:15:22Z",
128 "archived": true,
129 "externalId": "string",
130 "id": 0,
131 "cultureId": 0,
132 "value": "string"
133 }
134 ]
135 },
136 "historiesDto": [
137 {
138 "createdBy": "string",
139 "lastModifiedBy": "string",
140 "createdDate": "2019-08-24T14:15:22Z",
141 "lastModifiedDate": "2019-08-24T14:15:22Z",
142 "archived": true,
143 "externalId": "string",
144 "id": 0,
145 "startDate": "2019-08-24",
146 "endDate": "2019-08-24",
147 "measure": 0,
148 "details": "string",
149 "floor": "string",
150 "suite": "string",
151 "areaId": 0,
152 "versionId": 0
153 }
154 ],
155 "archivedAssociation": true
156 }
157 ]
158 },
159 "page": {
160 "size": 0,
161 "totalElements": 0,
162 "totalPages": 0,
163 "number": 0
164 }
165}
Area - Add Areas¶
HTTP Request
POST /api/areas
📋 Description: Creates a new area within the Nakisa Portfolio Management Suite, enabling users to categorize and manage real estate properties effectively for enhanced portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the area details, including portfolio identifiers and asset attributes, essential for analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "typeId": 0,
11 "unitId": 0,
12 "sourceId": 0,
13 "proShareTypeId": 0,
14 "documentId": 0,
15 "grossUp": 0,
16 "lot": "string",
17 "cadaster": "string",
18 "name": "string",
19 "verified": true,
20 "toBeMeasured": true,
21 "gla": true,
22 "type": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "source": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 },
78 "proShareType": {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "priority": 0,
87 "internalId": 0,
88 "pickListCode": "string",
89 "pickListLabel": "string",
90 "label": "string",
91 "cultureId": 0,
92 "labelDtos": [
93 {
94 "createdBy": "string",
95 "lastModifiedBy": "string",
96 "createdDate": "2019-08-24T14:15:22Z",
97 "lastModifiedDate": "2019-08-24T14:15:22Z",
98 "archived": true,
99 "externalId": "string",
100 "id": 0,
101 "cultureId": 0,
102 "value": "string"
103 }
104 ]
105 },
106 "unitType": {
107 "createdBy": "string",
108 "lastModifiedBy": "string",
109 "createdDate": "2019-08-24T14:15:22Z",
110 "lastModifiedDate": "2019-08-24T14:15:22Z",
111 "archived": true,
112 "externalId": "string",
113 "id": 0,
114 "priority": 0,
115 "internalId": 0,
116 "pickListCode": "string",
117 "pickListLabel": "string",
118 "label": "string",
119 "cultureId": 0,
120 "labelDtos": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "cultureId": 0,
130 "value": "string"
131 }
132 ]
133 },
134 "historiesDto": [
135 {
136 "createdBy": "string",
137 "lastModifiedBy": "string",
138 "createdDate": "2019-08-24T14:15:22Z",
139 "lastModifiedDate": "2019-08-24T14:15:22Z",
140 "archived": true,
141 "externalId": "string",
142 "id": 0,
143 "startDate": "2019-08-24",
144 "endDate": "2019-08-24",
145 "measure": 0,
146 "details": "string",
147 "floor": "string",
148 "suite": "string",
149 "areaId": 0,
150 "versionId": 0
151 }
152 ],
153 "archivedAssociation": true
154 }
155]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "typeId": 0,
11 "unitId": 0,
12 "sourceId": 0,
13 "proShareTypeId": 0,
14 "documentId": 0,
15 "grossUp": 0,
16 "lot": "string",
17 "cadaster": "string",
18 "name": "string",
19 "verified": true,
20 "toBeMeasured": true,
21 "gla": true,
22 "type": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "priority": 0,
31 "internalId": 0,
32 "pickListCode": "string",
33 "pickListLabel": "string",
34 "label": "string",
35 "cultureId": 0,
36 "labelDtos": [
37 {
38 "createdBy": "string",
39 "lastModifiedBy": "string",
40 "createdDate": "2019-08-24T14:15:22Z",
41 "lastModifiedDate": "2019-08-24T14:15:22Z",
42 "archived": true,
43 "externalId": "string",
44 "id": 0,
45 "cultureId": 0,
46 "value": "string"
47 }
48 ]
49 },
50 "source": {
51 "createdBy": "string",
52 "lastModifiedBy": "string",
53 "createdDate": "2019-08-24T14:15:22Z",
54 "lastModifiedDate": "2019-08-24T14:15:22Z",
55 "archived": true,
56 "externalId": "string",
57 "id": 0,
58 "priority": 0,
59 "internalId": 0,
60 "pickListCode": "string",
61 "pickListLabel": "string",
62 "label": "string",
63 "cultureId": 0,
64 "labelDtos": [
65 {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "cultureId": 0,
74 "value": "string"
75 }
76 ]
77 },
78 "proShareType": {
79 "createdBy": "string",
80 "lastModifiedBy": "string",
81 "createdDate": "2019-08-24T14:15:22Z",
82 "lastModifiedDate": "2019-08-24T14:15:22Z",
83 "archived": true,
84 "externalId": "string",
85 "id": 0,
86 "priority": 0,
87 "internalId": 0,
88 "pickListCode": "string",
89 "pickListLabel": "string",
90 "label": "string",
91 "cultureId": 0,
92 "labelDtos": [
93 {
94 "createdBy": "string",
95 "lastModifiedBy": "string",
96 "createdDate": "2019-08-24T14:15:22Z",
97 "lastModifiedDate": "2019-08-24T14:15:22Z",
98 "archived": true,
99 "externalId": "string",
100 "id": 0,
101 "cultureId": 0,
102 "value": "string"
103 }
104 ]
105 },
106 "unitType": {
107 "createdBy": "string",
108 "lastModifiedBy": "string",
109 "createdDate": "2019-08-24T14:15:22Z",
110 "lastModifiedDate": "2019-08-24T14:15:22Z",
111 "archived": true,
112 "externalId": "string",
113 "id": 0,
114 "priority": 0,
115 "internalId": 0,
116 "pickListCode": "string",
117 "pickListLabel": "string",
118 "label": "string",
119 "cultureId": 0,
120 "labelDtos": [
121 {
122 "createdBy": "string",
123 "lastModifiedBy": "string",
124 "createdDate": "2019-08-24T14:15:22Z",
125 "lastModifiedDate": "2019-08-24T14:15:22Z",
126 "archived": true,
127 "externalId": "string",
128 "id": 0,
129 "cultureId": 0,
130 "value": "string"
131 }
132 ]
133 },
134 "historiesDto": [
135 {
136 "createdBy": "string",
137 "lastModifiedBy": "string",
138 "createdDate": "2019-08-24T14:15:22Z",
139 "lastModifiedDate": "2019-08-24T14:15:22Z",
140 "archived": true,
141 "externalId": "string",
142 "id": 0,
143 "startDate": "2019-08-24",
144 "endDate": "2019-08-24",
145 "measure": 0,
146 "details": "string",
147 "floor": "string",
148 "suite": "string",
149 "areaId": 0,
150 "versionId": 0
151 }
152 ],
153 "archivedAssociation": true
154 }
155]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a geographical area within the Nakisa Portfolio Management Suite, encompassing relevant attributes for portfolio analysis, asset management, and real estate property analytics.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» typeId |
integer(int64) |
true |
none |
Unique identifier for the type |
» unitId |
integer(int64) |
false |
none |
Unique identifier for the unit |
» sourceId |
integer(int64) |
false |
none |
Unique identifier for the source |
» proShareTypeId |
integer(int64) |
false |
none |
Unique identifier for the pro share type |
» documentId |
integer(int64) |
false |
none |
Unique identifier for the document |
» grossUp |
integer(int64) |
false |
none |
Numeric value representing grossUp |
» lot |
string |
false |
none |
Represents the specific lot associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
» cadaster |
string |
false |
none |
Represents the cadastral information associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
» name |
string |
false |
none |
Name of the resource |
» verified |
boolean |
false |
none |
Boolean flag indicating verified status |
» toBeMeasured |
boolean |
false |
none |
Boolean flag indicating toBeMeasured status |
» gla |
boolean |
false |
none |
Boolean flag indicating gla status |
» type |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
none |
List of labelDtos items |
|
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»»» externalId |
string |
false |
none |
Unique identifier for the external |
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»»» value |
string |
true |
none |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
» source |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» proShareType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» unitType |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» historiesDto |
false |
none |
List of historiesDto items |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» endDate |
string(date) |
false |
none |
End date of the resource |
»» measure |
number |
false |
none |
Value for measure field |
»» details |
string |
false |
none |
Provides a detailed description of the historical context and analytics related to a specific portfolio or asset within the Nakisa Portfolio Management Suite. |
»» floor |
string |
false |
none |
Represents the specific floor designation within a real estate property, facilitating detailed portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
»» suite |
string |
false |
none |
Represents the name of the suite within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of portfolios, assets, and real estate properties. |
»» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
»» versionId |
integer(int64) |
false |
none |
none |
» archivedAssociation |
boolean |
false |
none |
Indicates whether the association has been archived, providing insight into the historical context of portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
Area - Add Area Notes¶
HTTP Request
POST /api/areas/{id}/notes
📋 Description: Creates a new note associated with a specific area within the Nakisa Portfolio Management Suite, enhancing asset management and analytics capabilities for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the note details, including content and metadata, associated with a specific area within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» message |
string |
true |
none |
Textual content providing detailed information or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
URL to which users will be redirected after completing a specific action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio, asset, and real estate property management. |
Area - Add Area Histories¶
HTTP Request
POST /api/areas/{id}/histories
📋 Description: Creates a new history entry for a specified area within the Nakisa Portfolio Management Suite, enabling enhanced tracking and analytics of portfolio and asset performance in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing historical data entries related to the specified area, including asset performance metrics and analytics relevant to portfolio management in real estate. |
Body Parameters
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "measure": 0,
13 "details": "string",
14 "floor": "string",
15 "suite": "string",
16 "areaId": 0,
17 "versionId": 0
18 }
19]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdBy": "string",
4 "lastModifiedBy": "string",
5 "createdDate": "2019-08-24T14:15:22Z",
6 "lastModifiedDate": "2019-08-24T14:15:22Z",
7 "archived": true,
8 "externalId": "string",
9 "id": 0,
10 "startDate": "2019-08-24",
11 "endDate": "2019-08-24",
12 "measure": 0,
13 "details": "string",
14 "floor": "string",
15 "suite": "string",
16 "areaId": 0,
17 "versionId": 0
18 }
19]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the historical data of an area within the Nakisa Portfolio Management Suite, encompassing insights related to portfolio performance, asset utilization, and analytics for real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» measure |
number |
false |
none |
Value for measure field |
» details |
string |
false |
none |
Provides a detailed description of the historical context and analytics related to a specific portfolio or asset within the Nakisa Portfolio Management Suite. |
» floor |
string |
false |
none |
Represents the specific floor designation within a real estate property, facilitating detailed portfolio and asset analytics in the Nakisa Portfolio Management Suite. |
» suite |
string |
false |
none |
Represents the name of the suite within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of portfolios, assets, and real estate properties. |
» areaId |
integer(int64) |
false |
none |
Unique identifier for the area |
» versionId |
integer(int64) |
false |
none |
none |
Area - Archive Area¶
HTTP Request
POST /api/areas/{id}/archive
📋 Description: Archives a specified area within the Nakisa Portfolio Management Suite, facilitating the management of real estate properties and enhancing portfolio analytics by removing inactive assets from active listings.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "typeId": 0,
10 "unitId": 0,
11 "sourceId": 0,
12 "proShareTypeId": 0,
13 "documentId": 0,
14 "grossUp": 0,
15 "lot": "string",
16 "cadaster": "string",
17 "name": "string",
18 "verified": true,
19 "toBeMeasured": true,
20 "gla": true,
21 "type": {
22 "createdBy": "string",
23 "lastModifiedBy": "string",
24 "createdDate": "2019-08-24T14:15:22Z",
25 "lastModifiedDate": "2019-08-24T14:15:22Z",
26 "archived": true,
27 "externalId": "string",
28 "id": 0,
29 "priority": 0,
30 "internalId": 0,
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "label": "string",
34 "cultureId": 0,
35 "labelDtos": [
36 {
37 "createdBy": "string",
38 "lastModifiedBy": "string",
39 "createdDate": "2019-08-24T14:15:22Z",
40 "lastModifiedDate": "2019-08-24T14:15:22Z",
41 "archived": true,
42 "externalId": "string",
43 "id": 0,
44 "cultureId": 0,
45 "value": "string"
46 }
47 ]
48 },
49 "source": {
50 "createdBy": "string",
51 "lastModifiedBy": "string",
52 "createdDate": "2019-08-24T14:15:22Z",
53 "lastModifiedDate": "2019-08-24T14:15:22Z",
54 "archived": true,
55 "externalId": "string",
56 "id": 0,
57 "priority": 0,
58 "internalId": 0,
59 "pickListCode": "string",
60 "pickListLabel": "string",
61 "label": "string",
62 "cultureId": 0,
63 "labelDtos": [
64 {
65 "createdBy": "string",
66 "lastModifiedBy": "string",
67 "createdDate": "2019-08-24T14:15:22Z",
68 "lastModifiedDate": "2019-08-24T14:15:22Z",
69 "archived": true,
70 "externalId": "string",
71 "id": 0,
72 "cultureId": 0,
73 "value": "string"
74 }
75 ]
76 },
77 "proShareType": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "priority": 0,
86 "internalId": 0,
87 "pickListCode": "string",
88 "pickListLabel": "string",
89 "label": "string",
90 "cultureId": 0,
91 "labelDtos": [
92 {
93 "createdBy": "string",
94 "lastModifiedBy": "string",
95 "createdDate": "2019-08-24T14:15:22Z",
96 "lastModifiedDate": "2019-08-24T14:15:22Z",
97 "archived": true,
98 "externalId": "string",
99 "id": 0,
100 "cultureId": 0,
101 "value": "string"
102 }
103 ]
104 },
105 "unitType": {
106 "createdBy": "string",
107 "lastModifiedBy": "string",
108 "createdDate": "2019-08-24T14:15:22Z",
109 "lastModifiedDate": "2019-08-24T14:15:22Z",
110 "archived": true,
111 "externalId": "string",
112 "id": 0,
113 "priority": 0,
114 "internalId": 0,
115 "pickListCode": "string",
116 "pickListLabel": "string",
117 "label": "string",
118 "cultureId": 0,
119 "labelDtos": [
120 {
121 "createdBy": "string",
122 "lastModifiedBy": "string",
123 "createdDate": "2019-08-24T14:15:22Z",
124 "lastModifiedDate": "2019-08-24T14:15:22Z",
125 "archived": true,
126 "externalId": "string",
127 "id": 0,
128 "cultureId": 0,
129 "value": "string"
130 }
131 ]
132 },
133 "historiesDto": [
134 {
135 "createdBy": "string",
136 "lastModifiedBy": "string",
137 "createdDate": "2019-08-24T14:15:22Z",
138 "lastModifiedDate": "2019-08-24T14:15:22Z",
139 "archived": true,
140 "externalId": "string",
141 "id": 0,
142 "startDate": "2019-08-24",
143 "endDate": "2019-08-24",
144 "measure": 0,
145 "details": "string",
146 "floor": "string",
147 "suite": "string",
148 "areaId": 0,
149 "versionId": 0
150 }
151 ],
152 "archivedAssociation": true
153}
Area - Archive History¶
HTTP Request
POST /api/areas/{areaId}/histories/{id}/archive
📋 Description: Archives a specified history record for a given area within the Nakisa Portfolio Management Suite, enabling enhanced asset management and analytics for real estate properties. This operation helps maintain an organized portfolio by preserving historical data while streamlining access to current information.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
areaId |
path |
integer(int64) |
true |
Unique identifier for the area |
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "measure": 0,
12 "details": "string",
13 "floor": "string",
14 "suite": "string",
15 "areaId": 0,
16 "versionId": 0
17}
Area - Get Area Type Footage By Area ID And Date¶
HTTP Request
GET /api/areas/{id}/area-type-footage
📋 Description: Retrieves the area type footage for a specified area within the Nakisa Portfolio Management Suite, providing essential data for portfolio and asset analytics in real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
date |
query |
string(date) |
true |
Date of the resource |
version-id |
query |
integer(int64) |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "typeValue": "string",
3 "measure": 0,
4 "unit": "string",
5 "startDate": "2019-08-24",
6 "endDate": "2019-08-24"
7}
Area - Get Area Notes¶
HTTP Request
GET /api/areas/{areaId}/notes
📋 Description: Retrieves notes associated with a specific area within the Nakisa Portfolio Management Suite, enabling users to access critical insights related to portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
areaId |
path |
integer(int64) |
true |
Unique identifier for the area |
pageable |
query |
true |
Indicates whether the results for notes associated with a specific area should be returned in a paginated format, facilitating efficient data retrieval in portfolio and asset management contexts. |
|
search |
query |
string |
false |
Search term used to filter notes related to a specific area within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
message |
query |
string |
false |
Textual content of the note associated with a specific area, providing insights relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}
Area - Get Area Histories¶
HTTP Request
GET /api/areas/{areaId}/histories
📋 Description: Retrieves historical data for a specified area within the Nakisa Portfolio Management Suite, providing insights into portfolio and asset performance relevant to real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the asset history retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
areaId |
path |
string |
true |
Unique identifier for the area |
search |
query |
string |
false |
Search term used to filter historical records related to the specified area within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
version-id |
query |
string |
false |
none |
start-date |
query |
string |
false |
Specifies the starting date for retrieving historical data related to portfolio and asset analytics within a designated area in the Nakisa Portfolio Management Suite. |
end-date |
query |
string |
false |
Specifies the end date for retrieving historical data related to portfolio assets and analytics within the specified area. |
measure |
query |
string |
false |
Specifies the measurement type to retrieve historical data related to portfolio analytics for the specified area within the Nakisa Portfolio Management Suite. |
details |
query |
string |
false |
Provides additional context or specifications related to the historical data of a specific area within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics. |
floor |
query |
string |
false |
Specifies the floor level of the real estate property within the portfolio, enabling targeted analytics and historical data retrieval. |
suite |
query |
string |
false |
Specifies the name of the suite within the Nakisa Portfolio Management Suite to filter historical data related to portfolio, asset, analytics, and real estate property for the specified area. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "areaHistories": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "measure": 0,
15 "details": "string",
16 "floor": "string",
17 "suite": "string",
18 "areaId": 0,
19 "versionId": 0
20 }
21 ]
22 },
23 "page": {
24 "size": 0,
25 "totalElements": 0,
26 "totalPages": 0,
27 "number": 0
28 }
29}
Area - Get Area History¶
HTTP Request
GET /api/areas-histories/{areaHistoryId}
📋 Description: Retrieves detailed historical data for a specific area within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset trends in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
areaHistoryId |
path |
integer(int64) |
true |
Unique identifier for the area history |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "startDate": "2019-08-24",
10 "endDate": "2019-08-24",
11 "measure": 0,
12 "details": "string",
13 "floor": "string",
14 "suite": "string",
15 "areaId": 0,
16 "versionId": 0
17}