Note¶
Note - Get Note¶
HTTP Request
GET /api/notes/{id}
📋 Description: Retrieves detailed information about a specific note within the Nakisa Portfolio Management Suite, providing insights relevant to portfolio, asset, and 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 |
|---|---|---|---|
200 |
OK |
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 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Note - Update Note¶
HTTP Request
PUT /api/notes/{id}
📋 Description: Updates the specified note within the Nakisa Portfolio Management Suite, enabling users to modify details related to portfolio assets and real estate properties for enhanced analytics and management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated note details, including title, content, and associated metadata for effective portfolio and asset management within the Nakisa Portfolio Management Suite. |
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 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Note - Delete Note¶
HTTP Request
DELETE /api/notes/{id}
📋 Description: Deletes a specified note from the Nakisa Portfolio Management Suite, facilitating streamlined asset management and analytics within the portfolio context.
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 |
Note - Archive Note¶
HTTP Request
POST /api/notes/{id}/archive
📋 Description: Archives a specified note within the Nakisa Portfolio Management Suite, enabling users to manage and organize portfolio-related information effectively in the context of asset and 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 |
|---|---|---|---|
200 |
OK |
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 "message": "string",
10 "userIds": [
11 0
12 ],
13 "redirectUrl": "string"
14}
Note - Get Notes¶
HTTP Request
GET /api/notes
📋 Description: Retrieves a list of notes related to portfolio assets within the Nakisa Portfolio Management Suite, enabling users to access critical analytics and insights for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of notes related to portfolio, asset, and real estate property analytics. |
|
search |
query |
string |
false |
Search term used to filter notes related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite. |
message |
query |
string |
false |
Textual content of the note, providing insights or comments related to portfolio, asset, or real estate property analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
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 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}