Lease Area¶
Lease Area - Get Lease Area¶
HTTP Request
GET /api/lease-areas/{id}
📋 Description: Retrieves detailed information about a specific lease area identified by its unique ID, facilitating portfolio analysis and asset management within the Nakisa Portfolio Management Suite.
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 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "businessUnitId": 0
7}
Lease Area - Update Lease Area¶
HTTP Request
PUT /api/lease-areas/{id}
📋 Description: Updates the details of a specified lease area within the Nakisa Portfolio Management Suite, enabling users to manage real estate assets effectively and enhance portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated lease area details, including asset identifiers and analytical metrics, to enhance portfolio management within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "businessUnitId": 0
7}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "status": "CREATED",
4 "displayId": "string",
5 "name": "string",
6 "businessUnitId": 0
7}
Lease Area - Delete Lease Area¶
HTTP Request
DELETE /api/lease-areas/{id}
📋 Description: Deletes a specified lease area from the Nakisa Portfolio Management Suite, facilitating the management of real estate assets within your portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Lease Area - Get Lease Areas¶
HTTP Request
GET /api/lease-areas
📋 Description: Retrieves a list of lease areas within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate properties effectively.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "status": "CREATED",
22 "displayId": "string",
23 "name": "string",
24 "businessUnitId": 0
25 }
26 ],
27 "number": 0,
28 "sort": {
29 "sorted": true,
30 "unsorted": true,
31 "empty": true
32 },
33 "first": true,
34 "last": true,
35 "empty": true
36}
Lease Area - Create Lease Areas¶
HTTP Request
POST /api/lease-areas
📋 Description: Creates a new lease area within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze real estate properties within their portfolio.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the lease area details, including asset identifiers and portfolio analytics relevant to real estate property management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "businessUnitId": 0
8 }
9]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "status": "CREATED",
5 "displayId": "string",
6 "name": "string",
7 "businessUnitId": 0
8 }
9]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a defined lease area within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio analysis and asset management in the real estate sector.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» status |
string |
false |
none |
Status of the resource |
» displayId |
string |
true |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» businessUnitId |
integer(int64) |
false |
none |
Unique identifier for the business unit |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |