Pick List¶
Pick List - Get Pick List¶
HTTP Request
GET /api/picklists/{code}
📋 Description: Retrieves the specified picklist by its unique code, providing essential data for portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating informed analytics and decision-making in real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code 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": "string",
9 "code": "string",
10 "priority": 0,
11 "pickListType": "string",
12 "label": "string",
13 "cultureId": 0,
14 "reportable": true,
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}
Pick List - Update Pick Lists¶
HTTP Request
PUT /api/picklists/{code}
📋 Description: Updates the specified picklist in the Nakisa Portfolio Management Suite, allowing users to modify asset classifications and enhance analytics related to portfolio and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code identifier for the resource |
body |
body |
true |
Request body containing the updated picklist data, including asset identifiers and associated metadata, relevant for portfolio 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": "string",
9 "code": "string",
10 "priority": 0,
11 "pickListType": "string",
12 "label": "string",
13 "cultureId": 0,
14 "reportable": true,
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}
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": "string",
9 "code": "string",
10 "priority": 0,
11 "pickListType": "string",
12 "label": "string",
13 "cultureId": 0,
14 "reportable": true,
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}
Pick List - Update Pick List Option¶
HTTP Request
PUT /api/picklists/{code}/options/{id}
📋 Description: Updates the specified option in a picklist, allowing for the modification of asset-related attributes within the Nakisa Portfolio Management Suite, enhancing portfolio analytics and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code identifier for the resource |
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated options data for the specified picklist, including relevant attributes and metadata for effective portfolio and asset management. |
Body Parameters
1{
2 "createdBy": "string",
3 "lastModifiedBy": "string",
4 "createdDate": "2019-08-24T14:15:22Z",
5 "lastModifiedDate": "2019-08-24T14:15:22Z",
6 "archived": true,
7 "externalId": "string",
8 "id": 0,
9 "priority": 0,
10 "internalId": 0,
11 "pickListCode": "string",
12 "pickListLabel": "string",
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}
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 "internalId": 0,
11 "pickListCode": "string",
12 "pickListLabel": "string",
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}
Pick List - Get Pick Lists¶
HTTP Request
GET /api/picklists
📋 Description: Retrieves a list of available picklists for managing portfolio assets and real estate properties, facilitating enhanced analytics and decision-making within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the picklist retrieval should be paginated, facilitating efficient data management and analysis within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific portfolio, asset, or real estate property data within the Nakisa Portfolio Management Suite. |
code |
query |
string |
false |
Code identifier for the resource |
code-in |
query |
string |
false |
Specifies the code associated with a particular asset within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of relevant portfolio and real estate property analytics. |
pick-list-type |
query |
string |
false |
Specifies the type of pick list to retrieve, allowing users to filter results based on relevant business contexts such as portfolio, asset, analytics, or real estate property. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "pickLists": [
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": "string",
12 "code": "string",
13 "priority": 0,
14 "pickListType": "string",
15 "label": "string",
16 "cultureId": 0,
17 "reportable": true,
18 "labelDtos": [
19 {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "cultureId": 0,
28 "value": "string"
29 }
30 ]
31 }
32 ]
33 },
34 "page": {
35 "size": 0,
36 "totalElements": 0,
37 "totalPages": 0,
38 "number": 0
39 }
40}
Pick List - Create Pick Lists¶
HTTP Request
POST /api/picklists
📋 Description: Creates a new picklist for managing assets within the Nakisa Portfolio Management Suite, enabling users to organize and analyze real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the picklist data for portfolio and asset management, including relevant attributes and analytics for real estate properties. |
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": "string",
10 "code": "string",
11 "priority": 0,
12 "pickListType": "string",
13 "label": "string",
14 "cultureId": 0,
15 "reportable": true,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
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": "string",
10 "code": "string",
11 "priority": 0,
12 "pickListType": "string",
13 "label": "string",
14 "cultureId": 0,
15 "reportable": true,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a selection of options within the Nakisa Portfolio Management Suite, specifically designed to facilitate the management and analysis of portfolios, assets, and real estate properties.] |
|
» createdBy |
string |
false |
none |
Username of who created this resource |
» lastModifiedBy |
string |
false |
none |
Username of who last modified this resource |
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» archived |
boolean |
false |
none |
Boolean flag indicating archived status |
» externalId |
string |
false |
none |
Unique identifier for the external |
» id |
string |
false |
none |
Unique identifier for the resource |
» code |
string |
false |
none |
Code identifier for the resource |
» priority |
integer(int64) |
false |
none |
Priority of the resource |
» pickListType |
string |
false |
none |
Type of the pick list |
» label |
string |
false |
none |
Label for the resource |
» cultureId |
integer(int64) |
false |
none |
Unique identifier for the culture |
» reportable |
boolean |
false |
none |
Boolean flag indicating reportable status |
» 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 |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
Pick List - Unarchive Pick Lists¶
HTTP Request
POST /api/picklists/{code}/unarchive
📋 Description: Unarchives a specified picklist within the Nakisa Portfolio Management Suite, allowing users to restore previously archived portfolio assets for enhanced analytics and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code 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": "string",
9 "code": "string",
10 "priority": 0,
11 "pickListType": "string",
12 "label": "string",
13 "cultureId": 0,
14 "reportable": true,
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}
Pick List - Get Pick List Options¶
HTTP Request
GET /api/picklists/{code}/options
📋 Description: Retrieves available options for a specified picklist code within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
|
code |
path |
string |
true |
Code identifier for the resource |
internal-id |
query |
string |
false |
Unique identifier for the specific option within a picklist, facilitating precise retrieval of asset-related data in the Nakisa Portfolio Management Suite. |
label-value-like |
query |
string |
false |
Specifies a string value to filter picklist options based on a partial match, facilitating streamlined selection in portfolio and asset management within the Nakisa Portfolio Management Suite. |
internal-id-in |
query |
string |
false |
Unique identifier for the specific picklist option, facilitating accurate retrieval of asset-related data within the Nakisa Portfolio Management Suite. |
internal-id-not-in |
query |
string |
false |
Specifies a comma-separated list of internal IDs to exclude from the retrieved options in the specified picklist, facilitating targeted asset and portfolio analytics. |
id-in |
query |
string |
false |
Unique identifier for the specific option within the designated picklist, facilitating precise retrieval of asset-related data in the Nakisa Portfolio Management Suite. |
id-not-in |
query |
string |
false |
Excludes specific option identifiers from the returned list of picklist options for enhanced asset and portfolio analytics within the Nakisa Portfolio Management Suite. |
priority |
query |
string |
false |
Priority of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "pickListOptions": [
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 "internalId": 0,
14 "pickListCode": "string",
15 "pickListLabel": "string",
16 "label": "string",
17 "cultureId": 0,
18 "labelDtos": [
19 {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "cultureId": 0,
28 "value": "string"
29 }
30 ]
31 }
32 ]
33 },
34 "page": {
35 "size": 0,
36 "totalElements": 0,
37 "totalPages": 0,
38 "number": 0
39 }
40}
Pick List - Create Pick List Options¶
HTTP Request
POST /api/picklists/{code}/options
📋 Description: Creates new options for a specified picklist within the Nakisa Portfolio Management Suite, enabling enhanced asset management and analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code identifier for the resource |
body |
body |
true |
Request body containing the asset option details, including attributes and values, to enhance portfolio 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 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
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 "internalId": 0,
12 "pickListCode": "string",
13 "pickListLabel": "string",
14 "label": "string",
15 "cultureId": 0,
16 "labelDtos": [
17 {
18 "createdBy": "string",
19 "lastModifiedBy": "string",
20 "createdDate": "2019-08-24T14:15:22Z",
21 "lastModifiedDate": "2019-08-24T14:15:22Z",
22 "archived": true,
23 "externalId": "string",
24 "id": 0,
25 "cultureId": 0,
26 "value": "string"
27 }
28 ]
29 }
30]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 |
Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite. |
Pick List - Unarchive Pick List Options¶
HTTP Request
POST /api/picklists/{code}/options/{id}/unarchive
📋 Description: Unarchives a specified option within a picklist, allowing for the restoration of previously archived data relevant to portfolio and asset management in the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code identifier for the resource |
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 "internalId": 0,
11 "pickListCode": "string",
12 "pickListLabel": "string",
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}
Pick List - Archive Pick List Options¶
HTTP Request
POST /api/picklists/{code}/options/{id}/archive
📋 Description: Archives a specified option within a picklist, allowing for streamlined management of portfolio assets and enhanced analytics in the Nakisa Portfolio Management Suite. This operation is essential for maintaining accurate and up-to-date real estate property data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code identifier for the resource |
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 "internalId": 0,
11 "pickListCode": "string",
12 "pickListLabel": "string",
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}
Pick List - Archive Pick Lists¶
HTTP Request
POST /api/picklists/{code}/archive
📋 Description: Archives a specified picklist within the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
code |
path |
string |
true |
Code 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": "string",
9 "code": "string",
10 "priority": 0,
11 "pickListType": "string",
12 "label": "string",
13 "cultureId": 0,
14 "reportable": true,
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}
Pick List - Get Milestone Status Options¶
HTTP Request
GET /api/picklists/{code}/options/nrm
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
|
code |
path |
string |
true |
none |
internal-id |
query |
string |
false |
none |
label-value-like |
query |
string |
false |
none |
internal-id-in |
query |
string |
false |
none |
internal-id-not-in |
query |
string |
false |
none |
id-in |
query |
string |
false |
none |
id-not-in |
query |
string |
false |
none |
priority |
query |
string |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "pageSize": 0,
7 "unpaged": true,
8 "paged": true,
9 "offset": 0,
10 "sort": {
11 "sorted": true,
12 "unsorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "priority": 0,
28 "internalId": 0,
29 "pickListCode": "string",
30 "pickListLabel": "string",
31 "label": "string",
32 "cultureId": 0,
33 "labelDtos": [
34 {
35 "createdBy": "string",
36 "lastModifiedBy": "string",
37 "createdDate": "2019-08-24T14:15:22Z",
38 "lastModifiedDate": "2019-08-24T14:15:22Z",
39 "archived": true,
40 "externalId": "string",
41 "id": 0,
42 "cultureId": 0,
43 "value": "string"
44 }
45 ]
46 }
47 ],
48 "number": 0,
49 "sort": {
50 "sorted": true,
51 "unsorted": true,
52 "empty": true
53 },
54 "first": true,
55 "last": true,
56 "empty": true
57}
Pick List - Get Pick List Option¶
HTTP Request
GET /api/picklist-options/{id}
📋 Description: Retrieves picklist options associated with a specific asset or portfolio, enabling users to access relevant data for analytics and decision-making 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 "internalId": 0,
11 "pickListCode": "string",
12 "pickListLabel": "string",
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}