Creating Picklists Using REST APIs

The headless-admin-list-type service provides REST APIs for performing CRUD operations for picklists. Using these APIs is far more efficient than creating picklists manually through the UI, since you can add lists and items with pre-configured ERCs and localized names all in one step. Here you’ll use these APIs to add the remaining picklists for the Distributor Application object.

1. Download and unzip the resources for this exercise.

   curl https://resources.learn.liferay.com/courses/latest/en/application-development/modeling-data-structures/liferay-r5w2.zip -O
   

   unzip liferay-r5w2.zip
   

   This .zip file includes shell scripts for creating the remaining picklists using the headless-admin-list-type REST APIs.

2. Navigate to the curl folder in the liferay-r5w2 folder.

   cd liferay-r5w2/curl
   

3. Run this script to create the Distribution Regions picklist:

   ./ListTypeDefinition_POST_DistributionRegions_ToInstance.sh
   

   Picklist

   Name	External Reference Code
   Distribution Regions	LIST_DISTRIBUTION_REGIONS

   Picklist Items

   Name	Key	External Reference Code
   Latin America	latinAmerica	REGION_LATIN_AMERICA
   Caribbean	caribbean	REGION_CARIBBEAN
   Eastern Europe	easternEurope	REGION_EASTERN_EUROPE
   Western Europe	westernEurope	REGION_WESTERN_EUROPE
   Middle East	middleEast	REGION_MIDDLE_EAST
   Africa	africa	REGION_AFRICA
   Central Asia	centralAsia	REGION_CENTRAL_ASIA
   Asia & Pacific Rim	asiaPacificRim	REGION_ASIA_PACIFIC_RIM
   India	india	REGION_INDIA
   North America	northAmerica	REGION_NORTH_AMERICA

4. Create the Distribution Channels picklist:

   ./ListTypeDefinition_POST_DistributionChannels_ToInstance.sh
   

   Picklist

   Name	External Reference Code
   Distribution Channels	LIST_DISTRIBUTION_CHANNELS

   Picklist Items

   Name	Key	External Reference Code
   Distribute to Other Retailers	otherRetailers	CHANNEL_OTHER_RETAILERS
   Sell Through Own Retail	ownRetail	CHANNEL_OWN_RETAIL
   E-Commerce	eCommerce	CHANNEL_E_COMMERCE

5. Create the Order Types picklist:

   ./ListTypeDefinition_POST_OrderTypes_ToInstance.sh
   

   Picklist

   Name	External Reference Code
   Order Types	LIST_ORDER_TYPES

   Picklist Items

   Name	Key	External Reference Code
   Wholesale	wholesale	ORDER_TYPE_WHOLESALE
   Private Labeling	privateLabeling	ORDER_TYPE_PRIVATE_LABELING
   Bulk Formats	bulkFormats	ORDER_TYPE_BULK_FORMATS
   Not Sure	notSure	ORDER_TYPE_NOT_SURE

6. Create the Product Types picklist:

   ./ListTypeDefinition_POST_ProductTypes_ToInstance.sh
   

   Picklist

   Name	External Reference Code
   Product Types	LIST_PRODUCT_TYPES

   Picklist Items

   Name	Key	External Reference Code
   Maple Syrup	mapleSyrup	PRODUCT_TYPE_MAPLE_SYRUP
   Organic Maple Syrup	organicMapleSyrup	PRODUCT_TYPE_ORGANIC_MAPLE_SYRUP
   Maple Butter	mapleButter	PRODUCT_TYPE_MAPLE_BUTTER
   Maple Sugar	mapleSugar	PRODUCT_TYPE_MAPLE_SUGAR
   Maple Fondant	mapleFondant	PRODUCT_TYPE_MAPLE_FONDANT
   Maple Jelly	mapleJelly	PRODUCT_TYPE_MAPLE_JELLY
   Trees	trees	PRODUCT_TYPE_TREES
   Saplings	saplings	PRODUCT_TYPE_SAPLINGS
   Educational Content	educationalContent	PRODUCT_TYPE_EDUCATIONAL_CONTENT
   Other	other	PRODUCT_TYPE_OTHER

7. Create the Annual Purchase Volumes picklist:

   ./ListTypeDefinition_POST_AnnualPurchaseVolumes_ToInstance.sh
   

   Picklist

   Name	External Reference Code
   Annual Purchase Volumes	LIST_ANNUAL_PURCHASE_VOLUMES

   Picklist Items

   Name	Key	External Reference Code
   $50,000 - 100,000 USD	firstTier	VOLUME_FIRST_TIER
   $200,000 - 500,000 USD	secondTier	VOLUME_SECOND_TIER
   $500,000 - 1M USD	thirdTier	VOLUME_THIRD_TIER
   $1M+ USD	fourthTier	VOLUME_FOURTH_TIER

8. Create the Product Labels picklist:

   ./ListTypeDefinition_POST_ProductLabels_ToInstance.sh
   

   Picklist

   Name	External Reference Code
   Product Labels	LIST_PRODUCT_LABELS

   Picklist Items

   Name	Key	External Reference Code
   Standard US	standardUS	LABEL_STANDARD_US
   Localized	localized	LABEL_LOCALIZED

When finished, you should have seven picklists:

You can now use them to create single-select and multi-select fields in the Distributor Application object.

Next: Adding Picklist Fields to the Object

Relevant Concepts

• Picklists API Basics