Udf Field¶
Update Udf Field Value¶
HTTP Request
PUT /api/udf-fields/{udfFieldId}/values/{valueId}
📋 Description: Updates the specified user-defined field value for a given asset within the Nakisa Portfolio Management Suite, enabling enhanced data accuracy and analytics for portfolio and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
udfFieldId |
path |
integer(int64) |
true |
Unique identifier for the udf field |
valueId |
path |
integer(int64) |
true |
Unique identifier for the value |
body |
body |
any |
true |
Request body containing the updated value data for the specified user-defined field, including relevant attributes for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": true,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": true,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Response Schema
Get Udf Field¶
HTTP Request
GET /api/udf-fields/{id}
📋 Description: Retrieves the details of a specific User Defined Field (UDF) by its unique identifier, enabling users to access customized data relevant to portfolio and asset 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 "typeId": 0,
10 "priority": 0,
11 "required": true,
12 "reportable": true,
13 "labels": [
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 "udfGroupId": 0,
27 "type": {
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 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70}
Update Udf Field¶
HTTP Request
PUT /api/udf-fields/{id}
📋 Description: Updates the specified user-defined field (UDF) in the Nakisa Portfolio Management Suite, enabling users to refine asset and portfolio 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 updated user-defined field data, including attributes relevant to portfolio, asset, 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 "typeId": 0,
10 "priority": 0,
11 "required": true,
12 "reportable": true,
13 "labels": [
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 "udfGroupId": 0,
27 "type": {
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 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70}
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 "typeId": 0,
10 "priority": 0,
11 "required": true,
12 "reportable": true,
13 "labels": [
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 "udfGroupId": 0,
27 "type": {
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 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70}
Delete Udf Field¶
HTTP Request
DELETE /api/udf-fields/{id}
📋 Description: Deletes a specified User Defined Field (UDF) from the Nakisa Portfolio Management Suite, enabling users to maintain an organized and relevant portfolio of asset and 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 |
Update Udf Field List Option¶
HTTP Request
PUT /api/udf-fields/{id}/list-options/{listOptionId}
📋 Description: Updates the specified list option for a user-defined field within the Nakisa Portfolio Management Suite, enabling enhanced data categorization and analytics for portfolio and asset management in the real estate sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
listOptionId |
path |
integer(int64) |
true |
Unique identifier for the list option |
body |
body |
true |
Request body containing the updated list option data for the specified user-defined field, including relevant attributes for portfolio and asset analytics in 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 "label": "string",
10 "cultureId": 0,
11 "labelDtos": [
12 {
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 "cultureId": 0,
21 "value": "string"
22 }
23 ]
24}
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 "labelDtos": [
12 {
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 "cultureId": 0,
21 "value": "string"
22 }
23 ]
24}
Delete Udf Field List Option¶
HTTP Request
DELETE /api/udf-fields/{id}/list-options/{listOptionId}
📋 Description: Deletes a specified list option associated with a user-defined field in the Nakisa Portfolio Management Suite, facilitating streamlined data management within portfolio and asset analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
listOptionId |
path |
integer(int64) |
true |
Unique identifier for the list option |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Udf Fields¶
HTTP Request
GET /api/udf-fields
📋 Description: Retrieves user-defined fields related to portfolios, assets, and real estate properties, enabling enhanced analytics and reporting within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
external-id |
query |
string |
false |
Unique identifier for external assets within the Nakisa Portfolio Management Suite, facilitating the retrieval of user-defined fields related to portfolio and real estate property analytics. |
created-by |
query |
string |
false |
Identifier of the user who created the UDF field, facilitating tracking and accountability within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
last-modified-by |
query |
string |
false |
Identifier of the user who last modified the UDF field, providing accountability and tracking within the portfolio management and asset analytics processes. |
created-after |
query |
string |
false |
Specifies the date and time after which user-defined fields (UDFs) were created, allowing for targeted retrieval of portfolio, asset, and real estate property analytics. |
created-before |
query |
string |
false |
Specifies the cutoff date for retrieving user-defined fields created before this date, facilitating targeted analytics and reporting for portfolio and asset management within the Nakisa Portfolio Management Suite. |
last-modified-after |
query |
string |
false |
Specifies the date and time to filter UDF fields that have been modified after the given timestamp, enabling users to retrieve updated portfolio, asset, and real estate property analytics. |
last-modified-before |
query |
string |
false |
Specifies the cutoff date for retrieving user-defined fields modified before this date, enabling targeted analytics for portfolio and asset management within the Nakisa Portfolio Management Suite. |
last-modified-time-after |
query |
string |
false |
Specifies the minimum timestamp for retrieving user-defined fields that have been modified after the given date, facilitating the tracking of changes in portfolio, asset, and real estate property analytics. |
last-modified-time-before |
query |
string |
false |
Specifies the cutoff date and time to retrieve user-defined fields that were last modified before the given timestamp, facilitating effective asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
pageable |
query |
true |
Indicates whether the response should be paginated, facilitating efficient retrieval of portfolio, asset, and analytics data related to real estate properties. |
|
label-id |
query |
string |
false |
Unique identifier for the user-defined field associated with portfolio, asset, or real estate property analytics within the Nakisa Portfolio Management Suite. |
priority |
query |
string |
false |
Priority of the resource |
type-id |
query |
string |
false |
Identifier for the specific user-defined field type, enabling retrieval of relevant portfolio, asset, and analytics data within the Nakisa Portfolio Management Suite. |
required |
query |
string |
false |
Whether this field is required |
archived |
query |
string |
false |
Indicates whether to retrieve archived user-defined fields within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics for real estate properties. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFields": [
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 "typeId": 0,
13 "priority": 0,
14 "required": true,
15 "reportable": true,
16 "labels": [
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 "udfGroupId": 0,
30 "type": {
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 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 }
74 ]
75 },
76 "page": {
77 "size": 0,
78 "totalElements": 0,
79 "totalPages": 0,
80 "number": 0
81 }
82}
Create Udf Fields¶
HTTP Request
POST /api/udf-fields
📋 Description: Creates new user-defined fields (UDFs) for portfolio assets within the Nakisa Portfolio Management Suite, enabling enhanced analytics and tailored data management for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the user-defined field (UDF) data for portfolio and asset 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 "typeId": 0,
11 "priority": 0,
12 "required": true,
13 "reportable": true,
14 "labels": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "cultureId": 0,
24 "value": "string"
25 }
26 ],
27 "udfGroupId": 0,
28 "type": {
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 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 }
72]
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 "typeId": 0,
11 "priority": 0,
12 "required": true,
13 "reportable": true,
14 "labels": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "cultureId": 0,
24 "value": "string"
25 }
26 ],
27 "udfGroupId": 0,
28 "type": {
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 "label": "string",
57 "cultureId": 0,
58 "labelDtos": [
59 {
60 "createdBy": "string",
61 "lastModifiedBy": "string",
62 "createdDate": "2019-08-24T14:15:22Z",
63 "lastModifiedDate": "2019-08-24T14:15:22Z",
64 "archived": true,
65 "externalId": "string",
66 "id": 0,
67 "cultureId": 0,
68 "value": "string"
69 }
70 ]
71 }
72]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a user-defined field within the Nakisa Portfolio Management Suite, facilitating the customization and analytics of portfolio and asset data 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 |
» typeId |
integer(int64) |
false |
none |
Unique identifier for the type |
» priority |
integer(int64) |
false |
none |
Priority of the resource |
» required |
boolean |
false |
none |
Whether this field is required |
» reportable |
boolean |
false |
none |
Boolean flag indicating reportable status |
» labels |
false |
none |
List of labels 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 |
Text value for value in Label |
» udfGroupId |
integer(int64) |
true |
none |
Unique identifier for the udf group |
» type |
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 |
Text value for value in LabelDto |
» label |
string |
false |
none |
Label for the resource |
» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
» labelDtos |
true |
none |
List of labelDtos items |
Create Udf Field Value¶
HTTP Request
POST /api/udf-fields/{id}/value
📋 Description: Submits a new value for the specified User Defined Field (UDF) associated with a portfolio asset in the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
any |
true |
Request body containing the updated value for the user-defined field associated with the specified asset, facilitating enhanced portfolio analytics within the Nakisa Portfolio Management Suite. |
Body Parameters
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": true,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": true,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Response Schema
Unarchive Udf Field¶
HTTP Request
POST /api/udf-fields/{id}/unarchive
📋 Description: Unarchives a specified user-defined field (UDF) within the Nakisa Portfolio Management Suite, restoring its visibility and accessibility for portfolio, asset, and analytics management 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 "typeId": 0,
10 "priority": 0,
11 "required": true,
12 "reportable": true,
13 "labels": [
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 "udfGroupId": 0,
27 "type": {
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 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70}
Get Udf Field List Options¶
HTTP Request
GET /api/udf-fields/{id}/list-options
📋 Description: Retrieves a list of available options for a specified User Defined Field (UDF) within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in the context of real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results for the specified UDF field options should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
id |
path |
string |
true |
Unique identifier for the resource |
pick-list-option-id |
query |
string |
false |
Unique identifier for the specific pick list option within the context of portfolio, asset, analytics, and real estate property management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldOptions": [
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 "labelDtos": [
15 {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "cultureId": 0,
24 "value": "string"
25 }
26 ]
27 }
28 ]
29 },
30 "page": {
31 "size": 0,
32 "totalElements": 0,
33 "totalPages": 0,
34 "number": 0
35 }
36}
Create Udf Field List Options¶
HTTP Request
POST /api/udf-fields/{id}/list-options
📋 Description: Submits a request to add or update list options for a specified User Defined Field (UDF) within the Nakisa Portfolio Management Suite, enhancing data analytics and portfolio management for real estate assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the list of options for the specified user-defined field, including relevant attributes for portfolio, asset, and real estate property analytics. |
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 "label": "string",
11 "cultureId": 0,
12 "labelDtos": [
13 {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "cultureId": 0,
22 "value": "string"
23 }
24 ]
25 }
26]
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 "label": "string",
11 "cultureId": 0,
12 "labelDtos": [
13 {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "cultureId": 0,
22 "value": "string"
23 }
24 ]
25 }
26]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an option for a user-defined field within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and portfolio management for real estate properties and assets.] |
|
» 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 |
» 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 |
Text value for value in LabelDto |
Archive Udf Field¶
HTTP Request
POST /api/udf-fields/{id}/archive
📋 Description: Archives a specified User-Defined Field (UDF) within the Nakisa Portfolio Management Suite, enabling effective management of portfolio and asset data in real estate analytics.
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 "typeId": 0,
10 "priority": 0,
11 "required": true,
12 "reportable": true,
13 "labels": [
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 "udfGroupId": 0,
27 "type": {
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 "label": "string",
56 "cultureId": 0,
57 "labelDtos": [
58 {
59 "createdBy": "string",
60 "lastModifiedBy": "string",
61 "createdDate": "2019-08-24T14:15:22Z",
62 "lastModifiedDate": "2019-08-24T14:15:22Z",
63 "archived": true,
64 "externalId": "string",
65 "id": 0,
66 "cultureId": 0,
67 "value": "string"
68 }
69 ]
70}
Get Udf Group Fields¶
HTTP Request
GET /api/udf-groups/{id}/udf-fields
📋 Description: Retrieves user-defined fields (UDFs) associated with a specific UDF group identified by the provided ID, enabling enhanced asset and portfolio analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the UDF fields retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
id |
path |
string |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFields": [
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 "typeId": 0,
13 "priority": 0,
14 "required": true,
15 "reportable": true,
16 "labels": [
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 "udfGroupId": 0,
30 "type": {
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 "label": "string",
59 "cultureId": 0,
60 "labelDtos": [
61 {
62 "createdBy": "string",
63 "lastModifiedBy": "string",
64 "createdDate": "2019-08-24T14:15:22Z",
65 "lastModifiedDate": "2019-08-24T14:15:22Z",
66 "archived": true,
67 "externalId": "string",
68 "id": 0,
69 "cultureId": 0,
70 "value": "string"
71 }
72 ]
73 }
74 ]
75 },
76 "page": {
77 "size": 0,
78 "totalElements": 0,
79 "totalPages": 0,
80 "number": 0
81 }
82}
Get Udf Field Text Value¶
HTTP Request
GET /api/udf-fields/{id}/text-value
📋 Description: Retrieves the text value associated with a specified User Defined Field (UDF) for a portfolio asset, enabling enhanced analytics and insights within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
object-id |
query |
integer(int64) |
true |
Unique identifier for the specific user-defined field (UDF) within the Nakisa Portfolio Management Suite, used to retrieve its associated text value in the context of portfolio and asset analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": "string",
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Get Udf Field Number Value¶
HTTP Request
GET /api/udf-fields/{id}/number-value
📋 Description: Fetches the numeric value associated with a specific User Defined Field (UDF) for a portfolio asset, facilitating data-driven analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
object-id |
query |
integer(int64) |
true |
Unique identifier for the specific user-defined field (UDF) within the Nakisa Portfolio Management Suite, facilitating retrieval of its associated numerical value for portfolio and asset analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": 0,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Get Udf Field List Value¶
HTTP Request
GET /api/udf-fields/{id}/list-value
📋 Description: Retrieves the list of values associated with a specified User Defined Field (UDF) in the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for portfolio and asset management in real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
object-id |
query |
integer(int64) |
true |
Unique identifier for the specific user-defined field value associated with a portfolio asset within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": 0,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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 "labelValue": "string"
40}
Get Udf Field Large Text Value¶
HTTP Request
GET /api/udf-fields/{id}/large-text-value
📋 Description: Fetches the large text value associated with a specific user-defined field (UDF) in the Nakisa Portfolio Management Suite, enabling users to access detailed information pertinent to portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
object-id |
query |
integer(int64) |
true |
Unique identifier for the large text value associated with a specific user-defined field within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": "string",
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Get Udf Field Date Value¶
HTTP Request
GET /api/udf-fields/{id}/date-value
📋 Description: Retrieves the date value associated with a specific user-defined field (UDF) for a portfolio asset, enabling enhanced analytics and reporting within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
object-id |
query |
integer(int64) |
true |
Unique identifier for the specific user-defined field date value associated with a portfolio asset within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": "2019-08-24T14:15:22Z",
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Get Udf Fiel Boolean Value¶
HTTP Request
GET /api/udf-fields/{id}/boolean-value
📋 Description: Retrieves the boolean value associated with a specified User Defined Field (UDF) for a portfolio asset within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and decision-making for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
object-id |
query |
integer(int64) |
true |
Unique identifier for the specific user-defined field (UDF) associated with a boolean value in the Nakisa Portfolio Management Suite, relevant to portfolio, asset, and real estate property analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "objectId": 0,
3 "valueType": "string",
4 "value": true,
5 "objectType": "string",
6 "createdBy": "string",
7 "lastModifiedBy": "string",
8 "createdDate": "2019-08-24T14:15:22Z",
9 "lastModifiedDate": "2019-08-24T14:15:22Z",
10 "archived": true,
11 "externalId": "string",
12 "id": 0,
13 "udfField": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "typeId": 0,
22 "priority": 0,
23 "required": true,
24 "reportable": true,
25 "labels": [
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}
Get Udf Field Text Values¶
HTTP Request
GET /api/udf-field-text-values
📋 Description: Retrieves text values for user-defined fields associated with portfolios and assets within the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
last-modified-time-after |
query |
string |
false |
Specifies the timestamp to filter results, returning only those text values that were modified after the indicated time, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
pageable |
query |
true |
Indicates whether the results of the asset text values query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and real estate property analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldTextValues": [
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 "udfField": {
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 "typeId": 0,
21 "priority": 0,
22 "required": true,
23 "reportable": true,
24 "labels": [
25 {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "cultureId": 0,
34 "value": "string"
35 }
36 ]
37 },
38 "valueType": "string",
39 "objectId": 0,
40 "value": "string",
41 "objectType": "string"
42 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Get Udf Field Number Values¶
HTTP Request
GET /api/udf-field-number-values
📋 Description: Retrieves numerical values for user-defined fields associated with assets in the Nakisa Portfolio Management Suite, facilitating enhanced analytics and insights for real estate property portfolios.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
last-modified-time-after |
query |
string |
false |
Specifies the cutoff date and time to retrieve UDF field number values that were modified after the given timestamp, facilitating targeted analytics for portfolio and asset management within the Nakisa Portfolio Management Suite. |
pageable |
query |
true |
Indicates whether the results of the asset analytics query for real estate property values should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldNumberValues": [
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 "udfField": {
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 "typeId": 0,
21 "priority": 0,
22 "required": true,
23 "reportable": true,
24 "labels": [
25 {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "cultureId": 0,
34 "value": "string"
35 }
36 ]
37 },
38 "valueType": "string",
39 "objectId": 0,
40 "value": 0,
41 "objectType": "string"
42 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Get Udf Field List Values¶
HTTP Request
GET /api/udf-field-list-values
📋 Description: Retrieves a list of user-defined field values relevant to portfolios and assets within the Nakisa Portfolio Management Suite, facilitating enhanced analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
last-modified-time-after |
query |
string |
false |
Specifies the timestamp to filter results, returning only those UDF field list values modified after the designated time, relevant for portfolio, asset, analytics, and real estate property management. |
pageable |
query |
true |
Indicates whether the results of the UDF field list values query should be returned in a paginated format, facilitating efficient data retrieval for portfolio, asset, and real estate property analytics. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldListValues": [
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 "udfField": {
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 "typeId": 0,
21 "priority": 0,
22 "required": true,
23 "reportable": true,
24 "labels": [
25 {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "cultureId": 0,
34 "value": "string"
35 }
36 ]
37 },
38 "valueType": "string",
39 "objectId": 0,
40 "value": 0,
41 "objectType": "string",
42 "labelValue": "string"
43 }
44 ]
45 },
46 "page": {
47 "size": 0,
48 "totalElements": 0,
49 "totalPages": 0,
50 "number": 0
51 }
52}
Get Udf Field Large Text Values¶
HTTP Request
GET /api/udf-field-large-text-values
📋 Description: Retrieves large text values associated with user-defined fields for assets within the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
last-modified-time-after |
query |
string |
false |
Specifies the timestamp to filter and retrieve large text values that have been modified after a certain date, aiding in the analysis of portfolio and asset data within the Nakisa Portfolio Management Suite. |
pageable |
query |
true |
Indicates whether the results of the large text values retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldLargeTextValues": [
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 "udfField": {
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 "typeId": 0,
21 "priority": 0,
22 "required": true,
23 "reportable": true,
24 "labels": [
25 {
26 "createdBy": "string",
27 "lastModifiedBy": "string",
28 "createdDate": "2019-08-24T14:15:22Z",
29 "lastModifiedDate": "2019-08-24T14:15:22Z",
30 "archived": true,
31 "externalId": "string",
32 "id": 0,
33 "cultureId": 0,
34 "value": "string"
35 }
36 ]
37 },
38 "valueType": "string",
39 "objectId": 0,
40 "value": "string",
41 "objectType": "string"
42 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Get Udf Field Date Values¶
HTTP Request
GET /api/udf-field-date-values
📋 Description: Retrieves date values for user-defined fields associated with portfolios and assets within the Nakisa Portfolio Management Suite, enabling enhanced analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
last-modified-time-after |
query |
string |
false |
Specifies the timestamp to filter results, returning only those date values modified after the given time, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
pageable |
query |
true |
Indicates whether the results of the date values query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldDateValues": [
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 "valueType": "string",
13 "objectId": 0,
14 "value": "2019-08-24T14:15:22Z",
15 "udfField": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "typeId": 0,
24 "priority": 0,
25 "required": true,
26 "reportable": true,
27 "labels": [
28 {
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 "cultureId": 0,
37 "value": "string"
38 }
39 ]
40 },
41 "objectType": "string"
42 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Get Udf Field Boolean Values¶
HTTP Request
GET /api/udf-field-boolean-values
📋 Description: Retrieves boolean values for user-defined fields within the Nakisa Portfolio Management Suite, facilitating enhanced analytics and reporting for portfolio and asset management in the real estate property sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
last-modified-time-after |
query |
string |
false |
Specifies the timestamp to filter boolean values in the portfolio management suite, returning only those modified after the designated time for enhanced asset analytics. |
pageable |
query |
true |
Indicates whether the results of the boolean values for user-defined fields should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfFieldBooleanValues": [
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 "valueType": "string",
13 "objectId": 0,
14 "value": true,
15 "udfField": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "typeId": 0,
24 "priority": 0,
25 "required": true,
26 "reportable": true,
27 "labels": [
28 {
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 "cultureId": 0,
37 "value": "string"
38 }
39 ]
40 },
41 "objectType": "string"
42 }
43 ]
44 },
45 "page": {
46 "size": 0,
47 "totalElements": 0,
48 "totalPages": 0,
49 "number": 0
50 }
51}
Get Udf Field List Option¶
HTTP Request
GET /api/list-options/{listOptionId}
📋 Description: Retrieves detailed information about a specific list option identified by the provided listOptionId, enabling users to access relevant data for portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
listOptionId |
path |
integer(int64) |
true |
Unique identifier for the list option |
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 "labelDtos": [
12 {
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 "cultureId": 0,
21 "value": "string"
22 }
23 ]
24}