Project Site Relation¶
Project Site Relation - Get Project Site Relation¶
HTTP Request
GET /api/project-site-relations/{id}
📋 Description: Retrieves the details of a specific project-site relationship identified by the provided ID, facilitating insights into portfolio and asset management 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 |
Example Responses
1{
2 "id": 0,
3 "siteExternalId": "string",
4 "siteName": "string",
5 "siteArea": 0.1,
6 "siteUnitId": 0,
7 "isDraft": true,
8 "projectId": 0,
9 "siteId": 0
10}
Project Site Relation - Update Project Site Relation¶
HTTP Request
PUT /api/project-site-relations/{id}
📋 Description: Updates the relationship details of a specified project site within the Nakisa Portfolio Management Suite, enabling enhanced management of portfolio assets and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated project-site relationship data, including portfolio identifiers and asset analytics relevant to real estate property management. |
Body Parameters
1{
2 "id": 0,
3 "siteExternalId": "string",
4 "siteName": "string",
5 "siteArea": 0.1,
6 "siteUnitId": 0,
7 "isDraft": true,
8 "projectId": 0,
9 "siteId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Project Site Relation - Detch Site From Project¶
HTTP Request
DELETE /api/project-site-relations/{id}
📋 Description: Deletes a specified project-site relation from the Nakisa Portfolio Management Suite, facilitating the management of portfolio and asset relationships 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 |
None |
Project Site Relation - Attach Site With Project¶
HTTP Request
POST /api/project-site-relations
📋 Description: Creates a new relationship between project sites within the Nakisa Portfolio Management Suite, enabling enhanced portfolio analytics and asset management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the project-site relationship data, including portfolio identifiers, asset allocations, and relevant analytics for real estate property management. |
Body Parameters
1{
2 "id": 0,
3 "siteExternalId": "string",
4 "siteName": "string",
5 "siteArea": 0.1,
6 "siteUnitId": 0,
7 "isDraft": true,
8 "projectId": 0,
9 "siteId": 0
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Project Site Relation - Download Site Comparison Report¶
HTTP Request
POST /api/project-site-relations/projects/{projectId}/download
📋 Description: Downloads project site relation data for the specified project, enabling users to analyze portfolio and asset performance within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
body |
body |
true |
Request body containing the parameters necessary to initiate the download of project-site relationship data, including relevant asset and portfolio analytics for real estate property management. |
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 "typeId": 0,
11 "priority": 0,
12 "required": true,
13 "reportable": true,
14 "labels": [
15 {
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 "cultureId": 0,
24 "value": "string"
25 }
26 ],
27 "udfGroupId": 0,
28 "type": {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "priority": 0,
37 "internalId": 0,
38 "pickListCode": "string",
39 "pickListLabel": "string",
40 "label": "string",
41 "cultureId": 0,
42 "labelDtos": [
43 {
44 "createdBy": "string",
45 "lastModifiedBy": "string",
46 "createdDate": "2019-08-24T14:15:22Z",
47 "lastModifiedDate": "2019-08-24T14:15:22Z",
48 "archived": true,
49 "externalId": "string",
50 "id": 0,
51 "cultureId": 0,
52 "value": "string"
53 }
54 ]
55 },
56 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 }
72]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{}