候補リストAPIの基本

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"

ここでは、コマンドの引数を紹介します。

他の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サービスを呼び出します。

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

他のJavaクラスも同様に、異なる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);
}

インスタンスのPicklistオブジェクトがJSONで表示されます。

候補リストを取得する

以下のcURLまたはJavaコマンドで、特定の候補リストを取得します。

リストタイプ定義_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"

リストタイプ定義_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"))));
}

PicklistフィールドはJSONで表示されます。

候補リストへのパッチ

cURLとJavaパッチコマンドで、既存の候補リストを編集します。 1234を候補リストのIDに置き換えます。

リストタイプ定義_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"

リストタイプ定義_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に置き換えます。

リストタイプ定義_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"

リストタイプ定義_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に置き換えます。

リストタイプ定義_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"

リストタイプ定義_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を渡す必要があります。

API エクスプローラー には、すべての ListTypeDefinition および ListTypeEntry サービスとスキーマが表示され、各サービスをテストするためのインターフェースがあります。

関連トピック

• ピックリストの作成
• 候補リストのエクスポートとインポート