ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

ピックリストAPIの基本

Liferayは、候補リストの定義 (ListTypeDefinition)とそのエントリー(ListTypeEntry)を作成・管理するためのheadless-admin-list-types REST APIを提供します。 RESTサービスメニューの[server]:[port]/o/api (例: localhost:8080/o/api)にあるLiferayのAPIエクスプローラーで利用できるAPIを表示し、テストすることができます。

headless-admin-list-typeで候補リストのAPIにアクセスします。

headless-admin-list-typesサービスを呼び出して、候補リストを作成・管理します。

選択リストを追加する

Liferay DXP の新しいインスタンスを起動するには、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2026.q1.9-lts

http://localhost:8080 に、メールアドレス test@liferay.com とパスワード test を使用して Liferay にサインインします。プロンプトが表示されたら、パスワードを learn に変更してください。

次に、サンプルコードを準備します。

ダウンロードして解凍します Picklists API の基本。

curl https://resources.learn.liferay.com/examples/liferay-v3n6.zip -O

unzip liferay-v3n6.zip

cURLスクリプトを使用して、インスタンスに新しい選択リストを追加します。コマンドラインで、 curl フォルダーに移動します。 ListTypeDefinitions_POST_ToInstance.sh スクリプトを実行します。
```
./ListTypeDefinitions_POST_ToInstance.sh
```
JSONレスポンスには、新しい選択リストが追加されたことが示されています。
```
"作成日" : "2022-11-17T18:42:13Z"、
"更新日" : "2022-11-17T18:42:13Z"、
"id" : 47502,
"listTypeEntries" : [ ],
"name" : "Foo",
"name_i18n" : {
   "en-US" : "Foo"
}
```
グローバルメニュー → コントロールパネル → 選択リスト に移動します。新しい選択リストが表示されます。
あるいは、Javaクライアントを使用してRESTサービスを呼び出すこともできます。 java フォルダに移動し、ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
ListTypeDefinitions_POST_ToInstance.java クラスを実行します。
```
java -classpath .:* ListTypeDefinitions_POST_ToInstance
```

cURLコマンドを調べてみましょう

