Project Additional Field¶
Project Additional Field - Get Project Additional Field¶
HTTP Request
GET /api/project-additional-fields/{id}
📋 Description: Retrieves additional fields associated with a specific project, enhancing insights into portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "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 "projectAdditionalFieldTypeId": 0,
10 "position": 0,
11 "projectAdditionalFieldType": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "priority": 0,
20 "internalId": 0,
21 "pickListCode": "string",
22 "pickListLabel": "string",
23 "label": "string",
24 "cultureId": 0,
25 "labelDtos": [
26 {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "cultureId": 0,
35 "value": "string"
36 }
37 ]
38 },
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 "isRequired": true,
55 "isEnabled": true
56}
Project Additional Field - Update Project Additional Field¶
HTTP Request
PUT /api/project-additional-fields/{id}
📋 Description: Updates the additional fields of a specified project within the Nakisa Portfolio Management Suite, enabling enhanced asset tracking and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the additional fields data for a specific project, including relevant attributes and metadata to enhance portfolio 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 "projectAdditionalFieldTypeId": 0,
10 "position": 0,
11 "projectAdditionalFieldType": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "priority": 0,
20 "internalId": 0,
21 "pickListCode": "string",
22 "pickListLabel": "string",
23 "label": "string",
24 "cultureId": 0,
25 "labelDtos": [
26 {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "cultureId": 0,
35 "value": "string"
36 }
37 ]
38 },
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 "isRequired": true,
55 "isEnabled": true
56}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Project Additional Field - Delete Project Additional Field¶
HTTP Request
DELETE /api/project-additional-fields/{id}
📋 Description: Deletes a specified additional field from a project within the Nakisa Portfolio Management Suite, ensuring the integrity of portfolio and asset data in 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 Additional Field - Update Project Additional Field Positions¶
HTTP Request
PUT /api/project-additional-fields/update-positions
📋 Description: Updates the positions of additional fields associated with projects within the Nakisa Portfolio Management Suite, enabling enhanced asset tracking and analytics for real estate properties. This operation ensures that portfolio data remains accurate and aligned with business requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the updated positioning data for additional fields related to portfolio and asset management 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 "projectAdditionalFieldTypeId": 0,
11 "position": 0,
12 "projectAdditionalFieldType": {
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 "priority": 0,
21 "internalId": 0,
22 "pickListCode": "string",
23 "pickListLabel": "string",
24 "label": "string",
25 "cultureId": 0,
26 "labelDtos": [
27 {
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 "cultureId": 0,
36 "value": "string"
37 }
38 ]
39 },
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 "isRequired": true,
56 "isEnabled": true
57 }
58]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Project Additional Field - Get Project Additional Fields¶
HTTP Request
GET /api/project-additional-fields
📋 Description: Retrieves additional fields related to projects within the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for portfolio and asset management in the real estate sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the project additional fields query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
listing |
query |
boolean |
false |
Indicates whether to include additional listing details in the response for portfolio, asset, and real estate property analytics. |
search |
query |
string |
false |
Search term used to filter and retrieve specific additional fields related to portfolios, assets, analytics, or real estate properties within the Nakisa Portfolio Management Suite. |
project-additional-field-type |
query |
string |
false |
Specifies the type of additional field associated with a project, enhancing the portfolio, asset, and analytics management within the Nakisa Portfolio Management Suite. |
archived |
query |
string |
false |
Indicates whether the project additional fields are archived, providing insights into the status of portfolio and asset management within the Nakisa Portfolio Management Suite. |
required |
query |
string |
false |
Whether this field is required |
enabled |
query |
string |
false |
Whether this feature is enabled |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "projectAdditionalFields": [
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 "projectAdditionalFieldTypeId": 0,
13 "position": 0,
14 "projectAdditionalFieldType": {
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 "priority": 0,
23 "internalId": 0,
24 "pickListCode": "string",
25 "pickListLabel": "string",
26 "label": "string",
27 "cultureId": 0,
28 "labelDtos": [
29 {
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 "cultureId": 0,
38 "value": "string"
39 }
40 ]
41 },
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 "isRequired": true,
58 "isEnabled": true
59 }
60 ]
61 },
62 "page": {
63 "size": 0,
64 "totalElements": 0,
65 "totalPages": 0,
66 "number": 0
67 }
68}
Project Additional Field - Create Project Additional Field¶
HTTP Request
POST /api/project-additional-fields
📋 Description: Adds custom additional fields to a specified project within the Nakisa Portfolio Management Suite, enhancing asset and portfolio analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing additional fields for project management, including relevant asset details and analytics parameters to enhance portfolio insights 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 "projectAdditionalFieldTypeId": 0,
10 "position": 0,
11 "projectAdditionalFieldType": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "priority": 0,
20 "internalId": 0,
21 "pickListCode": "string",
22 "pickListLabel": "string",
23 "label": "string",
24 "cultureId": 0,
25 "labelDtos": [
26 {
27 "createdBy": "string",
28 "lastModifiedBy": "string",
29 "createdDate": "2019-08-24T14:15:22Z",
30 "lastModifiedDate": "2019-08-24T14:15:22Z",
31 "archived": true,
32 "externalId": "string",
33 "id": 0,
34 "cultureId": 0,
35 "value": "string"
36 }
37 ]
38 },
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 "isRequired": true,
55 "isEnabled": true
56}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10