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

組織向けAPIの基本

アプリケーションメニューから組織の作成と管理ができますが、LiferayのREST APIを使うこともできます。組織運営については、これらのサービスをご利用ください。

組織を追加する

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

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

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

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

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

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

unzip liferay-w2h3.zip

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": []
  }
}

グローバルメニュー → コントロールパネル → ユーザーと組織 に移動します。組織タブをクリックします。新しい組織が追加されていることを確認してください。
RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。以下のコマンドでソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
以下のコマンドで 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"

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

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

注

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

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

Javaクラスを調べる

Organizations_POST_ToInstance.java クラスは、 OrganizationResource サービスを呼び出すことで組織を追加します。

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

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

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

注

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

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

重要

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

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

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

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

Organizations_GET_FromInstance.sh

コマンド：

./Organizations_GET_FromInstance.sh

コード：

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

Organizations_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コマンドを使用して、特定の組織を取得します。

ヒント

Organizations_GET_FromInstance.[java|sh] を使用して、インスタンス Organization ID を取得します。

Organizations_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"

Organizations_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 に置き換えてください。

Organizations_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"

Organizations_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 に置き換えてください。

Organizations_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"

Organizations_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 に置き換えてください。

Organizations_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"

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

注

PostalAddresses_GET_FromOrganization を使用して組織の郵便住所を取得します。

Capability: