Lease Template

Lease Template - Update Lease Template

HTTP Request

PUT /api/lease-template/{id}

📋 Description: Updates the specified lease template within the Nakisa Portfolio Management Suite, enabling users to modify lease terms and conditions related to portfolio and asset management for enhanced real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LeaseTemplateDto

true

Request body containing the lease template data, including terms, conditions, and associated metadata for effective portfolio and asset management in real estate.

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  "label": "string",
10  "cultureId": 0,
11  "leaseId": 0,
12  "labelDtos": [
13    {
14      "createdBy": "string",
15      "lastModifiedBy": "string",
16      "createdDate": "2019-08-24T14:15:22Z",
17      "lastModifiedDate": "2019-08-24T14:15:22Z",
18      "archived": true,
19      "externalId": "string",
20      "id": 0,
21      "cultureId": 0,
22      "value": "string"
23    }
24  ]
25}

Responses

Status

Meaning

Description

Schema

200

OK

OK

LeaseTemplateDto

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  "label": "string",
10  "cultureId": 0,
11  "leaseId": 0,
12  "labelDtos": [
13    {
14      "createdBy": "string",
15      "lastModifiedBy": "string",
16      "createdDate": "2019-08-24T14:15:22Z",
17      "lastModifiedDate": "2019-08-24T14:15:22Z",
18      "archived": true,
19      "externalId": "string",
20      "id": 0,
21      "cultureId": 0,
22      "value": "string"
23    }
24  ]
25}

Lease Template - Delete Lease Template

HTTP Request

DELETE /api/lease-template/{id}

📋 Description: Deletes a specified lease template from the Nakisa Portfolio Management Suite, facilitating the management of portfolio and asset data within 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

204

No Content

No Content

None

Lease Template - Get Lease Template

HTTP Request

GET /api/lease-templates

📋 Description: Fetches a list of lease templates utilized within the Nakisa Portfolio Management Suite, enabling users to efficiently manage and analyze real estate property assets within their portfolio.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the lease templates retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite for portfolio and asset analytics.

lease-id

query

string

false

Unique identifier for the lease template within the Nakisa Portfolio Management Suite, facilitating efficient retrieval of lease-related data for portfolio and asset analysis in real estate management.

lease-type-id-in

query

string

false

Unique identifier for the type of lease, used to filter lease templates within the Nakisa Portfolio Management Suite for portfolio and asset analytics in real estate property management.

label-id

query

string

false

Unique identifier for the lease template, facilitating precise retrieval of lease-related data within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelLeaseTemplateDto

Example Responses

 1{
 2  "_embedded": {
 3    "leaseTemplates": [
 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        "label": "string",
13        "cultureId": 0,
14        "leaseId": 0,
15        "labelDtos": [
16          {
17            "createdBy": "string",
18            "lastModifiedBy": "string",
19            "createdDate": "2019-08-24T14:15:22Z",
20            "lastModifiedDate": "2019-08-24T14:15:22Z",
21            "archived": true,
22            "externalId": "string",
23            "id": 0,
24            "cultureId": 0,
25            "value": "string"
26          }
27        ]
28      }
29    ]
30  },
31  "page": {
32    "size": 0,
33    "totalElements": 0,
34    "totalPages": 0,
35    "number": 0
36  }
37}

Lease Template - Create Lease Template

HTTP Request

POST /api/lease-templates

📋 Description: Creates a new lease template within the Nakisa Portfolio Management Suite, enabling users to standardize lease agreements for real estate properties and enhance portfolio analytics.

Parameters

Name

In

Type

Required

Description

body

body

LeaseTemplateDto

true

Request body containing the lease template data, including terms, conditions, and associated metadata for effective portfolio and asset management within real estate properties.

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    "label": "string",
11    "cultureId": 0,
12    "leaseId": 0,
13    "labelDtos": [
14      {
15        "createdBy": "string",
16        "lastModifiedBy": "string",
17        "createdDate": "2019-08-24T14:15:22Z",
18        "lastModifiedDate": "2019-08-24T14:15:22Z",
19        "archived": true,
20        "externalId": "string",
21        "id": 0,
22        "cultureId": 0,
23        "value": "string"
24      }
25    ]
26  }
27]

Responses

Status

Meaning

Description

Schema

201

Created

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    "label": "string",
11    "cultureId": 0,
12    "leaseId": 0,
13    "labelDtos": [
14      {
15        "createdBy": "string",
16        "lastModifiedBy": "string",
17        "createdDate": "2019-08-24T14:15:22Z",
18        "lastModifiedDate": "2019-08-24T14:15:22Z",
19        "archived": true,
20        "externalId": "string",
21        "id": 0,
22        "cultureId": 0,
23        "value": "string"
24      }
25    ]
26  }
27]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[LeaseTemplateDto]

false

none

[Data transfer object representing a lease template within the Nakisa Portfolio Management Suite, facilitating the management and analysis of real estate properties and their associated portfolios.]

» 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

» label

string

false

none

Label for the resource

» cultureId

integer(int64)

false

none

Unique identifier for the culture

» leaseId

integer(int64)

true

none

Unique identifier for the lease

» labelDtos

[LabelDto]

true

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.

Lease Template - Archive Lease Template

HTTP Request

POST /api/lease-template/{id}/archive

📋 Description: Archives a specified lease template within the Nakisa Portfolio Management Suite, enabling effective management of real estate assets and enhancing portfolio analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

LeaseTemplateDto

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  "label": "string",
10  "cultureId": 0,
11  "leaseId": 0,
12  "labelDtos": [
13    {
14      "createdBy": "string",
15      "lastModifiedBy": "string",
16      "createdDate": "2019-08-24T14:15:22Z",
17      "lastModifiedDate": "2019-08-24T14:15:22Z",
18      "archived": true,
19      "externalId": "string",
20      "id": 0,
21      "cultureId": 0,
22      "value": "string"
23    }
24  ]
25}