Comment

Comment - Get Comment

HTTP Request

GET /api/comments/{id}

📋 Description: Fetches detailed information about a specific comment associated with a portfolio asset within the Nakisa Portfolio Management Suite, enabling users to analyze feedback 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

200

OK

OK

CommentDto

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  "commentTypeId": 0,
11  "userIds": [
12    0
13  ],
14  "redirectUrl": "string",
15  "commentType": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "priority": 0,
24    "internalId": 0,
25    "pickListCode": "string",
26    "pickListLabel": "string",
27    "label": "string",
28    "cultureId": 0,
29    "labelDtos": [
30      {
31        "createdBy": "string",
32        "lastModifiedBy": "string",
33        "createdDate": "2019-08-24T14:15:22Z",
34        "lastModifiedDate": "2019-08-24T14:15:22Z",
35        "archived": true,
36        "externalId": "string",
37        "id": 0,
38        "cultureId": 0,
39        "value": "string"
40      }
41    ]
42  }
43}

Comment - Update Comment

HTTP Request

PUT /api/comments/{id}

📋 Description: Updates an existing comment associated with a portfolio asset within the Nakisa Portfolio Management Suite, allowing users to enhance analytics and insights related to real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

CommentDto

true

Request body containing the updated comment data, including content and metadata, relevant to 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  "commentTypeId": 0,
11  "userIds": [
12    0
13  ],
14  "redirectUrl": "string",
15  "commentType": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "priority": 0,
24    "internalId": 0,
25    "pickListCode": "string",
26    "pickListLabel": "string",
27    "label": "string",
28    "cultureId": 0,
29    "labelDtos": [
30      {
31        "createdBy": "string",
32        "lastModifiedBy": "string",
33        "createdDate": "2019-08-24T14:15:22Z",
34        "lastModifiedDate": "2019-08-24T14:15:22Z",
35        "archived": true,
36        "externalId": "string",
37        "id": 0,
38        "cultureId": 0,
39        "value": "string"
40      }
41    ]
42  }
43}

Responses

Status

Meaning

Description

Schema

200

OK

OK

CommentDto

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  "commentTypeId": 0,
11  "userIds": [
12    0
13  ],
14  "redirectUrl": "string",
15  "commentType": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "priority": 0,
24    "internalId": 0,
25    "pickListCode": "string",
26    "pickListLabel": "string",
27    "label": "string",
28    "cultureId": 0,
29    "labelDtos": [
30      {
31        "createdBy": "string",
32        "lastModifiedBy": "string",
33        "createdDate": "2019-08-24T14:15:22Z",
34        "lastModifiedDate": "2019-08-24T14:15:22Z",
35        "archived": true,
36        "externalId": "string",
37        "id": 0,
38        "cultureId": 0,
39        "value": "string"
40      }
41    ]
42  }
43}

Comment - Delete Comment

HTTP Request

DELETE /api/comments/{id}

📋 Description: Deletes a specific comment identified by its unique ID from the Nakisa Portfolio Management Suite, facilitating the management of user feedback related to portfolios, assets, and 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

Comment - Archive Comment

HTTP Request

POST /api/comments/{id}/archive

📋 Description: Archives a specified comment associated with a portfolio asset within the Nakisa Portfolio Management Suite, enabling enhanced analytics and management of real estate property discussions.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

CommentDto

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  "commentTypeId": 0,
11  "userIds": [
12    0
13  ],
14  "redirectUrl": "string",
15  "commentType": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "priority": 0,
24    "internalId": 0,
25    "pickListCode": "string",
26    "pickListLabel": "string",
27    "label": "string",
28    "cultureId": 0,
29    "labelDtos": [
30      {
31        "createdBy": "string",
32        "lastModifiedBy": "string",
33        "createdDate": "2019-08-24T14:15:22Z",
34        "lastModifiedDate": "2019-08-24T14:15:22Z",
35        "archived": true,
36        "externalId": "string",
37        "id": 0,
38        "cultureId": 0,
39        "value": "string"
40      }
41    ]
42  }
43}

Comment - Get Comments

HTTP Request

GET /api/comments

📋 Description: Fetches comments associated with portfolio assets, providing insights for analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve comments related to portfolio, asset, and real estate property analytics.

search

query

string

false

Search term used to filter comments related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

message

query

string

false

Textual content of the comment associated with the portfolio or asset, used for analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelCommentDto

Example Responses

 1{
 2  "_embedded": {
 3    "comments": [
 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        "commentTypeId": 0,
14        "userIds": [
15          0
16        ],
17        "redirectUrl": "string",
18        "commentType": {
19          "createdBy": "string",
20          "lastModifiedBy": "string",
21          "createdDate": "2019-08-24T14:15:22Z",
22          "lastModifiedDate": "2019-08-24T14:15:22Z",
23          "archived": true,
24          "externalId": "string",
25          "id": 0,
26          "priority": 0,
27          "internalId": 0,
28          "pickListCode": "string",
29          "pickListLabel": "string",
30          "label": "string",
31          "cultureId": 0,
32          "labelDtos": [
33            {
34              "createdBy": "string",
35              "lastModifiedBy": "string",
36              "createdDate": "2019-08-24T14:15:22Z",
37              "lastModifiedDate": "2019-08-24T14:15:22Z",
38              "archived": true,
39              "externalId": "string",
40              "id": 0,
41              "cultureId": 0,
42              "value": "string"
43            }
44          ]
45        }
46      }
47    ]
48  },
49  "page": {
50    "size": 0,
51    "totalElements": 0,
52    "totalPages": 0,
53    "number": 0
54  }
55}