Unit Of Measure

Get Unit Of Measure

HTTP Request

GET /api/unit-of-measures/{id}

📋 Description: Retrieves the details of a specific unit of measure identified by the provided ID, facilitating accurate asset and portfolio analytics 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

OK

UnitOfMeasureDto

Example Responses

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

Update Unit Of Measure

HTTP Request

PUT /api/unit-of-measures/{id}

📋 Description: Updates the specified unit of measure within the Nakisa Portfolio Management Suite, enabling accurate asset and portfolio analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

UnitOfMeasureDto

true

Request body containing the updated unit of measure data, including attributes relevant to portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

UnitOfMeasureDto

Example Responses

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

Delete Unit Of Measure

HTTP Request

DELETE /api/unit-of-measures/{id}

📋 Description: Deletes a specified unit of measure from the Nakisa Portfolio Management Suite, ensuring accurate asset and portfolio analytics within the real estate property domain.

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 Unit Of Measures

HTTP Request

GET /api/unit-of-measures

📋 Description: Retrieves a list of unit of measures used within the Nakisa Portfolio Management Suite, facilitating accurate analytics and reporting for portfolio and asset management in real estate properties.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageUnitOfMeasureDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": 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      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string"
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 Unit Of Measures

HTTP Request

POST /api/unit-of-measures

📋 Description: Creates a new unit of measure within the Nakisa Portfolio Management Suite, enabling precise asset and portfolio analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

UnitOfMeasureDto

true

Request body containing the unit of measure data, including attributes relevant to portfolio analytics and real estate property management.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string"
 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    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string"
 9  }
10]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[UnitOfMeasureDto]

false

none

[Data transfer object representing the unit of measure utilized within the Nakisa Portfolio Management Suite, essential for accurately quantifying and analyzing assets in the context of portfolio management and real estate property analytics.]

» 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

» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» name

string

false

none

Name of the resource

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Search Unit Of Measures

HTTP Request

POST /api/unit-of-measures/search

📋 Description: Submits a request to search for unit of measures relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite, enabling users to efficiently manage real estate property data.

Parameters

Name

In

Type

Required

Description

body

body

UnitOfMeasureDtoFilter

true

Request body containing search criteria for unit of measures relevant to portfolio 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  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "uiSelector": "string",
29  "nameLike": "string"
30}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageUnitOfMeasureDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": 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      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string"
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}