Project¶
Project - Get Project¶
HTTP Request
GET /api/projects/{id}
📋 Description: Retrieves detailed information about a specific project within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset allocation 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 |
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 "name": "string",
10 "description": "string",
11 "targetDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "dueDate": "2019-08-24",
14 "possessionDate": "2019-08-24",
15 "projectTargetTypeId": 0,
16 "projectActivityId": 0,
17 "projectTypeId": 0,
18 "projectPriorityId": 0,
19 "projectPrivacyId": 0,
20 "projectStatusId": 0,
21 "progressStatusId": 0,
22 "projectManagerId": 0,
23 "taskEmailSendDate": "2019-08-24",
24 "copyMilestoneDate": true,
25 "isTemplate": true,
26 "isPrefilled": true,
27 "projectActivity": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "projectTargetType": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "projectType": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "projectPriority": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "projectPrivacy": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "progressStatus": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "projectStatus": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "projectManager": "string",
224 "milestonesIds": [
225 0
226 ],
227 "siteIds": [
228 0
229 ]
230}
Project - Update Project¶
HTTP Request
PUT /api/projects/{id}
📋 Description: Updates the details of a specific project within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties effectively.
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 details, including portfolio attributes, asset allocations, and analytics metrics 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 "name": "string",
10 "description": "string",
11 "targetDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "dueDate": "2019-08-24",
14 "possessionDate": "2019-08-24",
15 "projectTargetTypeId": 0,
16 "projectActivityId": 0,
17 "projectTypeId": 0,
18 "projectPriorityId": 0,
19 "projectPrivacyId": 0,
20 "projectStatusId": 0,
21 "progressStatusId": 0,
22 "projectManagerId": 0,
23 "taskEmailSendDate": "2019-08-24",
24 "copyMilestoneDate": true,
25 "isTemplate": true,
26 "isPrefilled": true,
27 "projectActivity": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "projectTargetType": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "projectType": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "projectPriority": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "projectPrivacy": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "progressStatus": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "projectStatus": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "projectManager": "string",
224 "milestonesIds": [
225 0
226 ],
227 "siteIds": [
228 0
229 ]
230}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Project - Delete Project¶
HTTP Request
DELETE /api/projects/{id}
📋 Description: Deletes a specified project from the Nakisa Portfolio Management Suite, facilitating effective portfolio management and asset optimization 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 - Get Projects¶
HTTP Request
GET /api/projects
📋 Description: Retrieves a list of projects within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset allocation in the context of real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the project retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
listing |
query |
boolean |
false |
Indicates whether to include detailed listing information for assets within the portfolio in the response from the Nakisa Portfolio Management Suite. |
search |
query |
string |
false |
Search term used to filter and retrieve specific projects within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
id-in |
query |
string |
false |
Unique identifier for the project within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and analytics data related to real estate properties. |
external-id |
query |
string |
false |
Unique identifier for an external asset within the Nakisa Portfolio Management Suite, facilitating precise retrieval of project data related to portfolio and real estate analytics. |
external-id-like |
query |
string |
false |
Filters the list of projects by matching external identifiers, enabling users to efficiently locate specific assets within the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
name-like |
query |
string |
false |
Filters the list of projects by matching names that are similar to the specified string, facilitating targeted analytics within the Nakisa Portfolio Management Suite. |
archived |
query |
string |
false |
Indicates whether to retrieve archived projects within the Nakisa Portfolio Management Suite, facilitating comprehensive portfolio and asset analytics in real estate property management. |
status-id |
query |
string |
false |
Unique identifier for the status of a project within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management. |
status-id-in |
query |
string |
false |
Filters the project results based on the specified status ID, enabling users to retrieve projects relevant to portfolio management, asset tracking, analytics, and real estate property assessments. |
manager-id |
query |
string |
false |
Unique identifier for the manager associated with the projects, facilitating targeted portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
start-date |
query |
string |
false |
Specifies the starting date for retrieving project data within the Nakisa Portfolio Management Suite, enabling users to filter portfolio, asset, and analytics information related to real estate properties. |
due-date |
query |
string |
false |
Specifies the due date for project deliverables, enabling effective tracking and management of timelines within the Nakisa Portfolio Management Suite. |
capacity-planning |
query |
string |
false |
Specifies the capacity planning strategy to be utilized for optimizing resource allocation within portfolio and asset management in the Nakisa Portfolio Management Suite. |
capacity-user-in |
query |
string |
false |
Specifies the user capacity for portfolio analysis within the Nakisa Portfolio Management Suite, facilitating informed decision-making in asset and real estate property management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "projects": [
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 "name": "string",
13 "description": "string",
14 "targetDate": "2019-08-24",
15 "startDate": "2019-08-24",
16 "dueDate": "2019-08-24",
17 "possessionDate": "2019-08-24",
18 "projectTargetTypeId": 0,
19 "projectActivityId": 0,
20 "projectTypeId": 0,
21 "projectPriorityId": 0,
22 "projectPrivacyId": 0,
23 "projectStatusId": 0,
24 "progressStatusId": 0,
25 "projectManagerId": 0,
26 "taskEmailSendDate": "2019-08-24",
27 "copyMilestoneDate": true,
28 "isTemplate": true,
29 "isPrefilled": true,
30 "projectActivity": {
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 "priority": 0,
39 "internalId": 0,
40 "pickListCode": "string",
41 "pickListLabel": "string",
42 "label": "string",
43 "cultureId": 0,
44 "labelDtos": [
45 {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "cultureId": 0,
54 "value": "string"
55 }
56 ]
57 },
58 "projectTargetType": {
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 "priority": 0,
67 "internalId": 0,
68 "pickListCode": "string",
69 "pickListLabel": "string",
70 "label": "string",
71 "cultureId": 0,
72 "labelDtos": [
73 {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "cultureId": 0,
82 "value": "string"
83 }
84 ]
85 },
86 "projectType": {
87 "createdBy": "string",
88 "lastModifiedBy": "string",
89 "createdDate": "2019-08-24T14:15:22Z",
90 "lastModifiedDate": "2019-08-24T14:15:22Z",
91 "archived": true,
92 "externalId": "string",
93 "id": 0,
94 "priority": 0,
95 "internalId": 0,
96 "pickListCode": "string",
97 "pickListLabel": "string",
98 "label": "string",
99 "cultureId": 0,
100 "labelDtos": [
101 {
102 "createdBy": "string",
103 "lastModifiedBy": "string",
104 "createdDate": "2019-08-24T14:15:22Z",
105 "lastModifiedDate": "2019-08-24T14:15:22Z",
106 "archived": true,
107 "externalId": "string",
108 "id": 0,
109 "cultureId": 0,
110 "value": "string"
111 }
112 ]
113 },
114 "projectPriority": {
115 "createdBy": "string",
116 "lastModifiedBy": "string",
117 "createdDate": "2019-08-24T14:15:22Z",
118 "lastModifiedDate": "2019-08-24T14:15:22Z",
119 "archived": true,
120 "externalId": "string",
121 "id": 0,
122 "priority": 0,
123 "internalId": 0,
124 "pickListCode": "string",
125 "pickListLabel": "string",
126 "label": "string",
127 "cultureId": 0,
128 "labelDtos": [
129 {
130 "createdBy": "string",
131 "lastModifiedBy": "string",
132 "createdDate": "2019-08-24T14:15:22Z",
133 "lastModifiedDate": "2019-08-24T14:15:22Z",
134 "archived": true,
135 "externalId": "string",
136 "id": 0,
137 "cultureId": 0,
138 "value": "string"
139 }
140 ]
141 },
142 "projectPrivacy": {
143 "createdBy": "string",
144 "lastModifiedBy": "string",
145 "createdDate": "2019-08-24T14:15:22Z",
146 "lastModifiedDate": "2019-08-24T14:15:22Z",
147 "archived": true,
148 "externalId": "string",
149 "id": 0,
150 "priority": 0,
151 "internalId": 0,
152 "pickListCode": "string",
153 "pickListLabel": "string",
154 "label": "string",
155 "cultureId": 0,
156 "labelDtos": [
157 {
158 "createdBy": "string",
159 "lastModifiedBy": "string",
160 "createdDate": "2019-08-24T14:15:22Z",
161 "lastModifiedDate": "2019-08-24T14:15:22Z",
162 "archived": true,
163 "externalId": "string",
164 "id": 0,
165 "cultureId": 0,
166 "value": "string"
167 }
168 ]
169 },
170 "progressStatus": {
171 "createdBy": "string",
172 "lastModifiedBy": "string",
173 "createdDate": "2019-08-24T14:15:22Z",
174 "lastModifiedDate": "2019-08-24T14:15:22Z",
175 "archived": true,
176 "externalId": "string",
177 "id": 0,
178 "priority": 0,
179 "internalId": 0,
180 "pickListCode": "string",
181 "pickListLabel": "string",
182 "label": "string",
183 "cultureId": 0,
184 "labelDtos": [
185 {
186 "createdBy": "string",
187 "lastModifiedBy": "string",
188 "createdDate": "2019-08-24T14:15:22Z",
189 "lastModifiedDate": "2019-08-24T14:15:22Z",
190 "archived": true,
191 "externalId": "string",
192 "id": 0,
193 "cultureId": 0,
194 "value": "string"
195 }
196 ]
197 },
198 "projectStatus": {
199 "createdBy": "string",
200 "lastModifiedBy": "string",
201 "createdDate": "2019-08-24T14:15:22Z",
202 "lastModifiedDate": "2019-08-24T14:15:22Z",
203 "archived": true,
204 "externalId": "string",
205 "id": 0,
206 "priority": 0,
207 "internalId": 0,
208 "pickListCode": "string",
209 "pickListLabel": "string",
210 "label": "string",
211 "cultureId": 0,
212 "labelDtos": [
213 {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "cultureId": 0,
222 "value": "string"
223 }
224 ]
225 },
226 "projectManager": "string",
227 "milestonesIds": [
228 0
229 ],
230 "siteIds": [
231 0
232 ]
233 }
234 ]
235 },
236 "page": {
237 "size": 0,
238 "totalElements": 0,
239 "totalPages": 0,
240 "number": 0
241 }
242}
Project - Create Project¶
HTTP Request
POST /api/projects
📋 Description: Creates a new project within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze real estate assets and portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing project details, including portfolio association, asset specifications, and relevant analytics for 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 "name": "string",
10 "description": "string",
11 "targetDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "dueDate": "2019-08-24",
14 "possessionDate": "2019-08-24",
15 "projectTargetTypeId": 0,
16 "projectActivityId": 0,
17 "projectTypeId": 0,
18 "projectPriorityId": 0,
19 "projectPrivacyId": 0,
20 "projectStatusId": 0,
21 "progressStatusId": 0,
22 "projectManagerId": 0,
23 "taskEmailSendDate": "2019-08-24",
24 "copyMilestoneDate": true,
25 "isTemplate": true,
26 "isPrefilled": true,
27 "projectActivity": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "projectTargetType": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "projectType": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "projectPriority": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "projectPrivacy": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "progressStatus": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "projectStatus": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "projectManager": "string",
224 "milestonesIds": [
225 0
226 ],
227 "siteIds": [
228 0
229 ]
230}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Project - Get Pictures For Location¶
HTTP Request
GET /api/projects/{projectId}/pictures
📋 Description: Fetches a list of pictures associated with a specific project, enabling users to visualize and analyze portfolio assets within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the project pictures retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
projectId |
path |
string |
true |
Unique identifier for the project |
search |
query |
string |
false |
Search term used to filter and retrieve specific pictures related to a project within the Nakisa Portfolio Management Suite. |
default |
query |
string |
false |
Specifies the default picture to be retrieved for the project, enhancing visual representation within the Nakisa Portfolio Management Suite’s asset analytics for real estate properties. |
name |
query |
string |
false |
Name of the resource |
type |
query |
string |
false |
Type of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "pictures": [
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 "isDefault": true,
12 "documentDto": {
13 "createdBy": "string",
14 "lastModifiedBy": "string",
15 "createdDate": "2019-08-24T14:15:22Z",
16 "lastModifiedDate": "2019-08-24T14:15:22Z",
17 "archived": true,
18 "externalId": "string",
19 "id": 0,
20 "name": "string",
21 "title": "string",
22 "type": "string",
23 "description": "string",
24 "link": "string",
25 "signedDate": "2019-08-24",
26 "documentTypeId": 0,
27 "statusId": 0,
28 "shareable": true,
29 "size": 0,
30 "documentType": {
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 "priority": 0,
39 "internalId": 0,
40 "pickListCode": "string",
41 "pickListLabel": "string",
42 "label": "string",
43 "cultureId": 0,
44 "labelDtos": [
45 {
46 "createdBy": "string",
47 "lastModifiedBy": "string",
48 "createdDate": "2019-08-24T14:15:22Z",
49 "lastModifiedDate": "2019-08-24T14:15:22Z",
50 "archived": true,
51 "externalId": "string",
52 "id": 0,
53 "cultureId": 0,
54 "value": "string"
55 }
56 ]
57 },
58 "status": {
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 "priority": 0,
67 "internalId": 0,
68 "pickListCode": "string",
69 "pickListLabel": "string",
70 "label": "string",
71 "cultureId": 0,
72 "labelDtos": [
73 {
74 "createdBy": "string",
75 "lastModifiedBy": "string",
76 "createdDate": "2019-08-24T14:15:22Z",
77 "lastModifiedDate": "2019-08-24T14:15:22Z",
78 "archived": true,
79 "externalId": "string",
80 "id": 0,
81 "cultureId": 0,
82 "value": "string"
83 }
84 ]
85 }
86 }
87 }
88 ]
89 },
90 "page": {
91 "size": 0,
92 "totalElements": 0,
93 "totalPages": 0,
94 "number": 0
95 }
96}
Project - Upload Project Picture¶
HTTP Request
POST /api/projects/{projectId}/pictures
📋 Description: Uploads images associated with a specific project in the Nakisa Portfolio Management Suite, enhancing asset visualization and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
body |
body |
object |
false |
Request body containing the image data and associated metadata for portfolio assets within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
true |
none |
» document |
body |
true |
Data transfer object representing a document within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio assets, analytics, and real estate properties. |
|
»» createdBy |
body |
string |
false |
Username of who created this resource |
»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»» externalId |
body |
string |
false |
Unique identifier for the external |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» title |
body |
string |
false |
Title of the resource |
»» type |
body |
string |
false |
Type of the resource |
»» description |
body |
string |
false |
Description of the resource |
»» link |
body |
string |
false |
URL link to access detailed information or resources related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»» signedDate |
body |
string(date) |
false |
Date of the signed |
»» documentTypeId |
body |
integer(int64) |
false |
Unique identifier for the document type |
»» statusId |
body |
integer(int64) |
false |
Unique identifier for the status |
»» shareable |
body |
boolean |
false |
Boolean flag indicating shareable status |
»» size |
body |
integer(int64) |
false |
Number of items per page |
»» documentType |
body |
false |
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 |
body |
string |
false |
Username of who created this resource |
»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»» priority |
body |
integer(int64) |
false |
Priority of the resource |
»»» internalId |
body |
integer(int64) |
false |
Unique identifier for the internal |
»»» pickListCode |
body |
string |
false |
Code for the pick list |
»»» pickListLabel |
body |
string |
false |
Label for the pick list |
»»» label |
body |
string |
false |
Label for the resource |
»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»» labelDtos |
body |
false |
List of labelDtos items |
|
»»»» createdBy |
body |
string |
false |
Username of who created this resource |
»»»» lastModifiedBy |
body |
string |
false |
Username of who last modified this resource |
»»»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»»»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»»»» archived |
body |
boolean |
false |
Boolean flag indicating archived status |
»»»» externalId |
body |
string |
false |
Unique identifier for the external |
»»»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»»»» cultureId |
body |
integer(int64) |
false |
Unique identifier for the culture |
»»»» value |
body |
string |
true |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
»» status |
body |
false |
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. |
Body Parameters
1{
2 "document": {
3 "archived": true,
4 "createdBy": "string",
5 "createdDate": "2019-08-24 14:15:22+00:00",
6 "description": "string",
7 "documentType": {
8 "archived": true,
9 "createdBy": "string",
10 "createdDate": "2019-08-24 14:15:22+00:00",
11 "cultureId": 0,
12 "externalId": "string",
13 "id": 0,
14 "internalId": 0,
15 "label": "string",
16 "labelDtos": [
17 {
18 "archived": true,
19 "createdBy": "string",
20 "createdDate": "2019-08-24 14:15:22+00:00",
21 "cultureId": 0,
22 "externalId": "string",
23 "id": 0,
24 "lastModifiedBy": "string",
25 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
26 "value": "string"
27 }
28 ],
29 "lastModifiedBy": "string",
30 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
31 "pickListCode": "string",
32 "pickListLabel": "string",
33 "priority": 0
34 },
35 "documentTypeId": 0,
36 "externalId": "string",
37 "id": 0,
38 "lastModifiedBy": "string",
39 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
40 "link": "string",
41 "name": "string",
42 "shareable": true,
43 "signedDate": "2019-08-24",
44 "size": 0,
45 "status": {
46 "archived": true,
47 "createdBy": "string",
48 "createdDate": "2019-08-24 14:15:22+00:00",
49 "cultureId": 0,
50 "externalId": "string",
51 "id": 0,
52 "internalId": 0,
53 "label": "string",
54 "labelDtos": [
55 {
56 "archived": true,
57 "createdBy": "string",
58 "createdDate": "2019-08-24 14:15:22+00:00",
59 "cultureId": 0,
60 "externalId": "string",
61 "id": 0,
62 "lastModifiedBy": "string",
63 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
64 "value": "string"
65 }
66 ],
67 "lastModifiedBy": "string",
68 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
69 "pickListCode": "string",
70 "pickListLabel": "string",
71 "priority": 0
72 },
73 "statusId": 0,
74 "title": "string",
75 "type": "string"
76 },
77 "file": "string"
78}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "isDefault": true,
9 "documentDto": {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "name": "string",
18 "title": "string",
19 "type": "string",
20 "description": "string",
21 "link": "string",
22 "signedDate": "2019-08-24",
23 "documentTypeId": 0,
24 "statusId": 0,
25 "shareable": true,
26 "size": 0,
27 "documentType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "status": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84}
Project - Set Default Location Picture¶
HTTP Request
POST /api/projects/{projectId}/pictures/{pictureId}/default
📋 Description: Sets the specified picture as the default image for the project, enhancing visual representation within the Nakisa Portfolio Management Suite for improved asset analytics and portfolio management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
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 "isDefault": true,
9 "documentDto": {
10 "createdBy": "string",
11 "lastModifiedBy": "string",
12 "createdDate": "2019-08-24T14:15:22Z",
13 "lastModifiedDate": "2019-08-24T14:15:22Z",
14 "archived": true,
15 "externalId": "string",
16 "id": 0,
17 "name": "string",
18 "title": "string",
19 "type": "string",
20 "description": "string",
21 "link": "string",
22 "signedDate": "2019-08-24",
23 "documentTypeId": 0,
24 "statusId": 0,
25 "shareable": true,
26 "size": 0,
27 "documentType": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "status": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 }
83 }
84}
Project - Add Notes To Project¶
HTTP Request
POST /api/projects/{projectId}/notes
📋 Description: Creates a new note associated with a specified project, enhancing portfolio management by allowing users to document insights and observations related to assets and real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
body |
body |
true |
Request body containing the note details, including content and associated metadata, for effective asset management and analytics within the Nakisa Portfolio Management Suite. |
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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. |
Project - Add Comments To Project¶
HTTP Request
POST /api/projects/{projectId}/comments
📋 Description: Adds a new comment to the specified project within the Nakisa Portfolio Management Suite, facilitating collaboration and feedback on portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
body |
body |
true |
Request body containing the comment data for the specified project, including user details, comment text, and associated metadata to enhance collaboration within the Nakisa Portfolio Management Suite. |
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 "message": "string",
11 "commentTypeId": 0,
12 "userIds": [
13 0
14 ],
15 "redirectUrl": "string",
16 "commentType": {
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 }
45]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "message": "string",
11 "commentTypeId": 0,
12 "userIds": [
13 0
14 ],
15 "redirectUrl": "string",
16 "commentType": {
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 }
45]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a comment associated with a portfolio asset within the Nakisa Portfolio Management Suite, facilitating collaboration and insights in real estate property analytics.] |
|
» 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 |
false |
none |
Textual content of the comment associated with a portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
» commentTypeId |
integer(int64) |
false |
none |
Unique identifier for the comment type |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
Specifies the URL to which users will be redirected after completing an action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio and asset management. |
» commentType |
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. |
Project - Archive Project¶
HTTP Request
POST /api/projects/{id}/archive
📋 Description: Archives a specified project within the Nakisa Portfolio Management Suite, facilitating streamlined portfolio management and asset 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 |
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 "name": "string",
10 "description": "string",
11 "targetDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "dueDate": "2019-08-24",
14 "possessionDate": "2019-08-24",
15 "projectTargetTypeId": 0,
16 "projectActivityId": 0,
17 "projectTypeId": 0,
18 "projectPriorityId": 0,
19 "projectPrivacyId": 0,
20 "projectStatusId": 0,
21 "progressStatusId": 0,
22 "projectManagerId": 0,
23 "taskEmailSendDate": "2019-08-24",
24 "copyMilestoneDate": true,
25 "isTemplate": true,
26 "isPrefilled": true,
27 "projectActivity": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "projectTargetType": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "projectType": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "projectPriority": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "projectPrivacy": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "progressStatus": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "projectStatus": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "projectManager": "string",
224 "milestonesIds": [
225 0
226 ],
227 "siteIds": [
228 0
229 ]
230}
Project - Create Project From Template¶
HTTP Request
POST /api/projects/templates/{templateId}
📋 Description: Creates a new project based on the specified template identified by {templateId}, enabling users to efficiently manage portfolio assets and enhance analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
templateId |
path |
integer(int64) |
true |
Unique identifier for the template |
body |
body |
true |
Request body containing the project template details, including specifications and associated metadata for effective portfolio and asset 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 "name": "string",
10 "description": "string",
11 "targetDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "dueDate": "2019-08-24",
14 "possessionDate": "2019-08-24",
15 "projectTargetTypeId": 0,
16 "projectActivityId": 0,
17 "projectTypeId": 0,
18 "projectPriorityId": 0,
19 "projectPrivacyId": 0,
20 "projectStatusId": 0,
21 "progressStatusId": 0,
22 "projectManagerId": 0,
23 "taskEmailSendDate": "2019-08-24",
24 "copyMilestoneDate": true,
25 "isTemplate": true,
26 "isPrefilled": true,
27 "projectActivity": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "projectTargetType": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "projectType": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "projectPriority": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "projectPrivacy": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "progressStatus": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "projectStatus": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "projectManager": "string",
224 "milestonesIds": [
225 0
226 ],
227 "siteIds": [
228 0
229 ]
230}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Project - Duplicate Project¶
HTTP Request
POST /api/projects/duplicate/{projectId}/copyMilestone/{isCopyMilestone}/copyTask/{isCopyTask}/copySiteInformation/{isCopySiteInformation}
📋 Description: Duplicates a specified project along with optional milestones, tasks, and site information, enhancing portfolio management and asset analytics within the Nakisa Portfolio Management Suite. This operation allows users to streamline project replication for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
isCopyMilestone |
path |
boolean |
true |
Whether the resource is copy milestone |
isCopyTask |
path |
boolean |
true |
Whether the resource is copy task |
isCopySiteInformation |
path |
boolean |
true |
Whether the resource is copy site information |
body |
body |
true |
Request body containing the project duplication parameters, including options for copying milestones, tasks, and site information, to facilitate efficient portfolio management and asset analytics 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 "name": "string",
10 "description": "string",
11 "targetDate": "2019-08-24",
12 "startDate": "2019-08-24",
13 "dueDate": "2019-08-24",
14 "possessionDate": "2019-08-24",
15 "projectTargetTypeId": 0,
16 "projectActivityId": 0,
17 "projectTypeId": 0,
18 "projectPriorityId": 0,
19 "projectPrivacyId": 0,
20 "projectStatusId": 0,
21 "progressStatusId": 0,
22 "projectManagerId": 0,
23 "taskEmailSendDate": "2019-08-24",
24 "copyMilestoneDate": true,
25 "isTemplate": true,
26 "isPrefilled": true,
27 "projectActivity": {
28 "createdBy": "string",
29 "lastModifiedBy": "string",
30 "createdDate": "2019-08-24T14:15:22Z",
31 "lastModifiedDate": "2019-08-24T14:15:22Z",
32 "archived": true,
33 "externalId": "string",
34 "id": 0,
35 "priority": 0,
36 "internalId": 0,
37 "pickListCode": "string",
38 "pickListLabel": "string",
39 "label": "string",
40 "cultureId": 0,
41 "labelDtos": [
42 {
43 "createdBy": "string",
44 "lastModifiedBy": "string",
45 "createdDate": "2019-08-24T14:15:22Z",
46 "lastModifiedDate": "2019-08-24T14:15:22Z",
47 "archived": true,
48 "externalId": "string",
49 "id": 0,
50 "cultureId": 0,
51 "value": "string"
52 }
53 ]
54 },
55 "projectTargetType": {
56 "createdBy": "string",
57 "lastModifiedBy": "string",
58 "createdDate": "2019-08-24T14:15:22Z",
59 "lastModifiedDate": "2019-08-24T14:15:22Z",
60 "archived": true,
61 "externalId": "string",
62 "id": 0,
63 "priority": 0,
64 "internalId": 0,
65 "pickListCode": "string",
66 "pickListLabel": "string",
67 "label": "string",
68 "cultureId": 0,
69 "labelDtos": [
70 {
71 "createdBy": "string",
72 "lastModifiedBy": "string",
73 "createdDate": "2019-08-24T14:15:22Z",
74 "lastModifiedDate": "2019-08-24T14:15:22Z",
75 "archived": true,
76 "externalId": "string",
77 "id": 0,
78 "cultureId": 0,
79 "value": "string"
80 }
81 ]
82 },
83 "projectType": {
84 "createdBy": "string",
85 "lastModifiedBy": "string",
86 "createdDate": "2019-08-24T14:15:22Z",
87 "lastModifiedDate": "2019-08-24T14:15:22Z",
88 "archived": true,
89 "externalId": "string",
90 "id": 0,
91 "priority": 0,
92 "internalId": 0,
93 "pickListCode": "string",
94 "pickListLabel": "string",
95 "label": "string",
96 "cultureId": 0,
97 "labelDtos": [
98 {
99 "createdBy": "string",
100 "lastModifiedBy": "string",
101 "createdDate": "2019-08-24T14:15:22Z",
102 "lastModifiedDate": "2019-08-24T14:15:22Z",
103 "archived": true,
104 "externalId": "string",
105 "id": 0,
106 "cultureId": 0,
107 "value": "string"
108 }
109 ]
110 },
111 "projectPriority": {
112 "createdBy": "string",
113 "lastModifiedBy": "string",
114 "createdDate": "2019-08-24T14:15:22Z",
115 "lastModifiedDate": "2019-08-24T14:15:22Z",
116 "archived": true,
117 "externalId": "string",
118 "id": 0,
119 "priority": 0,
120 "internalId": 0,
121 "pickListCode": "string",
122 "pickListLabel": "string",
123 "label": "string",
124 "cultureId": 0,
125 "labelDtos": [
126 {
127 "createdBy": "string",
128 "lastModifiedBy": "string",
129 "createdDate": "2019-08-24T14:15:22Z",
130 "lastModifiedDate": "2019-08-24T14:15:22Z",
131 "archived": true,
132 "externalId": "string",
133 "id": 0,
134 "cultureId": 0,
135 "value": "string"
136 }
137 ]
138 },
139 "projectPrivacy": {
140 "createdBy": "string",
141 "lastModifiedBy": "string",
142 "createdDate": "2019-08-24T14:15:22Z",
143 "lastModifiedDate": "2019-08-24T14:15:22Z",
144 "archived": true,
145 "externalId": "string",
146 "id": 0,
147 "priority": 0,
148 "internalId": 0,
149 "pickListCode": "string",
150 "pickListLabel": "string",
151 "label": "string",
152 "cultureId": 0,
153 "labelDtos": [
154 {
155 "createdBy": "string",
156 "lastModifiedBy": "string",
157 "createdDate": "2019-08-24T14:15:22Z",
158 "lastModifiedDate": "2019-08-24T14:15:22Z",
159 "archived": true,
160 "externalId": "string",
161 "id": 0,
162 "cultureId": 0,
163 "value": "string"
164 }
165 ]
166 },
167 "progressStatus": {
168 "createdBy": "string",
169 "lastModifiedBy": "string",
170 "createdDate": "2019-08-24T14:15:22Z",
171 "lastModifiedDate": "2019-08-24T14:15:22Z",
172 "archived": true,
173 "externalId": "string",
174 "id": 0,
175 "priority": 0,
176 "internalId": 0,
177 "pickListCode": "string",
178 "pickListLabel": "string",
179 "label": "string",
180 "cultureId": 0,
181 "labelDtos": [
182 {
183 "createdBy": "string",
184 "lastModifiedBy": "string",
185 "createdDate": "2019-08-24T14:15:22Z",
186 "lastModifiedDate": "2019-08-24T14:15:22Z",
187 "archived": true,
188 "externalId": "string",
189 "id": 0,
190 "cultureId": 0,
191 "value": "string"
192 }
193 ]
194 },
195 "projectStatus": {
196 "createdBy": "string",
197 "lastModifiedBy": "string",
198 "createdDate": "2019-08-24T14:15:22Z",
199 "lastModifiedDate": "2019-08-24T14:15:22Z",
200 "archived": true,
201 "externalId": "string",
202 "id": 0,
203 "priority": 0,
204 "internalId": 0,
205 "pickListCode": "string",
206 "pickListLabel": "string",
207 "label": "string",
208 "cultureId": 0,
209 "labelDtos": [
210 {
211 "createdBy": "string",
212 "lastModifiedBy": "string",
213 "createdDate": "2019-08-24T14:15:22Z",
214 "lastModifiedDate": "2019-08-24T14:15:22Z",
215 "archived": true,
216 "externalId": "string",
217 "id": 0,
218 "cultureId": 0,
219 "value": "string"
220 }
221 ]
222 },
223 "projectManager": "string",
224 "milestonesIds": [
225 0
226 ],
227 "siteIds": [
228 0
229 ]
230}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Project - Bulk Archive Project¶
HTTP Request
POST /api/projects/bulk-archive
📋 Description: Archives multiple projects in bulk within the Nakisa Portfolio Management Suite, streamlining the management of portfolio assets and enhancing analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of project identifiers and associated metadata for bulk archiving within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 0
3]
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 "name": "string",
11 "description": "string",
12 "targetDate": "2019-08-24",
13 "startDate": "2019-08-24",
14 "dueDate": "2019-08-24",
15 "possessionDate": "2019-08-24",
16 "projectTargetTypeId": 0,
17 "projectActivityId": 0,
18 "projectTypeId": 0,
19 "projectPriorityId": 0,
20 "projectPrivacyId": 0,
21 "projectStatusId": 0,
22 "progressStatusId": 0,
23 "projectManagerId": 0,
24 "taskEmailSendDate": "2019-08-24",
25 "copyMilestoneDate": true,
26 "isTemplate": true,
27 "isPrefilled": true,
28 "projectActivity": {
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 "projectTargetType": {
57 "createdBy": "string",
58 "lastModifiedBy": "string",
59 "createdDate": "2019-08-24T14:15:22Z",
60 "lastModifiedDate": "2019-08-24T14:15:22Z",
61 "archived": true,
62 "externalId": "string",
63 "id": 0,
64 "priority": 0,
65 "internalId": 0,
66 "pickListCode": "string",
67 "pickListLabel": "string",
68 "label": "string",
69 "cultureId": 0,
70 "labelDtos": [
71 {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "cultureId": 0,
80 "value": "string"
81 }
82 ]
83 },
84 "projectType": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "projectPriority": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "projectPrivacy": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "progressStatus": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "projectStatus": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "projectManager": "string",
225 "milestonesIds": [
226 0
227 ],
228 "siteIds": [
229 0
230 ]
231 }
232]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a project within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset allocation, analytics, and 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 |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» targetDate |
string(date) |
false |
none |
Date of the target |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» possessionDate |
string(date) |
false |
none |
Date of the possession |
» projectTargetTypeId |
integer(int64) |
false |
none |
Unique identifier for the project target type |
» projectActivityId |
integer(int64) |
false |
none |
Unique identifier for the project activity |
» projectTypeId |
integer(int64) |
false |
none |
Unique identifier for the project type |
» projectPriorityId |
integer(int64) |
false |
none |
Unique identifier for the project priority |
» projectPrivacyId |
integer(int64) |
false |
none |
Unique identifier for the project privacy |
» projectStatusId |
integer(int64) |
false |
none |
Unique identifier for the project status |
» progressStatusId |
integer(int64) |
false |
none |
Unique identifier for the progress status |
» projectManagerId |
integer(int64) |
false |
none |
Unique identifier for the project manager |
» taskEmailSendDate |
string(date) |
false |
none |
Date of the task email send |
» copyMilestoneDate |
boolean |
false |
none |
Date of the copy milestone |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» isPrefilled |
boolean |
false |
none |
Whether the resource is prefilled |
» projectActivity |
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. |
» projectTargetType |
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. |
|
» projectType |
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. |
|
» projectPriority |
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. |
|
» projectPrivacy |
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. |
|
» progressStatus |
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. |
|
» projectStatus |
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. |
|
» projectManager |
string |
false |
none |
Name of the individual responsible for overseeing the project within the Nakisa Portfolio Management Suite, essential for effective portfolio and asset management in real estate analytics. |
» milestonesIds |
[integer] |
false |
none |
List of milestonesIds items |
» siteIds |
[integer] |
false |
none |
List of siteIds items |
Project - Get Image¶
HTTP Request
GET /api/projects/{projectId}/pictures/{pictureId}/download
📋 Description: Downloads the specified picture associated with a project, enabling users to access visual assets for enhanced portfolio and asset management within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Project - Get Notes For Project¶
HTTP Request
GET /api/projects/{id}/notes
📋 Description: Retrieves notes associated with a specific project within the Nakisa Portfolio Management Suite, facilitating enhanced asset and portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the notes associated with a specific project 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 project 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 project, providing insights relevant to portfolio management and asset 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}
Project - Get All Milestones By Project¶
HTTP Request
GET /api/projects/{id}/milestones
📋 Description: Fetches the milestones associated with a specific project, enabling users to track progress and manage deliverables 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 |
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 "name": "string",
11 "description": "string",
12 "wbs": 0,
13 "percProject": 0,
14 "startDate": "2019-08-24",
15 "targetDate": "2019-08-24",
16 "baselineTargetDate": "2019-08-24",
17 "dateActualized": "2019-08-24",
18 "scheduleFrom": "2019-08-24",
19 "noOfDaysToSchedule": 0,
20 "milestoneTypeId": 0,
21 "statusId": 0,
22 "approverId": 0,
23 "approvalStatusId": 0,
24 "approvalDate": "2019-08-24",
25 "isTemplate": true,
26 "isAiGenerated": true,
27 "projectId": 0,
28 "milestoneTemplateId": 0,
29 "milestoneType": {
30 "createdBy": "string",
31 "lastModifiedBy": "string",
32 "createdDate": "2019-08-24T14:15:22Z",
33 "lastModifiedDate": "2019-08-24T14:15:22Z",
34 "archived": true,
35 "externalId": "string",
36 "id": 0,
37 "priority": 0,
38 "internalId": 0,
39 "pickListCode": "string",
40 "pickListLabel": "string",
41 "label": "string",
42 "cultureId": 0,
43 "labelDtos": [
44 {
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 "cultureId": 0,
53 "value": "string"
54 }
55 ]
56 },
57 "status": {
58 "createdBy": "string",
59 "lastModifiedBy": "string",
60 "createdDate": "2019-08-24T14:15:22Z",
61 "lastModifiedDate": "2019-08-24T14:15:22Z",
62 "archived": true,
63 "externalId": "string",
64 "id": 0,
65 "priority": 0,
66 "internalId": 0,
67 "pickListCode": "string",
68 "pickListLabel": "string",
69 "label": "string",
70 "cultureId": 0,
71 "labelDtos": [
72 {
73 "createdBy": "string",
74 "lastModifiedBy": "string",
75 "createdDate": "2019-08-24T14:15:22Z",
76 "lastModifiedDate": "2019-08-24T14:15:22Z",
77 "archived": true,
78 "externalId": "string",
79 "id": 0,
80 "cultureId": 0,
81 "value": "string"
82 }
83 ]
84 },
85 "approvalStatus": {
86 "createdBy": "string",
87 "lastModifiedBy": "string",
88 "createdDate": "2019-08-24T14:15:22Z",
89 "lastModifiedDate": "2019-08-24T14:15:22Z",
90 "archived": true,
91 "externalId": "string",
92 "id": 0,
93 "priority": 0,
94 "internalId": 0,
95 "pickListCode": "string",
96 "pickListLabel": "string",
97 "label": "string",
98 "cultureId": 0,
99 "labelDtos": [
100 {
101 "createdBy": "string",
102 "lastModifiedBy": "string",
103 "createdDate": "2019-08-24T14:15:22Z",
104 "lastModifiedDate": "2019-08-24T14:15:22Z",
105 "archived": true,
106 "externalId": "string",
107 "id": 0,
108 "cultureId": 0,
109 "value": "string"
110 }
111 ]
112 },
113 "approver": {
114 "createdBy": "string",
115 "lastModifiedBy": "string",
116 "createdDate": "2019-08-24T14:15:22Z",
117 "lastModifiedDate": "2019-08-24T14:15:22Z",
118 "archived": true,
119 "externalId": "string",
120 "id": 0,
121 "email": "string",
122 "userName": "string",
123 "firstName": "string",
124 "lastName": "string",
125 "displayName": "string",
126 "permissions": "string",
127 "internalId": "string",
128 "preferredCulture": {
129 "createdBy": "string",
130 "lastModifiedBy": "string",
131 "createdDate": "2019-08-24T14:15:22Z",
132 "lastModifiedDate": "2019-08-24T14:15:22Z",
133 "archived": true,
134 "externalId": "string",
135 "id": 0,
136 "name": "string",
137 "code": "string",
138 "defaultCulture": true,
139 "enable": true
140 },
141 "userGroups": [
142 {
143 "createdBy": "string",
144 "lastModifiedBy": "string",
145 "createdDate": "2019-08-24T14:15:22Z",
146 "lastModifiedDate": "2019-08-24T14:15:22Z",
147 "archived": true,
148 "externalId": "string",
149 "id": 0,
150 "name": "string",
151 "description": "string",
152 "internalId": "string"
153 }
154 ],
155 "partnerIds": [
156 0
157 ],
158 "partners": [
159 {
160 "id": 0,
161 "status": "CREATED",
162 "displayId": "string",
163 "erpSystemId": 0,
164 "erpSystemDisplayId": "string",
165 "name": "string",
166 "fax": "string",
167 "phone": "string",
168 "parentId": 0,
169 "parentName": "string",
170 "parentDisplayId": "string",
171 "companyId": 0,
172 "partnerRoleId": 0,
173 "partnerContactId": 0
174 }
175 ]
176 },
177 "milestoneTasksIds": [
178 0
179 ],
180 "milestoneTasksDTO": [
181 {
182 "createdBy": "string",
183 "lastModifiedBy": "string",
184 "createdDate": "2019-08-24T14:15:22Z",
185 "lastModifiedDate": "2019-08-24T14:15:22Z",
186 "archived": true,
187 "externalId": "string",
188 "id": 0,
189 "name": "string",
190 "description": "string",
191 "wbs": 0,
192 "startDate": "2019-08-24",
193 "targetDate": "2019-08-24",
194 "statusId": 0,
195 "assigneeId": 0,
196 "assigneeCanModify": true,
197 "notificationTypeId": 0,
198 "triggerId": 0,
199 "statusOfTriggerId": 0,
200 "emailSendDate": "2019-08-24",
201 "lastEmailSent": "2019-08-24",
202 "isEmailAcknowledged": true,
203 "nbEmailSent": 0,
204 "milestoneTaskKeywordId": 0,
205 "milestoneTaskKeywordValue": "string",
206 "approverId": 0,
207 "approvalStatusId": 0,
208 "refernceTaskId": 0,
209 "approvalDate": "2019-08-24",
210 "nrmWorkOrderId": 0,
211 "nrmWorkOrderDisplayId": "string",
212 "milestoneId": 0,
213 "assignee": {
214 "createdBy": "string",
215 "lastModifiedBy": "string",
216 "createdDate": "2019-08-24T14:15:22Z",
217 "lastModifiedDate": "2019-08-24T14:15:22Z",
218 "archived": true,
219 "externalId": "string",
220 "id": 0,
221 "email": "string",
222 "userName": "string",
223 "firstName": "string",
224 "lastName": "string",
225 "displayName": "string",
226 "permissions": "string",
227 "internalId": "string",
228 "preferredCulture": {
229 "createdBy": "string",
230 "lastModifiedBy": "string",
231 "createdDate": "2019-08-24T14:15:22Z",
232 "lastModifiedDate": "2019-08-24T14:15:22Z",
233 "archived": true,
234 "externalId": "string",
235 "id": 0,
236 "name": "string",
237 "code": "string",
238 "defaultCulture": true,
239 "enable": true
240 },
241 "userGroups": [
242 {
243 "createdBy": "string",
244 "lastModifiedBy": "string",
245 "createdDate": "2019-08-24T14:15:22Z",
246 "lastModifiedDate": "2019-08-24T14:15:22Z",
247 "archived": true,
248 "externalId": "string",
249 "id": 0,
250 "name": "string",
251 "description": "string",
252 "internalId": "string"
253 }
254 ],
255 "partnerIds": [
256 0
257 ],
258 "partners": [
259 {
260 "id": 0,
261 "status": "CREATED",
262 "displayId": "string",
263 "erpSystemId": 0,
264 "erpSystemDisplayId": "string",
265 "name": "string",
266 "fax": "string",
267 "phone": "string",
268 "parentId": 0,
269 "parentName": "string",
270 "parentDisplayId": "string",
271 "companyId": 0,
272 "partnerRoleId": 0,
273 "partnerContactId": 0
274 }
275 ]
276 },
277 "trigger": {},
278 "statusOfTrigger": {
279 "createdBy": "string",
280 "lastModifiedBy": "string",
281 "createdDate": "2019-08-24T14:15:22Z",
282 "lastModifiedDate": "2019-08-24T14:15:22Z",
283 "archived": true,
284 "externalId": "string",
285 "id": 0,
286 "priority": 0,
287 "internalId": 0,
288 "pickListCode": "string",
289 "pickListLabel": "string",
290 "label": "string",
291 "cultureId": 0,
292 "labelDtos": [
293 {
294 "createdBy": "string",
295 "lastModifiedBy": "string",
296 "createdDate": "2019-08-24T14:15:22Z",
297 "lastModifiedDate": "2019-08-24T14:15:22Z",
298 "archived": true,
299 "externalId": "string",
300 "id": 0,
301 "cultureId": 0,
302 "value": "string"
303 }
304 ]
305 },
306 "milestoneTaskKeyword": {
307 "createdBy": "string",
308 "lastModifiedBy": "string",
309 "createdDate": "2019-08-24T14:15:22Z",
310 "lastModifiedDate": "2019-08-24T14:15:22Z",
311 "archived": true,
312 "externalId": "string",
313 "id": 0,
314 "priority": 0,
315 "internalId": 0,
316 "pickListCode": "string",
317 "pickListLabel": "string",
318 "label": "string",
319 "cultureId": 0,
320 "labelDtos": [
321 {
322 "createdBy": "string",
323 "lastModifiedBy": "string",
324 "createdDate": "2019-08-24T14:15:22Z",
325 "lastModifiedDate": "2019-08-24T14:15:22Z",
326 "archived": true,
327 "externalId": "string",
328 "id": 0,
329 "cultureId": 0,
330 "value": "string"
331 }
332 ]
333 },
334 "status": {
335 "createdBy": "string",
336 "lastModifiedBy": "string",
337 "createdDate": "2019-08-24T14:15:22Z",
338 "lastModifiedDate": "2019-08-24T14:15:22Z",
339 "archived": true,
340 "externalId": "string",
341 "id": 0,
342 "priority": 0,
343 "internalId": 0,
344 "pickListCode": "string",
345 "pickListLabel": "string",
346 "label": "string",
347 "cultureId": 0,
348 "labelDtos": [
349 {
350 "createdBy": "string",
351 "lastModifiedBy": "string",
352 "createdDate": "2019-08-24T14:15:22Z",
353 "lastModifiedDate": "2019-08-24T14:15:22Z",
354 "archived": true,
355 "externalId": "string",
356 "id": 0,
357 "cultureId": 0,
358 "value": "string"
359 }
360 ]
361 },
362 "approvalStatus": {
363 "createdBy": "string",
364 "lastModifiedBy": "string",
365 "createdDate": "2019-08-24T14:15:22Z",
366 "lastModifiedDate": "2019-08-24T14:15:22Z",
367 "archived": true,
368 "externalId": "string",
369 "id": 0,
370 "priority": 0,
371 "internalId": 0,
372 "pickListCode": "string",
373 "pickListLabel": "string",
374 "label": "string",
375 "cultureId": 0,
376 "labelDtos": [
377 {
378 "createdBy": "string",
379 "lastModifiedBy": "string",
380 "createdDate": "2019-08-24T14:15:22Z",
381 "lastModifiedDate": "2019-08-24T14:15:22Z",
382 "archived": true,
383 "externalId": "string",
384 "id": 0,
385 "cultureId": 0,
386 "value": "string"
387 }
388 ]
389 },
390 "notificationType": {
391 "createdBy": "string",
392 "lastModifiedBy": "string",
393 "createdDate": "2019-08-24T14:15:22Z",
394 "lastModifiedDate": "2019-08-24T14:15:22Z",
395 "archived": true,
396 "externalId": "string",
397 "id": 0,
398 "priority": 0,
399 "internalId": 0,
400 "pickListCode": "string",
401 "pickListLabel": "string",
402 "label": "string",
403 "cultureId": 0,
404 "labelDtos": [
405 {
406 "createdBy": "string",
407 "lastModifiedBy": "string",
408 "createdDate": "2019-08-24T14:15:22Z",
409 "lastModifiedDate": "2019-08-24T14:15:22Z",
410 "archived": true,
411 "externalId": "string",
412 "id": 0,
413 "cultureId": 0,
414 "value": "string"
415 }
416 ]
417 },
418 "approver": {
419 "createdBy": "string",
420 "lastModifiedBy": "string",
421 "createdDate": "2019-08-24T14:15:22Z",
422 "lastModifiedDate": "2019-08-24T14:15:22Z",
423 "archived": true,
424 "externalId": "string",
425 "id": 0,
426 "email": "string",
427 "userName": "string",
428 "firstName": "string",
429 "lastName": "string",
430 "displayName": "string",
431 "permissions": "string",
432 "internalId": "string",
433 "preferredCulture": {
434 "createdBy": "string",
435 "lastModifiedBy": "string",
436 "createdDate": "2019-08-24T14:15:22Z",
437 "lastModifiedDate": "2019-08-24T14:15:22Z",
438 "archived": true,
439 "externalId": "string",
440 "id": 0,
441 "name": "string",
442 "code": "string",
443 "defaultCulture": true,
444 "enable": true
445 },
446 "userGroups": [
447 {
448 "createdBy": "string",
449 "lastModifiedBy": "string",
450 "createdDate": "2019-08-24T14:15:22Z",
451 "lastModifiedDate": "2019-08-24T14:15:22Z",
452 "archived": true,
453 "externalId": "string",
454 "id": 0,
455 "name": "string",
456 "description": "string",
457 "internalId": "string"
458 }
459 ],
460 "partnerIds": [
461 0
462 ],
463 "partners": [
464 {
465 "id": 0,
466 "status": "CREATED",
467 "displayId": "string",
468 "erpSystemId": 0,
469 "erpSystemDisplayId": "string",
470 "name": "string",
471 "fax": "string",
472 "phone": "string",
473 "parentId": 0,
474 "parentName": "string",
475 "parentDisplayId": "string",
476 "companyId": 0,
477 "partnerRoleId": 0,
478 "partnerContactId": 0
479 }
480 ]
481 }
482 }
483 ]
484 }
485]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a milestone within the Nakisa Portfolio Management Suite, encapsulating key information related to portfolio, asset, and real estate property analytics.] |
|
» 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 |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» wbs |
integer(int32) |
false |
none |
Numeric value representing wbs |
» percProject |
integer(int32) |
false |
none |
Numeric value representing percProject |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» targetDate |
string(date) |
false |
none |
Date of the target |
» baselineTargetDate |
string(date) |
false |
none |
Date of the baseline target |
» dateActualized |
string(date) |
false |
none |
Represents the date on which the milestone was last updated, providing essential context for portfolio and asset management within the Nakisa Portfolio Management Suite. |
» scheduleFrom |
string(date) |
false |
none |
Specifies the starting date and time for the scheduled milestone within the Nakisa Portfolio Management Suite, essential for effective portfolio and asset management in real estate analytics. |
» noOfDaysToSchedule |
integer(int32) |
false |
none |
Numeric value representing noOfDaysToSchedule |
» milestoneTypeId |
integer(int64) |
false |
none |
Unique identifier for the milestone type |
» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
» approverId |
integer(int64) |
false |
none |
Unique identifier for the approver |
» approvalStatusId |
integer(int64) |
false |
none |
Unique identifier for the approval status |
» approvalDate |
string(date) |
false |
none |
Date of the approval |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» isAiGenerated |
boolean |
false |
none |
Whether the resource is ai generated |
» projectId |
integer(int64) |
false |
none |
Unique identifier for the project |
» milestoneTemplateId |
integer(int64) |
false |
none |
Unique identifier for the milestone template |
» milestoneType |
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. |
» status |
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. |
|
» approvalStatus |
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. |
|
» approver |
false |
none |
Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions related to 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 |
string |
true |
none |
Email address of the user, utilized for communication and notifications related to portfolio, asset, and analytics management within the Nakisa Portfolio Management Suite. |
|
»» userName |
string |
true |
none |
Name of the user |
»» firstName |
string |
true |
none |
Name of the first |
»» lastName |
string |
true |
none |
Name of the last |
»» displayName |
string |
false |
none |
Display name for user interface |
»» permissions |
string |
false |
none |
Specifies the access rights assigned to a user within the Nakisa Portfolio Management Suite, governing their interactions with portfolio, asset, analytics, and real estate property data. |
»» internalId |
string |
false |
none |
Unique identifier for the internal |
»» preferredCulture |
false |
none |
Data transfer object representing cultural attributes and insights related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating informed decision-making in real estate property analytics. |
|
»»» 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 |
»»» name |
string |
false |
none |
Name of the resource |
»»» code |
string |
false |
none |
Code identifier for the resource |
»»» defaultCulture |
boolean |
false |
none |
Boolean flag indicating defaultCulture status |
»»» enable |
boolean |
false |
none |
Boolean flag indicating enable status |
»» userGroups |
false |
none |
User information related to portfolio 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 |
»»» name |
string |
true |
none |
Name of the resource |
»»» description |
string |
false |
none |
Description of the resource |
»»» internalId |
string |
false |
none |
Unique identifier for the internal |
»» partnerIds |
[integer] |
false |
none |
List of partnerIds items |
»» partners |
false |
none |
List of partners items |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» status |
string |
false |
none |
Status of the resource |
»»» displayId |
string |
true |
none |
Unique identifier for the display |
»»» erpSystemId |
integer(int64) |
false |
none |
Unique identifier for the erp system |
»»» erpSystemDisplayId |
string |
false |
none |
Unique identifier for the erp system display |
»»» name |
string |
false |
none |
Name of the resource |
»»» fax |
string |
false |
none |
Fax number associated with the partner, used for communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
»»» phone |
string |
false |
none |
Contact number for the partner associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
»»» parentId |
integer(int64) |
false |
none |
Unique identifier for the parent |
»»» parentName |
string |
false |
none |
Name of the parent |
»»» parentDisplayId |
string |
false |
none |
Unique identifier for the parent display |
»»» companyId |
integer(int64) |
false |
none |
Unique identifier for the company |
»»» partnerRoleId |
integer(int64) |
false |
none |
Unique identifier for the partner role |
»»» partnerContactId |
integer(int64) |
false |
none |
Unique identifier for the partner contact |
» milestoneTasksIds |
[integer] |
false |
none |
List of milestoneTasksIds items |
» milestoneTasksDTO |
false |
none |
List of milestoneTasksDTO 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 |
»» name |
string |
false |
none |
Name of the resource |
»» description |
string |
false |
none |
Description of the resource |
»» wbs |
integer(int32) |
false |
none |
Numeric value representing wbs |
»» startDate |
string(date) |
false |
none |
Start date of the resource |
»» targetDate |
string(date) |
false |
none |
Date of the target |
»» statusId |
integer(int64) |
false |
none |
Unique identifier for the status |
»» assigneeId |
integer(int64) |
false |
none |
Unique identifier for the assignee |
»» assigneeCanModify |
boolean |
false |
none |
Boolean flag indicating assigneeCanModify status |
»» notificationTypeId |
integer(int64) |
false |
none |
Unique identifier for the notification type |
»» triggerId |
integer(int64) |
false |
none |
Unique identifier for the trigger |
»» statusOfTriggerId |
integer(int64) |
false |
none |
Unique identifier for the status of trigger |
»» emailSendDate |
string(date) |
false |
none |
Date of the email send |
»» lastEmailSent |
string(date) |
false |
none |
Timestamp of the most recent email sent regarding the milestone task, providing insights into communication timelines within the portfolio management context. |
»» isEmailAcknowledged |
boolean |
false |
none |
Whether the resource is email acknowledged |
»» nbEmailSent |
integer(int32) |
false |
none |
Numeric value representing nbEmailSent |
»» milestoneTaskKeywordId |
integer(int64) |
false |
none |
Unique identifier for the milestone task keyword |
»» milestoneTaskKeywordValue |
string |
false |
none |
Represents the keyword value associated with a milestone task, facilitating enhanced categorization and analytics within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
»» approverId |
integer(int64) |
false |
none |
Unique identifier for the approver |
»» approvalStatusId |
integer(int64) |
false |
none |
Unique identifier for the approval status |
»» refernceTaskId |
integer(int64) |
false |
none |
Unique identifier for the refernce task |
»» approvalDate |
string(date) |
false |
none |
Date of the approval |
»» nrmWorkOrderId |
integer(int64) |
false |
none |
Unique identifier for the nrm work order |
»» nrmWorkOrderDisplayId |
string |
false |
none |
Unique identifier for the nrm work order display |
»» milestoneId |
integer(int64) |
false |
none |
Unique identifier for the milestone |
»» assignee |
false |
none |
Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions related to real estate properties. |
|
»» trigger |
false |
none |
Data transfer object representing a milestone task within the Nakisa Portfolio Management Suite, encapsulating key details related to portfolio management, asset tracking, and real estate property analytics. |
|
»» statusOfTrigger |
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. |
|
»» milestoneTaskKeyword |
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. |
|
»» status |
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. |
|
»» approvalStatus |
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. |
|
»» notificationType |
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. |
|
»» approver |
false |
none |
Data transfer object representing a user within the Nakisa Portfolio Management Suite, encapsulating essential information for managing portfolio, asset, and analytics interactions related to real estate properties. |
Enumerated Values
Attribute |
Value |
|---|---|
status |
ACTIVE, CREATED, DECOMMISSIONED, DISABLED |
Project - Get Comments For Project¶
HTTP Request
GET /api/projects/{id}/comments
📋 Description: Retrieves comments associated with a specific project within the Nakisa Portfolio Management Suite, enabling users to analyze stakeholder feedback and insights related to portfolio and asset management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
pageable |
query |
true |
Indicates whether the results of the comments associated with a specific project 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 comments related to a specific project within the Nakisa Portfolio Management Suite, enhancing analytics and insights for portfolio and asset management. |
message |
query |
string |
false |
Text content of the comment associated with a specific project, facilitating communication and collaboration within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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}
Project - Get Non Template Projects¶
HTTP Request
GET /api/projects/non-templates
📋 Description: Retrieves a list of non-template projects within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio assets effectively in the context of real estate property analytics.
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 "name": "string",
11 "description": "string",
12 "targetDate": "2019-08-24",
13 "startDate": "2019-08-24",
14 "dueDate": "2019-08-24",
15 "possessionDate": "2019-08-24",
16 "projectTargetTypeId": 0,
17 "projectActivityId": 0,
18 "projectTypeId": 0,
19 "projectPriorityId": 0,
20 "projectPrivacyId": 0,
21 "projectStatusId": 0,
22 "progressStatusId": 0,
23 "projectManagerId": 0,
24 "taskEmailSendDate": "2019-08-24",
25 "copyMilestoneDate": true,
26 "isTemplate": true,
27 "isPrefilled": true,
28 "projectActivity": {
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 "projectTargetType": {
57 "createdBy": "string",
58 "lastModifiedBy": "string",
59 "createdDate": "2019-08-24T14:15:22Z",
60 "lastModifiedDate": "2019-08-24T14:15:22Z",
61 "archived": true,
62 "externalId": "string",
63 "id": 0,
64 "priority": 0,
65 "internalId": 0,
66 "pickListCode": "string",
67 "pickListLabel": "string",
68 "label": "string",
69 "cultureId": 0,
70 "labelDtos": [
71 {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "cultureId": 0,
80 "value": "string"
81 }
82 ]
83 },
84 "projectType": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "projectPriority": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "projectPrivacy": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "progressStatus": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "projectStatus": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "projectManager": "string",
225 "milestonesIds": [
226 0
227 ],
228 "siteIds": [
229 0
230 ]
231 }
232]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a project within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset allocation, analytics, and 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 |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» targetDate |
string(date) |
false |
none |
Date of the target |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» possessionDate |
string(date) |
false |
none |
Date of the possession |
» projectTargetTypeId |
integer(int64) |
false |
none |
Unique identifier for the project target type |
» projectActivityId |
integer(int64) |
false |
none |
Unique identifier for the project activity |
» projectTypeId |
integer(int64) |
false |
none |
Unique identifier for the project type |
» projectPriorityId |
integer(int64) |
false |
none |
Unique identifier for the project priority |
» projectPrivacyId |
integer(int64) |
false |
none |
Unique identifier for the project privacy |
» projectStatusId |
integer(int64) |
false |
none |
Unique identifier for the project status |
» progressStatusId |
integer(int64) |
false |
none |
Unique identifier for the progress status |
» projectManagerId |
integer(int64) |
false |
none |
Unique identifier for the project manager |
» taskEmailSendDate |
string(date) |
false |
none |
Date of the task email send |
» copyMilestoneDate |
boolean |
false |
none |
Date of the copy milestone |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» isPrefilled |
boolean |
false |
none |
Whether the resource is prefilled |
» projectActivity |
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. |
» projectTargetType |
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. |
|
» projectType |
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. |
|
» projectPriority |
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. |
|
» projectPrivacy |
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. |
|
» progressStatus |
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. |
|
» projectStatus |
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. |
|
» projectManager |
string |
false |
none |
Name of the individual responsible for overseeing the project within the Nakisa Portfolio Management Suite, essential for effective portfolio and asset management in real estate analytics. |
» milestonesIds |
[integer] |
false |
none |
List of milestonesIds items |
» siteIds |
[integer] |
false |
none |
List of siteIds items |
Project - Get Projects By Budget¶
HTTP Request
GET /api/projects/budgets/{budgetId}
📋 Description: Fetches detailed budget information for a specific project within the Nakisa Portfolio Management Suite, enabling users to analyze financial allocations related to portfolio and asset management in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
budgetId |
path |
integer(int64) |
true |
Unique identifier for the budget |
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 "name": "string",
11 "description": "string",
12 "targetDate": "2019-08-24",
13 "startDate": "2019-08-24",
14 "dueDate": "2019-08-24",
15 "possessionDate": "2019-08-24",
16 "projectTargetTypeId": 0,
17 "projectActivityId": 0,
18 "projectTypeId": 0,
19 "projectPriorityId": 0,
20 "projectPrivacyId": 0,
21 "projectStatusId": 0,
22 "progressStatusId": 0,
23 "projectManagerId": 0,
24 "taskEmailSendDate": "2019-08-24",
25 "copyMilestoneDate": true,
26 "isTemplate": true,
27 "isPrefilled": true,
28 "projectActivity": {
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 "projectTargetType": {
57 "createdBy": "string",
58 "lastModifiedBy": "string",
59 "createdDate": "2019-08-24T14:15:22Z",
60 "lastModifiedDate": "2019-08-24T14:15:22Z",
61 "archived": true,
62 "externalId": "string",
63 "id": 0,
64 "priority": 0,
65 "internalId": 0,
66 "pickListCode": "string",
67 "pickListLabel": "string",
68 "label": "string",
69 "cultureId": 0,
70 "labelDtos": [
71 {
72 "createdBy": "string",
73 "lastModifiedBy": "string",
74 "createdDate": "2019-08-24T14:15:22Z",
75 "lastModifiedDate": "2019-08-24T14:15:22Z",
76 "archived": true,
77 "externalId": "string",
78 "id": 0,
79 "cultureId": 0,
80 "value": "string"
81 }
82 ]
83 },
84 "projectType": {
85 "createdBy": "string",
86 "lastModifiedBy": "string",
87 "createdDate": "2019-08-24T14:15:22Z",
88 "lastModifiedDate": "2019-08-24T14:15:22Z",
89 "archived": true,
90 "externalId": "string",
91 "id": 0,
92 "priority": 0,
93 "internalId": 0,
94 "pickListCode": "string",
95 "pickListLabel": "string",
96 "label": "string",
97 "cultureId": 0,
98 "labelDtos": [
99 {
100 "createdBy": "string",
101 "lastModifiedBy": "string",
102 "createdDate": "2019-08-24T14:15:22Z",
103 "lastModifiedDate": "2019-08-24T14:15:22Z",
104 "archived": true,
105 "externalId": "string",
106 "id": 0,
107 "cultureId": 0,
108 "value": "string"
109 }
110 ]
111 },
112 "projectPriority": {
113 "createdBy": "string",
114 "lastModifiedBy": "string",
115 "createdDate": "2019-08-24T14:15:22Z",
116 "lastModifiedDate": "2019-08-24T14:15:22Z",
117 "archived": true,
118 "externalId": "string",
119 "id": 0,
120 "priority": 0,
121 "internalId": 0,
122 "pickListCode": "string",
123 "pickListLabel": "string",
124 "label": "string",
125 "cultureId": 0,
126 "labelDtos": [
127 {
128 "createdBy": "string",
129 "lastModifiedBy": "string",
130 "createdDate": "2019-08-24T14:15:22Z",
131 "lastModifiedDate": "2019-08-24T14:15:22Z",
132 "archived": true,
133 "externalId": "string",
134 "id": 0,
135 "cultureId": 0,
136 "value": "string"
137 }
138 ]
139 },
140 "projectPrivacy": {
141 "createdBy": "string",
142 "lastModifiedBy": "string",
143 "createdDate": "2019-08-24T14:15:22Z",
144 "lastModifiedDate": "2019-08-24T14:15:22Z",
145 "archived": true,
146 "externalId": "string",
147 "id": 0,
148 "priority": 0,
149 "internalId": 0,
150 "pickListCode": "string",
151 "pickListLabel": "string",
152 "label": "string",
153 "cultureId": 0,
154 "labelDtos": [
155 {
156 "createdBy": "string",
157 "lastModifiedBy": "string",
158 "createdDate": "2019-08-24T14:15:22Z",
159 "lastModifiedDate": "2019-08-24T14:15:22Z",
160 "archived": true,
161 "externalId": "string",
162 "id": 0,
163 "cultureId": 0,
164 "value": "string"
165 }
166 ]
167 },
168 "progressStatus": {
169 "createdBy": "string",
170 "lastModifiedBy": "string",
171 "createdDate": "2019-08-24T14:15:22Z",
172 "lastModifiedDate": "2019-08-24T14:15:22Z",
173 "archived": true,
174 "externalId": "string",
175 "id": 0,
176 "priority": 0,
177 "internalId": 0,
178 "pickListCode": "string",
179 "pickListLabel": "string",
180 "label": "string",
181 "cultureId": 0,
182 "labelDtos": [
183 {
184 "createdBy": "string",
185 "lastModifiedBy": "string",
186 "createdDate": "2019-08-24T14:15:22Z",
187 "lastModifiedDate": "2019-08-24T14:15:22Z",
188 "archived": true,
189 "externalId": "string",
190 "id": 0,
191 "cultureId": 0,
192 "value": "string"
193 }
194 ]
195 },
196 "projectStatus": {
197 "createdBy": "string",
198 "lastModifiedBy": "string",
199 "createdDate": "2019-08-24T14:15:22Z",
200 "lastModifiedDate": "2019-08-24T14:15:22Z",
201 "archived": true,
202 "externalId": "string",
203 "id": 0,
204 "priority": 0,
205 "internalId": 0,
206 "pickListCode": "string",
207 "pickListLabel": "string",
208 "label": "string",
209 "cultureId": 0,
210 "labelDtos": [
211 {
212 "createdBy": "string",
213 "lastModifiedBy": "string",
214 "createdDate": "2019-08-24T14:15:22Z",
215 "lastModifiedDate": "2019-08-24T14:15:22Z",
216 "archived": true,
217 "externalId": "string",
218 "id": 0,
219 "cultureId": 0,
220 "value": "string"
221 }
222 ]
223 },
224 "projectManager": "string",
225 "milestonesIds": [
226 0
227 ],
228 "siteIds": [
229 0
230 ]
231 }
232]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a project within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio management, asset allocation, analytics, and 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 |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» targetDate |
string(date) |
false |
none |
Date of the target |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» dueDate |
string(date) |
false |
none |
Due date of the resource |
» possessionDate |
string(date) |
false |
none |
Date of the possession |
» projectTargetTypeId |
integer(int64) |
false |
none |
Unique identifier for the project target type |
» projectActivityId |
integer(int64) |
false |
none |
Unique identifier for the project activity |
» projectTypeId |
integer(int64) |
false |
none |
Unique identifier for the project type |
» projectPriorityId |
integer(int64) |
false |
none |
Unique identifier for the project priority |
» projectPrivacyId |
integer(int64) |
false |
none |
Unique identifier for the project privacy |
» projectStatusId |
integer(int64) |
false |
none |
Unique identifier for the project status |
» progressStatusId |
integer(int64) |
false |
none |
Unique identifier for the progress status |
» projectManagerId |
integer(int64) |
false |
none |
Unique identifier for the project manager |
» taskEmailSendDate |
string(date) |
false |
none |
Date of the task email send |
» copyMilestoneDate |
boolean |
false |
none |
Date of the copy milestone |
» isTemplate |
boolean |
false |
none |
Whether the resource is template |
» isPrefilled |
boolean |
false |
none |
Whether the resource is prefilled |
» projectActivity |
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. |
» projectTargetType |
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. |
|
» projectType |
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. |
|
» projectPriority |
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. |
|
» projectPrivacy |
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. |
|
» progressStatus |
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. |
|
» projectStatus |
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. |
|
» projectManager |
string |
false |
none |
Name of the individual responsible for overseeing the project within the Nakisa Portfolio Management Suite, essential for effective portfolio and asset management in real estate analytics. |
» milestonesIds |
[integer] |
false |
none |
List of milestonesIds items |
» siteIds |
[integer] |
false |
none |
List of siteIds items |
Project - Delete Location Picture¶
HTTP Request
DELETE /api/projects/{projectId}/pictures/{pictureId}
📋 Description: Deletes a specified picture associated with a project in the Nakisa Portfolio Management Suite, facilitating effective asset management and portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
pictureId |
path |
integer(int64) |
true |
Unique identifier for the picture |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |