Project Modifier

Project Modifier - Create Project Modifier

HTTP Request

POST /api/project-modifiers

📋 Description: Creates new project modifiers within the Nakisa Portfolio Management Suite, enabling enhanced analytics and management of real estate assets within a portfolio.

Parameters

Name

In

Type

Required

Description

body

body

ProjectModifierDto

true

Request body containing the project modifier details, including attributes related to portfolio management, asset adjustments, and analytics for real estate properties.

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  "project": {
 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    "description": "string",
 19    "targetDate": "2019-08-24",
 20    "startDate": "2019-08-24",
 21    "dueDate": "2019-08-24",
 22    "possessionDate": "2019-08-24",
 23    "projectTargetTypeId": 0,
 24    "projectActivityId": 0,
 25    "projectTypeId": 0,
 26    "projectItemId": 0,
 27    "projectExecutorTypeId": 0,
 28    "projectPriorityId": 0,
 29    "projectPrivacyId": 0,
 30    "projectStatusId": 0,
 31    "progressStatusId": 0,
 32    "projectManagerId": 0,
 33    "isTemplate": true,
 34    "budgetAmount": 0,
 35    "bufferAmount": 0,
 36    "milestone": [
 37      {
 38        "createdBy": "string",
 39        "lastModifiedBy": "string",
 40        "createdDate": "2019-08-24T14:15:22Z",
 41        "lastModifiedDate": "2019-08-24T14:15:22Z",
 42        "archived": true,
 43        "externalId": "string",
 44        "id": 0,
 45        "name": "string",
 46        "description": "string",
 47        "wbs": 0,
 48        "percProject": 0,
 49        "startDate": "2019-08-24",
 50        "targetDate": "2019-08-24",
 51        "baselineTargetDate": "2019-08-24",
 52        "dateActualized": "2019-08-24",
 53        "scheduleFrom": "2019-08-24",
 54        "noOfDaysToSchedule": 0,
 55        "milestoneTypeId": 0,
 56        "statusId": 0,
 57        "approverId": 0,
 58        "approvalStatusId": 0,
 59        "approvalDate": "2019-08-24",
 60        "isTemplate": true,
 61        "milestoneTasks": [
 62          {
 63            "createdBy": "string",
 64            "lastModifiedBy": "string",
 65            "createdDate": "2019-08-24T14:15:22Z",
 66            "lastModifiedDate": "2019-08-24T14:15:22Z",
 67            "archived": true,
 68            "externalId": "string",
 69            "id": 0,
 70            "name": "string",
 71            "description": "string",
 72            "wbs": 0,
 73            "startDate": "2019-08-24",
 74            "targetDate": "2019-08-24",
 75            "statusId": 0,
 76            "assigneeId": 0,
 77            "assigneeCanModify": true,
 78            "notificationTypeId": 0,
 79            "triggerId": 0,
 80            "statusOfTriggerId": 0,
 81            "emailSendDate": "2019-08-24",
 82            "lastEmailSent": "2019-08-24",
 83            "isEmailAcknowledged": true,
 84            "nbEmailSent": 0,
 85            "milestoneTaskKeywordId": 0,
 86            "milestoneTaskKeywordValue": "string",
 87            "approverId": 0,
 88            "approvalStatusId": 0,
 89            "refernceTaskId": 0,
 90            "nrmWorkOrderId": 0,
 91            "nrmWorkOrderDisplayId": "string",
 92            "approvalDate": "2019-08-24",
 93            "milestoneTaskCost": {
 94              "createdBy": "string",
 95              "lastModifiedBy": "string",
 96              "createdDate": "2019-08-24T14:15:22Z",
 97              "lastModifiedDate": "2019-08-24T14:15:22Z",
 98              "archived": true,
 99              "externalId": "string",
100              "id": 0,
101              "actual": 0,
102              "workOrderCost": 0
103            }
104          }
105        ],
106        "milestoneCost": {
107          "createdBy": "string",
108          "lastModifiedBy": "string",
109          "createdDate": "2019-08-24T14:15:22Z",
110          "lastModifiedDate": "2019-08-24T14:15:22Z",
111          "archived": true,
112          "externalId": "string",
113          "id": 0,
114          "sourceId": 0,
115          "estimated": 0,
116          "totalActual": 0
117        }
118      }
119    ],
120    "projectCost": {
121      "createdBy": "string",
122      "lastModifiedBy": "string",
123      "createdDate": "2019-08-24T14:15:22Z",
124      "lastModifiedDate": "2019-08-24T14:15:22Z",
125      "archived": true,
126      "externalId": "string",
127      "id": 0,
128      "totalBudget": 0,
129      "totalEstimated": 0,
130      "grandTotalActual": 0
131    }
132  },
133  "projectId": 0,
134  "userId": 0,
135  "userDto": {
136    "createdBy": "string",
137    "lastModifiedBy": "string",
138    "createdDate": "2019-08-24T14:15:22Z",
139    "lastModifiedDate": "2019-08-24T14:15:22Z",
140    "archived": true,
141    "externalId": "string",
142    "id": 0,
143    "email": "string",
144    "userName": "string",
145    "firstName": "string",
146    "lastName": "string",
147    "displayName": "string",
148    "permissions": "string",
149    "internalId": "string",
150    "preferredCulture": {
151      "createdBy": "string",
152      "lastModifiedBy": "string",
153      "createdDate": "2019-08-24T14:15:22Z",
154      "lastModifiedDate": "2019-08-24T14:15:22Z",
155      "archived": true,
156      "externalId": "string",
157      "id": 0,
158      "name": "string",
159      "code": "string",
160      "defaultCulture": true,
161      "enable": true
162    },
163    "userGroups": [
164      {
165        "createdBy": "string",
166        "lastModifiedBy": "string",
167        "createdDate": "2019-08-24T14:15:22Z",
168        "lastModifiedDate": "2019-08-24T14:15:22Z",
169        "archived": true,
170        "externalId": "string",
171        "id": 0,
172        "name": "string",
173        "description": "string",
174        "internalId": "string"
175      }
176    ],
177    "partnerIds": [
178      0
179    ],
180    "partners": [
181      {
182        "id": 0,
183        "status": "CREATED",
184        "displayId": "string",
185        "erpSystemId": 0,
186        "erpSystemDisplayId": "string",
187        "name": "string",
188        "fax": "string",
189        "phone": "string",
190        "parentId": 0,
191        "parentName": "string",
192        "parentDisplayId": "string",
193        "companyId": 0,
194        "partnerRoleId": 0,
195        "partnerContactId": 0
196      }
197    ]
198  }
199}

