組織APIの基礎

アプリケーション メニューから 組織の作成と管理 を行うことができますが、Liferay の REST API を使用することもできます。 組織を管理するには、これらのサービスを呼び出します。

組織の追加

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

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

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

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

1. Organizations API Basicsをダウンロードして解凍します。

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

   unzip liferay-w2h3.zip
   

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

   ./Organizations_POST_ToInstance.sh
   

   JSON 応答には、新しい組織が追加されたことが示されています。

   {
     "comment": "",
     "customFields": [],
     "dateCreated": "2022-05-19T17:38:19Z",
     "dateModified": "2022-05-19T17:38:19Z",
     "externalReferenceCode": "",
     "id": "40922",
     "keywords": [],
     "location": {},
     "name": "Able",
     "numberOfAccounts": 0,
     "numberOfOrganizations": 0,
     "numberOfUsers": 0,
     "organizationContactInformation": {
       "emailAddresses": [],
       "postalAddresses": [],
       "telephones": [],
       "webUrls": []
     }
   }
   

3. グローバル メニュー → コントロール パネル → ユーザーと組織に移動します。 組織 タブをクリックします。 新しい組織が追加されたことを確認します。

   

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

   javac -classpath .:* *.java
   

5. 次のコマンドで Organizations_POST_ToInstance.java クラスを実行します。

   java -classpath .:* Organizations_POST_ToInstance
   

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-admin-user/v1.0/organizations" \
	--data-raw '
		{
			"name": "Able"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

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

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

Javaクラスを調べる

Organizations_POST_ToInstance.java クラスは、Organization 関連のサービスを呼び出して組織を追加します。

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

	OrganizationResource organizationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Organization organization = organizationResource.postOrganization(
		new Organization() {
			{
				name = "Dog";
			}
		});

	System.out.println(organization);
}

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

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

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

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

インスタンスから組織を取得する

次の cURL または Java コマンドを実行すると、組織を一覧表示できます。

組織_GET_FromInstance.sh

コマンド：

./Organizations_GET_FromInstance.sh

コード：

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

組織_GET_FromInstance.java

コマンド：

java -classpath .:* Organizations_GET_FromInstance

コード：

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

	OrganizationResource organizationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<Organization> page = organizationResource.getOrganizationsPage(
		null, null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

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

組織を取得する

次の cURL または Java コマンドを使用して特定の組織を取得します。

組織_GET_ById.sh

コマンド：

./Organizations_GET_ById.sh 1234

コード：

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

組織_GET_ById.java

コマンド：

java -classpath .:* -DorganizationId=1234 Organizations_GET_ById

コード：

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

	OrganizationResource organizationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	System.out.println(
		organizationResource.getOrganization(
			String.valueOf(System.getProperty("organizationId"))));
}

組織 フィールドが JSON に表示されます。

組織にパッチを適用する

次の cURL および Java コマンドを使用して、既存の組織の部分的な編集を行います。 1234 を組織の ID に置き換えます。

組織_PATCH_ById.sh

コマンド：

./Organizations_PATCH_ById.sh 1234

コード：

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

組織_PATCH_ById.java

コマンド：

java -classpath .:* -DorganizationId=1234 Organizations_PATCH_ById

コード：

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

	OrganizationResource organizationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Organization organization = organizationResource.patchOrganization(
		String.valueOf(System.getProperty("organizationId")),
		new Organization() {
			{
				name = "Easy";
			}
		});

	System.out.println(organization);
}

組織を置く

次の cURL および Java コマンドを使用して、既存の組織を完全に上書きします。 1234 を組織の ID に置き換えます。

組織_PUT_ById.sh

コマンド：

./Organizations_PUT_ById.sh 1234

コード：

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

組織_PUT_ById.java

コマンド：

java -classpath .:* -DorganizationId=1234 Organizations_PUT_ById

コード：

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

	OrganizationResource organizationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Organization organization = organizationResource.putOrganization(
		String.valueOf(System.getProperty("organizationId")),
		new Organization() {
			{
				name = "Fox";
			}
		});

	System.out.println(organization);
}

組織を削除する

次の cURL および Java コマンドを使用して、既存の組織を削除します。 1234 を組織の ID に置き換えます。

組織_DELETE_ById.sh

コマンド：

./Organizations_DELETE_ById.sh 1234

コード:

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

組織_DELETE_ById.java

コマンド

java -classpath .:* -DorganizationId=1234 Organizations_DELETE_ById

コード：

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

	OrganizationResource organizationResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	organizationResource.deleteOrganization(
		String.valueOf(System.getProperty("organizationId")));
}

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