組織 API の基本
アプリケーションメニューから Create and Manage Organizations を利用できますが、Liferay の REST API を利用することもできます。 組織を管理するためにこれらのサービスを呼び出す。
組織の追加
新しいLiferay DXPインスタンスを起動し、以下を実行します。
docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q1.1。
メールアドレス test@liferay.com とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。
次に、以下の手順に従います。
-
Organizations API Basics をダウンロードして解凍する。
curl https://resources.learn.liferay.com/dxp/latest/en/users-and-permissions/developer-guide/liferay-w2h3.zip -O
unzip liferay-w2h3.zip
-
cURL スクリプトを使用して、インスタンスに新しい組織を追加します。 コマンドラインで
curl
フォルダに移動します。Organization_POST_ToInstance.sh
スクリプトを実行する。./Organization_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": [] } }
-
Global Menu → Control Panel → User and Organizations に移動します。 Organizationsタブをクリックします。 新しい組織が追加されたことを確認する。
-
RESTサービスは、Javaクライアントを使って呼び出すこともできます。
curl
フォルダからjava
フォルダに移動します。 以下のコマンドでソースファイルをコンパイルします。javac -classpath .:* *.java
-
Organization_POST_ToInstance.java
クラスを以下のコマンドで実行する。java -classpath .:* Organization_POST_ToInstance
cURLコマンドの検証
Organization_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クラスを調べる
Organization_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サービスを呼び出します。
行(省略形) | 説明 |
---|---|
OrganizationResource.Builder builder = ... | OrganizationResource サービスインスタンスを生成するためのBuilder を取得する。 |
OrganizationResource organizationResource = builder.authentication(...).build(); | 基本認証を指定し、OrganizationResource サービスインスタンスを生成する。 |
Organization organization = organizationResource.postOrganization(...); | organizationResource.postOrganization メソッドを呼び出し、データをpostに渡す。 |
このプロジェクトには依存関係として com.liferay.headless.admin.user.client.jar
ファイルが含まれていることに注意してください。 すべての REST アプリケーションのクライアント JAR 依存情報は、インストー ルの API エクスプローラーの /o/api
にある。
main
メソッドのコメントは、クラスの実行を示している。
他のJavaクラスの例もこれと似ているが、異なる OrganizationResource
メソッドを呼び出している。
サービスの詳細は OrganizationResource を参照のこと。
以下は、cURLとJavaを使って他のOrganization
RESTサービスを呼び出す例である。
インスタンスから組織を取得する
以下のcURLまたはJavaコマンドを実行することで、Organizationsをリストアップできる。
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);
}
インスタンスの Organization
オブジェクトは JSON で表示される。
組織を作る
以下のcURLまたはJavaコマンドで特定の組織を取得する。
インスタンスの 組織
ID を取得するには Organizations_GET_FromInstance.[java|sh]
を使用します。
組織_GET_ById.sh
コマンド:
./Organization_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 Organization_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"))));
}
Organization
フィールドはJSONで表示される。
組織にパッチを当てる
以下のcURLとJavaコマンドを使って、既存の組織を部分的に編集する。 1234
をあなたの組織のIDに置き換えてください。
Organization_PATCH_ById.sh
コマンド:
./Organization_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"
Organization_PATCH_ById.java
コマンド:
java -classpath .:* -DorganizationId=1234 Organization_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に置き換えてください。
Organization_PUT_ById.sh
コマンド:
./Organization_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"
Organization_PUT_ById.java
コマンド:
java -classpath .:* -DorganizationId=1234 Organization_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に置き換えてください。
Organization_DELETE_ById.sh
コマンド:
./Organization_DELETE_ById.sh 1234
コード:
curl \
"http://localhost:8080/o/headless-admin-user/v1.0/organizations/${1}" \
--request "DELETE" \
--user "test@liferay.com:learn"
Organization_DELETE_ById.java
コマンド
java -classpath .:* -DorganizationId=1234 Organization_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 Explorer には、すべての Organization
サービスとスキーマが表示され、各サービスを試すためのインターフェイスが用意されている。