ListTypeDefinitions_POST_ToInstance.sh スクリプトは、cURL を使用して REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions" \
	--data-raw '
		{
			"name": "Foo",
			"name_i18n": {
				"en_US": "Foo"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

コマンドの引数は以下のとおりです。

引数	説明
`-H "Content-Type: application/json"`	リクエストボディのフォーマットがJSONであることを示します。
`-X POST`	指定されたエンドポイントで起動するHTTPメソッド
`"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions"`	RESTサービスのエンドポイント
`-d "{\"name\": \"Foo\", \"name_i18n\": {\"en_US\": \"Foo\"}}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

注記

ここでは、デモンストレーション目的で基本認証を使用しています。本番環境では、 OAuth2 を介してユーザーを認証する必要があります。

他のcURLコマンドも同様のJSON引数を使用します。

Javaクラスを調べます

ListTypeDefinitions_POST_ToInstance.java クラスは、 ListType関連のサービスを呼び出すことで選択リストを追加します。

public static void main(String[] args) throws Exception {
	ListTypeDefinitionResource.Builder builder =
		ListTypeDefinitionResource.builder();

	ListTypeDefinitionResource listTypeDefinitionResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	ListTypeDefinition listTypeDefinition =
		listTypeDefinitionResource.postListTypeDefinition(
			new ListTypeDefinition() {
				{
					name = "Foo";
					name_i18n = Collections.singletonMap("en_US", "Foo");
				}
			});

	System.out.println(listTypeDefinition);
}

このクラスは、以下の3行のコードを使用してRESTサービスを呼び出します。

行（省略形）	説明
`ListTypeDefinitionResource.Builder builder = ...`	`ListTypeDefinitionResource`サービスインスタンスを生成するための`Builder`を取得します。
`ListTypeDefinitionResource listTypeDefinitionResource = builder.authentication(...).build();`	基本認証を指定し、`ListTypeDefinitionResource`サービスインスタンスを生成します。
`ListTypeDefinition listTypeDefinitionResource = listTypeDefinitionResource.postListTypeDefinition(...);`	`listTypeDefinitionResource.postListTypeDefinition`メソッドを呼び出し、投稿するデータを渡します。

プロジェクトには com.liferay.headless.admin.list.type.client ファイルが依存関係として含まれていることに注意してください。すべての REST アプリケーションのクライアント JAR 依存関係情報は、インストール先の API エクスプローラーで /o/api (例: http://localhost:8080/o/api ) で確認できます。

注記

main メソッドのコメントは、クラスを実行する方法を示しています。

他の Java クラスも同様に、異なる ListTypeDefinitionResource メソッドを呼び出します。

重要

サービスの詳細については、 ListTypeDefinitionResource を参照してください。

以下は、cURL と Java を使用して他の ListTypeDefinition REST サービスを呼び出す例です。

インスタンスから選択リストを取得する

以下のcURLコマンドまたはJavaコマンドを実行することで、選択リストの一覧を表示できます。

ListTypeDefinitions_GET_FromInstance.sh

コマンド：

./ListTypeDefinitions_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions" \
	--user "test@liferay.com:learn"

ListTypeDefinitions_GET_FromInstance.java

コマンド:

java -classpath .:* ListTypeDefinitions_GET_FromInstance

コード:

public static void main(String[] args) throws Exception {
	ListTypeDefinitionResource.Builder builder =
		ListTypeDefinitionResource.builder();

	ListTypeDefinitionResource listTypeDefinitionResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	Page<ListTypeDefinition> page =
		listTypeDefinitionResource.getListTypeDefinitionsPage(
			null, null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスの ピックリスト オブジェクトが JSON に表示されます。

ピックリストを取得する

以下のcURLまたはJavaコマンドを使用して、特定の選択リストを取得します。

ヒント

ListTypeDefinitions_GET_FromInstance.[java|sh] を使用して、インスタンス の選択リスト ID を取得します。

ListTypeDefinitions_GET_ById.sh

コマンド：

./ListTypeDefinitions_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions/${1}" \
	--user "test@liferay.com:learn"

ListTypeDefinitions_GET_ById.java

コマンド：

java -classpath .:* -DlistTypeDefinitionId=1234 ListTypeDefinitions_GET_ById

コード：

public static void main(String[] args) throws Exception {
	ListTypeDefinitionResource.Builder builder =
		ListTypeDefinitionResource.builder();

	ListTypeDefinitionResource listTypeDefinitionResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	System.out.println(
		listTypeDefinitionResource.getListTypeDefinition(
			Long.valueOf(System.getProperty("listTypeDefinitionId"))));
}

選択リスト フィールドは JSON に表示されます。

ピックリストをパッチする

cURLとJavaのpatchコマンドを使用して、既存の選択リストを編集します。 1234 を、選択リストの ID に置き換えてください。

ListTypeDefinitions_PATCH_ById.sh

コマンド：

./ListTypeDefinitions_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions/${1}" \
	--data-raw '
		{
			"name": "Bar",
			"name_i18n": {
				"en_US": "Bar"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

ListTypeDefinitions_PATCH_ById.java

コマンド：

java -classpath .:* -DlistTypeDefinitionId=1234 ListTypeDefinitions_PATCH_ById

コード：

public static void main(String[] args) throws Exception {
	ListTypeDefinitionResource.Builder builder =
		ListTypeDefinitionResource.builder();

	ListTypeDefinitionResource listTypeDefinitionResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	ListTypeDefinition listTypeDefinition =
		listTypeDefinitionResource.patchListTypeDefinition(
			Long.valueOf(System.getProperty("listTypeDefinitionId")),
			new ListTypeDefinition() {
				{
					name = "Bar";
					name_i18n = Collections.singletonMap("en_US", "Bar");
				}
			});

	System.out.println(listTypeDefinition);
}

選択リストを作成する

cURL と Java put コマンドを使用して、既存の選択リストを完全に上書きします。 1234 を、選択リストの ID に置き換えてください。

ListTypeDefinitions_PUT_ById.sh

コマンド：

./ListTypeDefinitions_PUT_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions/${1}" \
	--data-raw '
		{
			"name": "Goo",
			"name_i18n": {
				"en_US": "Goo"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "PUT" \
	--user "test@liferay.com:learn"

ListTypeDefinitions_PUT_ById.java

コマンド:

java -classpath .:* -DlistTypeDefinitionId=1234 ListTypeDefinitions_PUT_ById

コード：

public static void main(String[] args) throws Exception {
	ListTypeDefinitionResource.Builder builder =
		ListTypeDefinitionResource.builder();

	ListTypeDefinitionResource listTypeDefinitionResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	ListTypeDefinition listTypeDefinition =
		listTypeDefinitionResource.putListTypeDefinition(
			Long.valueOf(System.getProperty("listTypeDefinitionId")),
			new ListTypeDefinition() {
				{
					name = "Goo";
					name_i18n = Collections.singletonMap("en_US", "Goo");
				}
			});

	System.out.println(listTypeDefinition);
}

選択リストを削除する

cURLとJava delete コマンドを使用して、既存の選択リストを削除します。 1234 を、選択リストの ID に置き換えてください。

ListTypeDefinitions_DELETE_ById.sh

コマンド：

./Picklist_DELETE_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-admin-list-type/v1.0/list-type-definitions/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

ListTypeDefinitions_DELETE_ById.java

指示

java -classpath .:* -DlistTypeDefinitionId=1234 ListTypeDefinitions_DELETE_ById

コード：

public static void main(String[] args) throws Exception {
	ListTypeDefinitionResource.Builder builder =
		ListTypeDefinitionResource.builder();

	ListTypeDefinitionResource listTypeDefinitionResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	listTypeDefinitionResource.deleteListTypeDefinition(
		Long.valueOf(System.getProperty("listTypeDefinitionId")));
}

ピックリスト入力サービス

選択リストを作成したら、以下のサービスを使用して選択リストのエントリを作成および管理します。 ListTypeEntry の cURL コマンドと Java クラスは、 ListTypeDefinition のように動作します。一部のサービスでは、選択リストIDを渡す必要があります。

ファイル	説明
`ListTypeEntries_GET_FromListTypeDefinition.[java\\|sh]`	候補リストから候補リストエントリーの一覧を取得します。
`ListTypeEntries_DELETE_ById.[java\\|sh]`	候補リストエントリーを削除します。
`ListTypeEntries_GET_ById[java\\|sh]`	IDで特定の候補リストエントリーを取得します。
`ListTypeEntries_POST_ToListTypeDefinition.[java\\|sh]`	候補リストにエントリーを投稿します。
`ListTypeEntries_PUT_ById.[java\\|sh]`	候補リストエントリーを配置します。