Project Template¶
Update Project Template¶
HTTP Request
PUT /api/project-templates/{id}
📋 Description: Updates the specified project template within the Nakisa Portfolio Management Suite, enabling users to modify essential attributes related to portfolio management, asset tracking, and real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated project template data, including portfolio details, asset specifications, and analytics parameters relevant to real estate property management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "label": "string",
10 "cultureId": 0,
11 "projectId": 0,
12 "isPrefilled": true,
13 "labelDtos": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "cultureId": 0,
23 "value": "string"
24 }
25 ]
26}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Project Template¶
HTTP Request
DELETE /api/project-templates/{id}
📋 Description: Deletes a specified project template from the Nakisa Portfolio Management Suite, facilitating streamlined portfolio management and asset analytics within real estate property projects.
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 |
Get Project Templates¶
HTTP Request
GET /api/project-templates
📋 Description: Retrieves a list of project templates available within the Nakisa Portfolio Management Suite, enabling users to streamline portfolio and asset management processes in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the project templates retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
|
listing |
query |
boolean |
false |
Indicates whether to include detailed listings of project templates relevant to portfolio and asset management within the Nakisa Portfolio Management Suite. |
project-id |
query |
string |
false |
Unique identifier for the project template within the Nakisa Portfolio Management Suite, facilitating access to relevant portfolio, asset, and analytics data for real estate properties. |
project-type-id-in |
query |
string |
false |
Specifies the unique identifier for the project type, enabling retrieval of relevant project templates within the Nakisa Portfolio Management Suite, particularly for portfolio, asset, analytics, and real estate property contexts. |
label-id |
query |
string |
false |
Unique identifier for the project template, enabling targeted retrieval of specific templates within the Nakisa Portfolio Management Suite for effective portfolio and asset management. |
prefilled |
query |
string |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "projectTemplates": [
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 "label": "string",
13 "cultureId": 0,
14 "projectId": 0,
15 "isPrefilled": true,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30 ]
31 },
32 "page": {
33 "size": 0,
34 "totalElements": 0,
35 "totalPages": 0,
36 "number": 0
37 }
38}
Create Project Template¶
HTTP Request
POST /api/project-templates
📋 Description: Creates a new project template within the Nakisa Portfolio Management Suite, enabling users to standardize portfolio, asset, and analytics management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the project template data, including attributes related to portfolio management, asset allocation, and real estate property analytics. |
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 "label": "string",
10 "cultureId": 0,
11 "projectId": 0,
12 "isPrefilled": true,
13 "labelDtos": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "cultureId": 0,
23 "value": "string"
24 }
25 ]
26}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Create Prefilled Project Templates¶
HTTP Request
POST /api/project-templates/prefilled
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Duplicate Project Template¶
HTTP Request
POST /api/project-templates/duplicate/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Get Project Template By Project ID¶
HTTP Request
GET /api/project-templates/projects/{projectId}
📋 Description: Retrieves detailed information about a specific project template within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio assets effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
projectId |
path |
integer(int64) |
true |
Unique identifier for the project |
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 "label": "string",
10 "cultureId": 0,
11 "projectId": 0,
12 "isPrefilled": true,
13 "labelDtos": [
14 {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "cultureId": 0,
23 "value": "string"
24 }
25 ]
26}