Responses

Status

Meaning

Description

Schema

201

Created

Created

None

Project Modifier - Get Project Modifier

HTTP Request

GET /api/project-modifiers/{id}

📋 Description: Retrieves detailed information about a specific project modifier within the Nakisa Portfolio Management Suite, enabling users to analyze its impact on portfolio performance and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ProjectModifierDto

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  "project": {
 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    "description": "string",
 19    "targetDate": "2019-08-24",
 20    "startDate": "2019-08-24",
 21    "dueDate": "2019-08-24",
 22    "possessionDate": "2019-08-24",
 23    "projectTargetTypeId": 0,
 24    "projectActivityId": 0,
 25    "projectTypeId": 0,
 26    "projectItemId": 0,
 27    "projectExecutorTypeId": 0,
 28    "projectPriorityId": 0,
 29    "projectPrivacyId": 0,
 30    "projectStatusId": 0,
 31    "progressStatusId": 0,
 32    "projectManagerId": 0,
 33    "isTemplate": true,
 34    "budgetAmount": 0,
 35    "bufferAmount": 0,
 36    "milestone": [
 37      {
 38        "createdBy": "string",
 39        "lastModifiedBy": "string",
 40        "createdDate": "2019-08-24T14:15:22Z",
 41        "lastModifiedDate": "2019-08-24T14:15:22Z",
 42        "archived": true,
 43        "externalId": "string",
 44        "id": 0,
 45        "name": "string",
 46        "description": "string",
 47        "wbs": 0,
 48        "percProject": 0,
 49        "startDate": "2019-08-24",
 50        "targetDate": "2019-08-24",
 51        "baselineTargetDate": "2019-08-24",
 52        "dateActualized": "2019-08-24",
 53        "scheduleFrom": "2019-08-24",
 54        "noOfDaysToSchedule": 0,
 55        "milestoneTypeId": 0,
 56        "statusId": 0,
 57        "approverId": 0,
 58        "approvalStatusId": 0,
 59        "approvalDate": "2019-08-24",
 60        "isTemplate": true,
 61        "milestoneTasks": [
 62          {
 63            "createdBy": "string",
 64            "lastModifiedBy": "string",
 65            "createdDate": "2019-08-24T14:15:22Z",
 66            "lastModifiedDate": "2019-08-24T14:15:22Z",
 67            "archived": true,
 68            "externalId": "string",
 69            "id": 0,
 70            "name": "string",
 71            "description": "string",
 72            "wbs": 0,
 73            "startDate": "2019-08-24",
 74            "targetDate": "2019-08-24",
 75            "statusId": 0,
 76            "assigneeId": 0,
 77            "assigneeCanModify": true,
 78            "notificationTypeId": 0,
 79            "triggerId": 0,
 80            "statusOfTriggerId": 0,
 81            "emailSendDate": "2019-08-24",
 82            "lastEmailSent": "2019-08-24",
 83            "isEmailAcknowledged": true,
 84            "nbEmailSent": 0,
 85            "milestoneTaskKeywordId": 0,
 86            "milestoneTaskKeywordValue": "string",
 87            "approverId": 0,
 88            "approvalStatusId": 0,
 89            "refernceTaskId": 0,
 90            "nrmWorkOrderId": 0,
 91            "nrmWorkOrderDisplayId": "string",
 92            "approvalDate": "2019-08-24",
 93            "milestoneTaskCost": {
 94              "createdBy": "string",
 95              "lastModifiedBy": "string",
 96              "createdDate": "2019-08-24T14:15:22Z",
 97              "lastModifiedDate": "2019-08-24T14:15:22Z",
 98              "archived": true,
 99              "externalId": "string",
100              "id": 0,
101              "actual": 0,
102              "workOrderCost": 0
103            }
104          }
105        ],
106        "milestoneCost": {
107          "createdBy": "string",
108          "lastModifiedBy": "string",
109          "createdDate": "2019-08-24T14:15:22Z",
110          "lastModifiedDate": "2019-08-24T14:15:22Z",
111          "archived": true,
112          "externalId": "string",
113          "id": 0,
114          "sourceId": 0,
115          "estimated": 0,
116          "totalActual": 0
117        }
118      }
119    ],
120    "projectCost": {
121      "createdBy": "string",
122      "lastModifiedBy": "string",
123      "createdDate": "2019-08-24T14:15:22Z",
124      "lastModifiedDate": "2019-08-24T14:15:22Z",
125      "archived": true,
126      "externalId": "string",
127      "id": 0,
128      "totalBudget": 0,
129      "totalEstimated": 0,
130      "grandTotalActual": 0
131    }
132  },
133  "projectId": 0,
134  "userId": 0,
135  "userDto": {
136    "createdBy": "string",
137    "lastModifiedBy": "string",
138    "createdDate": "2019-08-24T14:15:22Z",
139    "lastModifiedDate": "2019-08-24T14:15:22Z",
140    "archived": true,
141    "externalId": "string",
142    "id": 0,
143    "email": "string",
144    "userName": "string",
145    "firstName": "string",
146    "lastName": "string",
147    "displayName": "string",
148    "permissions": "string",
149    "internalId": "string",
150    "preferredCulture": {
151      "createdBy": "string",
152      "lastModifiedBy": "string",
153      "createdDate": "2019-08-24T14:15:22Z",
154      "lastModifiedDate": "2019-08-24T14:15:22Z",
155      "archived": true,
156      "externalId": "string",
157      "id": 0,
158      "name": "string",
159      "code": "string",
160      "defaultCulture": true,
161      "enable": true
162    },
163    "userGroups": [
164      {
165        "createdBy": "string",
166        "lastModifiedBy": "string",
167        "createdDate": "2019-08-24T14:15:22Z",
168        "lastModifiedDate": "2019-08-24T14:15:22Z",
169        "archived": true,
170        "externalId": "string",
171        "id": 0,
172        "name": "string",
173        "description": "string",
174        "internalId": "string"
175      }
176    ],
177    "partnerIds": [
178      0
179    ],
180    "partners": [
181      {
182        "id": 0,
183        "status": "CREATED",
184        "displayId": "string",
185        "erpSystemId": 0,
186        "erpSystemDisplayId": "string",
187        "name": "string",
188        "fax": "string",
189        "phone": "string",
190        "parentId": 0,
191        "parentName": "string",
192        "parentDisplayId": "string",
193        "companyId": 0,
194        "partnerRoleId": 0,
195        "partnerContactId": 0
196      }
197    ]
198  }
199}

