Business Unit

Get Business Unit

HTTP Request

GET /api/business-units/{id}

📋 Description: Retrieves detailed information about a specific business unit 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

OK

BusinessUnitDto

Example Responses

1{
2  "id": 0,
3  "status": "CREATED",
4  "displayId": "string",
5  "name": "string",
6  "leaseAreaId": 0,
7  "companyId": 0
8}

Update Business Unit

HTTP Request

PUT /api/business-units/{id}

📋 Description: Updates the details of a specified business unit within the Nakisa Portfolio Management Suite, enabling users to manage portfolio, asset, and real estate property information effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

BusinessUnitDto

true

Request body containing the updated details of the specified business unit, including portfolio allocation, asset management information, and relevant analytics for real estate properties.

Body Parameters

1{
2  "id": 0,
3  "status": "CREATED",
4  "displayId": "string",
5  "name": "string",
6  "leaseAreaId": 0,
7  "companyId": 0
8}

Responses

Status

Meaning

Description

Schema

200

OK

OK

BusinessUnitDto

Example Responses

1{
2  "id": 0,
3  "status": "CREATED",
4  "displayId": "string",
5  "name": "string",
6  "leaseAreaId": 0,
7  "companyId": 0
8}

Delete Business Unit

HTTP Request

DELETE /api/business-units/{id}

📋 Description: Deletes a specified business unit from the Nakisa Portfolio Management Suite, ensuring the integrity of portfolio and asset analytics related to real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Get Business Units

HTTP Request

GET /api/business-units

📋 Description: Retrieves a list of business units within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolios, assets, and real estate properties effectively.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageBusinessUnitDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "numberOfElements": 0,
 5  "pageable": {
 6    "unpaged": true,
 7    "paged": true,
 8    "pageNumber": 0,
 9    "pageSize": 0,
10    "offset": 0,
11    "sort": {
12      "unsorted": true,
13      "sorted": true,
14      "empty": true
15    }
16  },
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "name": "string",
24      "leaseAreaId": 0,
25      "companyId": 0
26    }
27  ],
28  "number": 0,
29  "sort": {
30    "unsorted": true,
31    "sorted": true,
32    "empty": true
33  },
34  "first": true,
35  "last": true,
36  "empty": true
37}

Create Business Units

HTTP Request

POST /api/business-units

📋 Description: Creates a new business unit within the Nakisa Portfolio Management Suite, enabling users to effectively manage portfolios, assets, and analytics related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

BusinessUnitDto

true

Request body containing the details of the new business unit, including its name, portfolio associations, and relevant asset analytics for effective real estate property management.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "name": "string",
 7    "leaseAreaId": 0,
 8    "companyId": 0
 9  }
10]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "name": "string",
 7    "leaseAreaId": 0,
 8    "companyId": 0
 9  }
10]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[BusinessUnitDto]

false

none

[Data transfer object representing a business unit within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio management, asset tracking, analytics, and real estate properties.]

» 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

» leaseAreaId

integer(int64)

false

none

Unique identifier for the lease area

» companyId

integer(int64)

false

none

Unique identifier for the company

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Search Business Units

HTTP Request

POST /api/business-units/search

📋 Description: Submits a search query to identify specific business units within the Nakisa Portfolio Management Suite, leveraging portfolio, asset, analytics, and real estate property data for enhanced decision-making.

Parameters

Name

In

Type

Required

Description

body

body

BusinessUnitDtoFilter

true

Request body containing search criteria and filters for identifying specific business units within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "uiSelector": "string",
24  "nameLike": "string",
25  "leaseAreaIdEqual": 0,
26  "leaseAreaIdIn": [
27    0
28  ],
29  "companyIdEqual": 0
30}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageBusinessUnitDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "numberOfElements": 0,
 5  "pageable": {
 6    "unpaged": true,
 7    "paged": true,
 8    "pageNumber": 0,
 9    "pageSize": 0,
10    "offset": 0,
11    "sort": {
12      "unsorted": true,
13      "sorted": true,
14      "empty": true
15    }
16  },
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "name": "string",
24      "leaseAreaId": 0,
25      "companyId": 0
26    }
27  ],
28  "number": 0,
29  "sort": {
30    "unsorted": true,
31    "sorted": true,
32    "empty": true
33  },
34  "first": true,
35  "last": true,
36  "empty": true
37}