Project Site Development¶
Project Site Development - Update Project Site Development¶
HTTP Request
PUT /api/developments/{id}
📋 Description: Updates the details of a specific development asset within the Nakisa Portfolio Management Suite, enabling users to manage portfolio data effectively and enhance real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated development details, including portfolio attributes, asset specifications, and analytics metrics relevant to the real estate property. |
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 "applyToMasterPlan": true,
10 "expectDowntime": true,
11 "tempStore": true,
12 "developmentProgressId": 0,
13 "developmentStatusId": 0,
14 "projectSiteRelationId": 0,
15 "developmentProgress": {
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 "developmentStatus": {
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 "priority": 0,
52 "internalId": 0,
53 "pickListCode": "string",
54 "pickListLabel": "string",
55 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70 },
71 "site": "string",
72 "siteId": 0,
73 "siteExternalId": "string",
74 "isDraft": true
75}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Project Site Development - Delete Project Site Development¶
HTTP Request
DELETE /api/developments/{id}
📋 Description: Deletes a specified development asset from the Nakisa Portfolio Management Suite, ensuring that portfolio and real estate property data remains accurate and up-to-date.
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 Development - Create Project Site Development¶
HTTP Request
POST /api/developments
📋 Description: Creates a new development entry within the Nakisa Portfolio Management Suite, enabling users to manage and analyze real estate properties and associated assets effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the development details, including portfolio identifiers, asset specifications, and analytics parameters relevant to real estate property management. |
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 "applyToMasterPlan": true,
10 "expectDowntime": true,
11 "tempStore": true,
12 "developmentProgressId": 0,
13 "developmentStatusId": 0,
14 "projectSiteRelationId": 0,
15 "developmentProgress": {
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 "developmentStatus": {
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 "priority": 0,
52 "internalId": 0,
53 "pickListCode": "string",
54 "pickListLabel": "string",
55 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70 },
71 "site": "string",
72 "siteId": 0,
73 "siteExternalId": "string",
74 "isDraft": true
75}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Project Site Development - Get All Project Site Development By Project ID¶
HTTP Request
GET /api/developments/projects/{projectId}
📋 Description: Fetches detailed information about a specific project within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset management related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "applyToMasterPlan": true,
11 "expectDowntime": true,
12 "tempStore": true,
13 "developmentProgressId": 0,
14 "developmentStatusId": 0,
15 "projectSiteRelationId": 0,
16 "developmentProgress": {
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 "priority": 0,
25 "internalId": 0,
26 "pickListCode": "string",
27 "pickListLabel": "string",
28 "label": "string",
29 "cultureId": 0,
30 "labelDtos": [
31 {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "cultureId": 0,
40 "value": "string"
41 }
42 ]
43 },
44 "developmentStatus": {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "priority": 0,
53 "internalId": 0,
54 "pickListCode": "string",
55 "pickListLabel": "string",
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 "site": "string",
73 "siteId": 0,
74 "siteExternalId": "string",
75 "isDraft": true
76 }
77]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the development details of a project site within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management analytics for real estate properties.] |
|
» 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 |
» applyToMasterPlan |
boolean |
false |
none |
Boolean flag indicating applyToMasterPlan status |
» expectDowntime |
boolean |
false |
none |
Boolean flag indicating expectDowntime status |
» tempStore |
boolean |
false |
none |
Boolean flag indicating tempStore status |
» developmentProgressId |
integer(int64) |
false |
none |
Unique identifier for the development progress |
» developmentStatusId |
integer(int64) |
false |
none |
Unique identifier for the development status |
» projectSiteRelationId |
integer(int64) |
false |
none |
Unique identifier for the project site relation |
» developmentProgress |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
»» 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 |
»» priority |
integer(int64) |
false |
none |
Priority of the resource |
»» internalId |
integer(int64) |
false |
none |
Unique identifier for the internal |
»» pickListCode |
string |
false |
none |
Code for the pick list |
»» pickListLabel |
string |
false |
none |
Label for the pick list |
»» label |
string |
false |
none |
Label for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» labelDtos |
false |
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. |
» developmentStatus |
false |
none |
Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management. |
|
» site |
string |
false |
none |
Represents the specific site associated with the project, facilitating portfolio analysis and asset management within the Nakisa Portfolio Management Suite. |
» siteId |
integer(int64) |
false |
none |
Unique identifier for the site |
» siteExternalId |
string |
false |
none |
Unique identifier for the site external |
» isDraft |
boolean |
false |
none |
Whether the resource is draft |
Project Site Development - Delete Project Site Development By Relation ID¶
HTTP Request
DELETE /api/developments/relations/{relationId}
📋 Description: Deletes a specified relationship between developments in the Nakisa Portfolio Management Suite, enabling users to maintain accurate portfolio and asset analytics within the real estate property domain.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
relationId |
path |
integer(int64) |
true |
Unique identifier for the relation |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |