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

リージョンAPIの基本

Liferay 7.4 U24+ および GA24+

LiferayのREST APIを使用してリージョンを作成および管理します。

地域を追加する

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 に変更してください。

次に、以下の手順に従います。

  1. Regions API の基本 をダウンロードして解凍します。

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

    unzip liferay-r2p3.zip

  2. cURLスクリプトを使用して、国に新しい地域を追加します。 コマンドラインで、 curl フォルダーに移動します。 Regions_POST_ToCountry.sh スクリプトを実行します。

    ./Regions_POST_ToCountry.sh 1234

    1234 を国のIDに置き換えてください。 ID のリストを取得するには、 インスタンス から国を取得します。

    JSONレスポンスには、新しいリージョンが追加されたことが示されています。

    {
  "active" : true,
  "countryId" : 43501,
  "id" : 43503,
  "name" : "Foo"、
  "position" : 0.0、
  "regionCode" : "ABL"、
  "title_i18n" : { }
}

  3. RESTサービスはJavaクライアントを使用して呼び出すこともできます。 curl フォルダから java フォルダに移動します。 ソースファイルをコンパイルします。

    javac -classpath .:* *.java

  4. Regions_POST_ToCountry.java クラスを実行します。

    java -classpath .:* -DcountryId=1234 Regions_POST_ToCountry

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

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

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/countries/${1}/regions" \
	--data-raw '
		{
			"name": "Foo",
			"regionCode": "ABL"
		}' \
	--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-address/v1.0/countries/${1}/regions"RESTサービスのエンドポイント
-d "{\"name\": \"Foo\", \"regionCode\": \"ABL\"}"お客様が掲載を希望するデータ
-u "test@liferay.com:learn"基本的な認証情報
注記

ここでは、デモンストレーション目的で基本認証を使用しています。 本番環境では、 OAuth2 を介してユーザーを認証する必要があります。 OAuth2 を使用する React アプリケーションの例については、 OAuth2 を使用してユーザーを認証する を参照してください。

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

Javaクラスを調べます

Regions_POST_ToCountry.java クラスは、 RegionResource サービスを呼び出すことでリージョンを追加します。

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

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.postCountryRegion(
		Long.valueOf(System.getProperty("countryId")),
		new Region() {
			{
				name = "Foo";
				regionCode = "ABL";
			}
		});

	System.out.println(region);
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

行（省略形）説明
RegionResource.Builder builder = ...Builder を取得して、 RegionResource サービス インスタンスを生成します。
RegionResource regionResource = builder.authentication(...).build();基本認証を指定し、 RegionResource サービス インスタンスを生成します。
Region region = regionResource.postRegion(...);regionResource.postRegion メソッドを呼び出し、データを post に渡します。

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

注記

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

他の例の Java クラスはこれに似ていますが、異なる RegionResource メソッドを呼び出します。

重要

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

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

インスタンスからリージョンを取得する

以下のcURLコマンドまたはJavaコマンドを実行することで、地域の一覧を表示できます。

Regions_GET_FromInstance.sh

コマンド：

./Regions_GET_FromInstance.sh

コード：

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

Regions_GET_FromInstance.java

コマンド:

java -classpath .:* Regions_GET_FromInstance

コード:

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

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	ページ<Region> page = regionResource.getRegionsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

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

地域を取得する

以下のcURLまたはJavaコマンドを使用して、特定の領域を取得します。

ヒント

Regions_GET_FromInstance.[java|sh] を使用して、インスタンス リージョン ID を取得します。

Regions_GET_ById.sh

コマンド：

./Regions_GET_ById.sh 1234

コード：

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

Regions_GET_ById.java

コマンド：

java -classpath .:* -DregionId=1234 Regions_GET_ById

コード：

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

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		regionResource.getRegion(
			Long.valueOf(System.getProperty("regionId"))));
}

リージョン フィールドは JSON に表示されます。

地域をパッチする

以下のcURLコマンドとJavaコマンドを使用して、既存のリージョンを部分的に編集します。 1234 をあなたの地域の ID に置き換えてください。

Regions_PATCH_ById.sh

コマンド：

./Regions_PATCH_ById.sh 1234

コード：

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

Regions_PATCH_ById.java

コマンド：

java -classpath .:* -DregionId=1234 Regions_PATCH_ById

コード：

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

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.patchRegion(
		Long.valueOf(System.getProperty("regionId")),
		new Region() {
			{
				name = "Bar";
			}
		});

	System.out.println(region);
}

地域を配置する

以下のcURLコマンドとJavaコマンドを使用して、既存の領域を完全に上書きします。 1234 をあなたの地域の ID に置き換えてください。

Regions_PUT_ById.sh

コマンド：

./Regions_PUT_ById.sh 1234

コード：

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

Regions_PUT_ById.java

コマンド:

java -classpath .:* -DregionId=1234 Regions_PUT_ById

コード：

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

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.putRegion(
		Long.valueOf(System.getProperty("regionId")),
		new Region() {
			{
				name = "Goo";
				regionCode = "ABL";
			}
		});

	System.out.println(region);
}

リージョンを削除する

以下のcURLコマンドとJavaコマンドを使用して、既存のリージョンを削除します。 1234 をあなたの地域の ID に置き換えてください。

Regions_DELETE_ById.sh

コマンド：

./Regions_DELETE_ById.sh 1234

コード:

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

Regions_DELETE_ById.java

指示

java -classpath .:* -DregionId=1234 Regions_DELETE_ById

コード:

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

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	regionResource.deleteRegion(
		Long.valueOf(System.getProperty("regionId")));
}

API エクスプローラー には、 リージョン のすべてのサービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。

バッチエンジンによる地域管理

Regions API は、 com.liferay.headless.admin.address.dto.v1_0.Region エンティティ クラス名を使用して、Liferay インスタンス間でリージョンを移行するためのバッチ エクスポートとインポートをサポートしています。

リージョンエクスポートは、他のエンティティと同様に機能します。 リージョンのインポートには親国が必要です。 /o/headless-admin-address/v1.0/countries/{countryId}/regions/batchに POST するか、汎用インポートタスクエンドポイントで countryId をパラメータとして指定します。 それが含まれていないインポートはエラーを返します。

エクスポート/インポートUIでは、地域は選択可能なエンティティタイプとして表示されません。 そこで彼らは、国の輸出品の中に包み込まれて旅をする。 バッチエンジンによる国別管理 を参照してください。

バッチ エンジンの使用方法の詳細については、 バッチ エンジン API を使用したデータのエクスポート および バッチ エンジン API を使用したデータのインポート を参照してください。

Capability:
Development and Tooling
Resource Type:
Official Documentation
Feature:
Data Frameworks
Deployment Approach:
Liferay PaaS
Liferay Self-Hosted