Project Modifier - Delete Project Modifier

HTTP Request

DELETE /api/project-modifiers/{id}

📋 Description: Deletes a specified project modifier from the Nakisa Portfolio Management Suite, enabling users to manage and refine their portfolio and asset analytics effectively within the real estate property context.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Project Modifier - Get All Project Modifiers By Project ID

HTTP Request

GET /api/project-modifiers/projects/{projectId}

📋 Description: Retrieves detailed information about a specific project within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio performance and asset management related to real estate properties.

Parameters

Name

In

Type

Required

Description

projectId

path

integer(int64)

true

Unique identifier for the project

Responses

Status

Meaning

Description

Schema

200

OK

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    "project": {
 11      "createdBy": "string",
 12      "lastModifiedBy": "string",
 13      "createdDate": "2019-08-24T14:15:22Z",
 14      "lastModifiedDate": "2019-08-24T14:15:22Z",
 15      "archived": true,
 16      "externalId": "string",
 17      "id": 0,
 18      "name": "string",
 19      "description": "string",
 20      "targetDate": "2019-08-24",
 21      "startDate": "2019-08-24",
 22      "dueDate": "2019-08-24",
 23      "possessionDate": "2019-08-24",
 24      "projectTargetTypeId": 0,
 25      "projectActivityId": 0,
 26      "projectTypeId": 0,
 27      "projectItemId": 0,
 28      "projectExecutorTypeId": 0,
 29      "projectPriorityId": 0,
 30      "projectPrivacyId": 0,
 31      "projectStatusId": 0,
 32      "progressStatusId": 0,
 33      "projectManagerId": 0,
 34      "isTemplate": true,
 35      "budgetAmount": 0,
 36      "bufferAmount": 0,
 37      "milestone": [
 38        {
 39          "createdBy": "string",
 40          "lastModifiedBy": "string",
 41          "createdDate": "2019-08-24T14:15:22Z",
 42          "lastModifiedDate": "2019-08-24T14:15:22Z",
 43          "archived": true,
 44          "externalId": "string",
 45          "id": 0,
 46          "name": "string",
 47          "description": "string",
 48          "wbs": 0,
 49          "percProject": 0,
 50          "startDate": "2019-08-24",
 51          "targetDate": "2019-08-24",
 52          "baselineTargetDate": "2019-08-24",
 53          "dateActualized": "2019-08-24",
 54          "scheduleFrom": "2019-08-24",
 55          "noOfDaysToSchedule": 0,
 56          "milestoneTypeId": 0,
 57          "statusId": 0,
 58          "approverId": 0,
 59          "approvalStatusId": 0,
 60          "approvalDate": "2019-08-24",
 61          "isTemplate": true,
 62          "milestoneTasks": [
 63            {
 64              "createdBy": "string",
 65              "lastModifiedBy": "string",
 66              "createdDate": "2019-08-24T14:15:22Z",
 67              "lastModifiedDate": "2019-08-24T14:15:22Z",
 68              "archived": true,
 69              "externalId": "string",
 70              "id": 0,
 71              "name": "string",
 72              "description": "string",
 73              "wbs": 0,
 74              "startDate": "2019-08-24",
 75              "targetDate": "2019-08-24",
 76              "statusId": 0,
 77              "assigneeId": 0,
 78              "assigneeCanModify": true,
 79              "notificationTypeId": 0,
 80              "triggerId": 0,
 81              "statusOfTriggerId": 0,
 82              "emailSendDate": "2019-08-24",
 83              "lastEmailSent": "2019-08-24",
 84              "isEmailAcknowledged": true,
 85              "nbEmailSent": 0,
 86              "milestoneTaskKeywordId": 0,
 87              "milestoneTaskKeywordValue": "string",
 88              "approverId": 0,
 89              "approvalStatusId": 0,
 90              "refernceTaskId": 0,
 91              "nrmWorkOrderId": 0,
 92              "nrmWorkOrderDisplayId": "string",
 93              "approvalDate": "2019-08-24",
 94              "milestoneTaskCost": {
 95                "createdBy": "string",
 96                "lastModifiedBy": "string",
 97                "createdDate": "2019-08-24T14:15:22Z",
 98                "lastModifiedDate": "2019-08-24T14:15:22Z",
 99                "archived": true,
100                "externalId": "string",
101                "id": 0,
102                "actual": 0,
103                "workOrderCost": 0
104              }
105            }
106          ],
107          "milestoneCost": {
108            "createdBy": "string",
109            "lastModifiedBy": "string",
110            "createdDate": "2019-08-24T14:15:22Z",
111            "lastModifiedDate": "2019-08-24T14:15:22Z",
112            "archived": true,
113            "externalId": "string",
114            "id": 0,
115            "sourceId": 0,
116            "estimated": 0,
117            "totalActual": 0
118          }
119        }
120      ],
121      "projectCost": {
122        "createdBy": "string",
123        "lastModifiedBy": "string",
124        "createdDate": "2019-08-24T14:15:22Z",
125        "lastModifiedDate": "2019-08-24T14:15:22Z",
126        "archived": true,
127        "externalId": "string",
128        "id": 0,
129        "totalBudget": 0,
130        "totalEstimated": 0,
131        "grandTotalActual": 0
132      }
133    },
134    "projectId": 0,
135    "userId": 0,
136    "userDto": {
137      "createdBy": "string",
138      "lastModifiedBy": "string",
139      "createdDate": "2019-08-24T14:15:22Z",
140      "lastModifiedDate": "2019-08-24T14:15:22Z",
141      "archived": true,
142      "externalId": "string",
143      "id": 0,
144      "email": "string",
145      "userName": "string",
146      "firstName": "string",
147      "lastName": "string",
148      "displayName": "string",
149      "permissions": "string",
150      "internalId": "string",
151      "preferredCulture": {
152        "createdBy": "string",
153        "lastModifiedBy": "string",
154        "createdDate": "2019-08-24T14:15:22Z",
155        "lastModifiedDate": "2019-08-24T14:15:22Z",
156        "archived": true,
157        "externalId": "string",
158        "id": 0,
159        "name": "string",
160        "code": "string",
161        "defaultCulture": true,
162        "enable": true
163      },
164      "userGroups": [
165        {
166          "createdBy": "string",
167          "lastModifiedBy": "string",
168          "createdDate": "2019-08-24T14:15:22Z",
169          "lastModifiedDate": "2019-08-24T14:15:22Z",
170          "archived": true,
171          "externalId": "string",
172          "id": 0,
173          "name": "string",
174          "description": "string",
175          "internalId": "string"
176        }
177      ],
178      "partnerIds": [
179        0
180      ],
181      "partners": [
182        {
183          "id": 0,
184          "status": "CREATED",
185          "displayId": "string",
186          "erpSystemId": 0,
187          "erpSystemDisplayId": "string",
188          "name": "string",
189          "fax": "string",
190          "phone": "string",
191          "parentId": 0,
192          "parentName": "string",
193          "parentDisplayId": "string",
194          "companyId": 0,
195          "partnerRoleId": 0,
196          "partnerContactId": 0
197        }
198      ]
199    }
200  }
201]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ProjectModifierDto]

