Udf Group¶
Udf Group - Get Udf Group¶
HTTP Request
GET /api/udf-groups/{id}
📋 Description: Retrieves details of a specific User Defined Field (UDF) group identified by the provided ID, enabling users to analyze and manage portfolio and asset data 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 "priority": 0,
10 "parentGroupId": 0,
11 "objectTypeId": 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 "objectType": {
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}
Udf Group - Update Udf Group¶
HTTP Request
PUT /api/udf-groups/{id}
📋 Description: Updates the specified UDF group within the Nakisa Portfolio Management Suite, allowing for modifications to portfolio, asset, and analytics configurations related to real estate properties. This operation ensures that user-defined groups reflect the most current business requirements and analytics needs.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated information for the specified user-defined group, including attributes relevant to portfolio management, asset categorization, 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 "priority": 0,
10 "parentGroupId": 0,
11 "objectTypeId": 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 "objectType": {
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}
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 "priority": 0,
10 "parentGroupId": 0,
11 "objectTypeId": 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 "objectType": {
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}
Udf Group - Delete Udf Group¶
HTTP Request
DELETE /api/udf-groups/{id}
📋 Description: Deletes a specified User Defined Field (UDF) group from the Nakisa Portfolio Management Suite, facilitating the management of portfolio analytics and real estate property data.
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 |
Udf Group - Get Udf Groups¶
HTTP Request
GET /api/udf-groups
📋 Description: Retrieves user-defined function (UDF) groups within the Nakisa Portfolio Management Suite, enabling users to analyze and manage portfolio, asset, and real estate property data effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the UDF groups retrieval should be paginated, facilitating efficient data management in portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
label-id |
query |
string |
false |
Unique identifier for the user-defined field group, facilitating targeted retrieval of portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite. |
priority |
query |
string |
false |
Priority of the resource |
parent-group-id |
query |
string |
false |
Unique identifier for the parent group within the Nakisa Portfolio Management Suite, used to filter and retrieve specific user-defined groups related to portfolio, asset, analytics, and real estate property. |
object-type-id |
query |
string |
false |
Unique identifier for the type of object being queried within the Nakisa Portfolio Management Suite, applicable to portfolio, asset, analytics, and real estate property contexts. |
archived |
query |
string |
false |
Specifies whether to retrieve archived user-defined groups within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management. |
parent-group-id-null |
query |
string |
false |
Identifier for the parent group, which, when set to null, retrieves all user-defined groups within the Nakisa Portfolio Management Suite, facilitating comprehensive portfolio and asset analytics in real estate property management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "udfGroups": [
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 "priority": 0,
13 "parentGroupId": 0,
14 "objectTypeId": 0,
15 "label": "string",
16 "cultureId": 0,
17 "labelDtos": [
18 {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "cultureId": 0,
27 "value": "string"
28 }
29 ],
30 "objectType": {
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 }
59 ]
60 },
61 "page": {
62 "size": 0,
63 "totalElements": 0,
64 "totalPages": 0,
65 "number": 0
66 }
67}
Udf Group - Create Udf Groups¶
HTTP Request
POST /api/udf-groups
📋 Description: Creates a new User Defined Field (UDF) group within the Nakisa Portfolio Management Suite, enabling enhanced organization and analytics of portfolio and asset data related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of user-defined groups, including attributes and configurations relevant to portfolio and asset management 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 "priority": 0,
11 "parentGroupId": 0,
12 "objectTypeId": 0,
13 "label": "string",
14 "cultureId": 0,
15 "labelDtos": [
16 {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "cultureId": 0,
25 "value": "string"
26 }
27 ],
28 "objectType": {
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 }
57]
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 "priority": 0,
11 "parentGroupId": 0,
12 "objectTypeId": 0,
13 "label": "string",
14 "cultureId": 0,
15 "labelDtos": [
16 {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "cultureId": 0,
25 "value": "string"
26 }
27 ],
28 "objectType": {
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 }
57]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a user-defined field group within the Nakisa Portfolio Management Suite, facilitating the organization and analysis of portfolio, asset, and real estate property data for enhanced decision-making and 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 |
» priority |
integer(int64) |
false |
none |
Priority of the resource |
» parentGroupId |
integer(int64) |
false |
none |
Unique identifier for the parent group |
» objectTypeId |
integer(int64) |
false |
none |
Unique identifier for the object type |
» 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 |
|
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
»» externalId |
string |
false |
none |
Unique identifier for the external |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
»» value |
string |
true |
none |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
» objectType |
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 |
Udf Group - Unarchive Udf Group¶
HTTP Request
POST /api/udf-groups/{id}/unarchive
📋 Description: Unarchives a specified User Defined Field (UDF) group within the Nakisa Portfolio Management Suite, allowing for the restoration of previously archived portfolio, asset, or real estate property analytics for enhanced visibility and management.
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 "priority": 0,
10 "parentGroupId": 0,
11 "objectTypeId": 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 "objectType": {
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}
Udf Group - Archive Udf Group¶
HTTP Request
POST /api/udf-groups/{id}/archive
📋 Description: Archives the specified User Defined Field (UDF) group within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhanced analytics for real estate property portfolios.
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 "priority": 0,
10 "parentGroupId": 0,
11 "objectTypeId": 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 "objectType": {
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}