Pick List

Get Pick List Options

HTTP Request

GET /api/picklists/{code}/options

📋 Description: Retrieves the available options for a specified picklist, enabling users to access relevant data for informed decision-making within their business processes.

Parameters

Name

In

Type

Required

Description

code

path

string

true

Code identifier for the resource

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to retrieve options in manageable segments for improved data handling.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedResponsePickListOptionDto

Example Responses

 1{
 2  "page": {
 3    "size": 0,
 4    "totalElements": 0,
 5    "totalPages": 0,
 6    "number": 0
 7  },
 8  "content": [
 9    {
10      "createdBy": "string",
11      "lastModifiedBy": "string",
12      "createdDate": "2019-08-24T14:15:22Z",
13      "lastModifiedDate": "2019-08-24T14:15:22Z",
14      "archived": true,
15      "externalId": "string",
16      "id": 0,
17      "priority": 0,
18      "internalId": 0,
19      "pickListCode": "string",
20      "pickListLabel": "string",
21      "label": "string",
22      "cultureId": 0,
23      "labelDtos": [
24        {
25          "createdBy": "string",
26          "lastModifiedBy": "string",
27          "createdDate": "2019-08-24T14:15:22Z",
28          "lastModifiedDate": "2019-08-24T14:15:22Z",
29          "archived": true,
30          "externalId": "string",
31          "id": 0,
32          "cultureId": 0,
33          "value": "string"
34        }
35      ]
36    }
37  ],
38  "_embedded": {
39    "property1": {},
40    "property2": {}
41  },
42  "_links": {
43    "property1": {},
44    "property2": {}
45  }
46}

Get Pick List Option By ID

HTTP Request

GET /api/picklist-options/{id}

📋 Description: Fetches the picklist options associated with the specified identifier, enabling users to access relevant data for decision-making and operational efficiency.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

PickListOptionDto

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}