false

none

[Data transfer object representing modifications to a project within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio management, asset allocation, and real estate 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

» project

Project

false

none

Data transfer object representing a project within the Nakisa Portfolio Management Suite, encompassing key details related to portfolio management, asset allocation, analytics, and real estate property performance.

»» 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

»» projectItemId

integer(int64)

false

none

Unique identifier for the project item

»» projectExecutorTypeId

integer(int64)

false

none

Unique identifier for the project executor 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

»» isTemplate

boolean

false

none

Whether the resource is template

»» budgetAmount

number

false

none

Amount of budget

»» bufferAmount

number

false

none

Amount of buffer

»» milestone

[Milestone]

false

none

List of milestone 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

»»» 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 critical insights for portfolio and asset analytics 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, facilitating 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

»»» milestoneTasks

[MilestoneTask]

false

none

List of milestoneTasks 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 history within the context of portfolio and asset management.

»»»» 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 a specific keyword value associated with milestone tasks within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for portfolio and asset management in real estate properties.

»»»» 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

»»»» nrmWorkOrderId

integer(int64)

false

none

Unique identifier for the nrm work order

»»»» nrmWorkOrderDisplayId

string

false

none

Unique identifier for the nrm work order display

»»»» approvalDate

string(date)

false

none

Date of the approval

»»»» milestoneTaskCost

MilestoneTaskCost

false

none

Data transfer object representing the cost associated with a specific milestone task within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management analytics for real estate properties.

»»»»» createdBy

string

false

none

Username of who created this resource

»»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»»» createdDate

string(date-time)

false

none

Date of the created

»»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»»» externalId

string

false

none

Unique identifier for the external

»»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»»» actual

number

false

none

Value for actual field

»»»»» workOrderCost

number

false

none

none

»»» milestoneCost

MilestoneCost

false

none

The MilestoneCost schema represents the financial allocation associated with key milestones within a portfolio, enabling effective asset management and analytics for real estate properties. This object facilitates informed decision-making by providing insights into cost distribution across various stages of property development and 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

»»»» sourceId

integer(int64)

false

none

Unique identifier for the source

»»»» estimated

number

false

none

Value for estimated field

»»»» totalActual

number

false

none

Value for totalActual field

»» projectCost

ProjectCost

false

none

Data transfer object representing the financial metrics associated with a project within the Nakisa Portfolio Management Suite, facilitating analytics and decision-making for portfolio and asset management in 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

»»» totalBudget

number

false

none

Value for totalBudget field

»»» totalEstimated

number

false

none

Value for totalEstimated field

»»» grandTotalActual

number

false

none

Value for grandTotalActual field

» projectId

integer(int64)

true

none

Unique identifier for the project

» userId

integer(int64)

false

none

Unique identifier for the user

» userDto

UserDto

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

»» email

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

Culture

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

[UserGroup]

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

[PartnerDto]

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

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED