Clause

Clause - Get Clause

HTTP Request

GET /api/clauses/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific clause within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio assets effectively 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	ClauseDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "pageNumber": "string",
  "section": "string",
  "rentOrCost": 0,
  "leaseClauseTypeId": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clause - Update Clause

HTTP Request

PUT /api/clauses/{id}

Interactive Demo

📋 Description: Updates the specified clause in the Nakisa Portfolio Management Suite, allowing users to modify details related to portfolio, asset, and real estate property management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ClauseDto	true	Request body containing the updated clause details for the specified asset within the portfolio, including relevant analytics and metadata.

Body Parameters

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "pageNumber": "string",
  "section": "string",
  "rentOrCost": 0,
  "leaseClauseTypeId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ClauseDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "pageNumber": "string",
  "section": "string",
  "rentOrCost": 0,
  "leaseClauseTypeId": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clause - Delete Clause

HTTP Request

DELETE /api/clauses/{id}

Interactive Demo

📋 Description: Deletes a specified clause 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

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clause - Add Clause Notes

HTTP Request

POST /api/clauses/{id}/notes

Interactive Demo

📋 Description: Adds a note to a specified clause within the Nakisa Portfolio Management Suite, enhancing asset management and analytics for real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	NoteDto	true	Request body containing the notes related to the specified clause, including text content and associated metadata for portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "message": "string",
    "userIds": [
      0
    ],
    "redirectUrl": "string"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "message": "string",
    "userIds": [
      0
    ],
    "redirectUrl": "string"
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[NoteDto]	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.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clause - Archive Clause

HTTP Request

POST /api/clauses/{id}/archive

Interactive Demo

📋 Description: Archives a specified clause within the Nakisa Portfolio Management Suite, enabling effective management of portfolio assets and enhancing analytics for 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	ClauseDto

Example Responses

{
  "createdBy": "string",
  "lastModifiedBy": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "lastModifiedDate": "2019-08-24T14:15:22Z",
  "archived": true,
  "externalId": "string",
  "id": 0,
  "pageNumber": "string",
  "section": "string",
  "rentOrCost": 0,
  "leaseClauseTypeId": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clause - Get Clauses

HTTP Request

GET /api/clauses

Interactive Demo

📋 Description: Retrieves a list of clauses related to portfolio and asset management within the Nakisa Portfolio Management Suite, enabling users to analyze contractual terms and conditions for real estate properties.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, facilitating efficient retrieval of clause data within the Nakisa Portfolio Management Suite for enhanced portfolio and asset analytics.
search	query	string	false	Search term used to filter and retrieve specific clauses related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.
lease-id	query	string	false	Unique identifier for the lease associated with a real estate property, used to retrieve relevant clauses within the Nakisa Portfolio Management Suite.
type-id	query	string	false	Specifies the unique identifier for the clause type, enabling targeted retrieval of relevant portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.
page-number	query	string	false	Specifies the page number for retrieving a subset of clauses within the Nakisa Portfolio Management Suite, facilitating efficient navigation through portfolio, asset, and real estate property analytics.
section	query	string	false	Specifies the section of the portfolio to retrieve clauses related to asset management and analytics within the Nakisa Portfolio Management Suite.
not-applicable	query	string	false	Indicates that a specific clause is not applicable to the portfolio, asset, or real estate property being analyzed within the Nakisa Portfolio Management Suite.
rent-or-cost	query	string	false	Specifies whether to retrieve clauses related to rental agreements or cost allocations within the Nakisa Portfolio Management Suite, facilitating informed decision-making in portfolio and asset management.
id-not-in	query	string	false	Specifies a comma-separated list of clause IDs to exclude from the results when retrieving clauses related to portfolio, asset, and real estate property analytics.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelClauseDto

Example Responses

{
  "_embedded": {
    "clauses": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "pageNumber": "string",
        "section": "string",
        "rentOrCost": 0,
        "leaseClauseTypeId": 0
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clause - Get Clause Notes

HTTP Request

GET /api/clauses/{clauseId}/notes

Interactive Demo

📋 Description: Retrieves notes associated with a specific clause identified by the clauseId, providing valuable insights for portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name	In	Type	Required	Description
clauseId	path	integer(int64)	true	Unique identifier for the clause
pageable	query	Pageable	true	Indicates whether the results of the notes associated with a specific clause should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite.
search	query	string	false	Search term used to filter notes related to a specific clause within the Nakisa Portfolio Management Suite, enhancing asset and portfolio analytics for real estate properties.
message	query	string	false	Textual content of the note associated with the specified clause, providing insights relevant to portfolio and asset management within real estate analytics.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelNoteDto

Example Responses

{
  "_embedded": {
    "notes": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "message": "string",
        "userIds": [
          0
        ],
        "redirectUrl": "string"
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---