ヘッドレスフレームワークの統合
対応可能：Liferay DXP/Portal 7.4以降
オブジェクトを公開すると、Liferayは自動的にそのためのREST APIを生成します。 これにより、カスタムオブジェクトにヘッドレスでアクセスできるようになり、CRUD操作を実行できるようになります。 オブジェクト用に生成されたAPIは、その範囲（つまり、CompanyまたはSite）によって異なります。
すべてのオブジェクトは、c/[pluralobjectlabel]命名パターン（c/timeoffrequestsなど）を使用します。 各オブジェクトエントリースキーマには、オブジェクトのすべてのフィールドとリレーションシップが含まれています。
オブジェクトのAPIは、Liferay API Explorerを介して[server]:[port]/o/api（例：localhost:8080/o/api）で表示およびテストできます。 REST APIは、 ［REST Applications］ の下にリストされています。
オブジェクトREST APIs
REST APIを使用すると、オブジェクトエントリーに対して単一およびバッチの両方のCRUD操作を実行できます。 集約用語とネストされたフィールドを使って、複雑なクエリを実行することもできます。
すべてのエンドポイントとJavaメソッドは、オブジェクトの名前を使用します。 以下の例では、ObjectNameとobjectNameをオブジェクトの名前に置き換えてください。
Liferay DXP 7.4 GA1では、選択リストフィールドの値は、オブジェクトAPIコールで以下のフォーマットを使用する必要があります。"samplePicklist":"string"です。 Liferay DXP 7.4 U1では、フォーマットが変更され、値はこのフォーマットを使用する必要があります。"samplePicklist":{"key":"string"}.
会社に範囲指定されているオブジェクト
次のREST APIは、すべての会社に範囲指定されているオブジェクトで使用できます。
| HTTP メソッド | HTTPエンドポイント | Javaメソッド | 説明 |
|---|---|---|---|
| DELETE | /by-external-reference-code/{externalReferenceCode} |
deleteByExternalReferenceCode |
外部参照コードを使用して、指定されたオブジェクトエントリーを削除します |
| GET | /by-external-reference-code/{externalReferenceCode} |
getByExternalReferenceCode |
外部参照コードを使用して、指定されたオブジェクトエントリーの詳細を返します |
| PUT | /by-external-reference-code/{externalReferenceCode} |
putByExternalReferenceCode |
指定されたオブジェクトエントリーの詳細を、外部参照コードを使用してAPI呼び出しで提供されたものに置き換えます |
| GET | / |
getObjectNamePage |
Liferayインスタンスのオブジェクトエントリーの完全なリストを返します。結果は、ページ分割、絞り込み、検索、およびソートが可能です |
| POST | / |
postObjectName |
APIコールで提供された詳細を使用して、新しいオブジェクトエントリーを作成します |
| DELETE | /batch |
deleteObjectNameBatch |
複数のオブジェクトエントリーを削除します |
| POST | /batch |
postObjectNameBatch |
API呼び出しで提供された詳細を使用して複数のオブジェクトエントリーを作成します |
| PUT | /batch |
putObjectNameBatch |
API呼び出しで提供された詳細を使用して、複数のオブジェクトエントリーを置き換えます |
| DELETE | /{objectNameId} |
deleteObjectName |
指定されたオブジェクトエントリーを削除し、操作が成功した場合は204を返します |
| GET | /{objectNameId} |
getObjectName |
指定されたオブジェクトエントリーの詳細を返します |
| PATCH | /{objectNameId} |
patchObjectName |
指定されたオブジェクトエントリーのAPI呼び出しで指定されたフィールドを更新します。他のフィールドは変更されません |
| PUT | /{objectNameId} |
putObjectName |
指定されたオブジェクトエントリーの詳細を、API呼び出しで提供されたものに置き換えます |
サイトに範囲指定されたオブジェクト
次のREST APIは、すべてのサイトに範囲指定されているオブジェクトで使用できます。
| HTTP メソッド | HTTPエンドポイント | Javaメソッド | 説明 |
|---|---|---|---|
| DELETE | /scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode} |
deleteScopeScopeKeyByExternalReferenceCode |
スコープキーと外部参照コードを使用して、指定されたオブジェクトエントリーを削除します |
| GET | /scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode} |
getScopeScopeKeyByExternalReferenceCode |
スコープキーと外部参照コードを使用して、指定されたオブジェクトエントリーの詳細を返します |
| PUT | /scopes/{scopeKey}/by-external-reference-code/{externalReferenceCode} |
putScopeScopeKeyByExternalReferenceCode |
指定されたオブジェクトエントリーの詳細を、そのスコープキーと外部参照コードを使用してAPI呼び出しで提供されたものに置き換えます |
| GET | /scopes/{scopesKey} |
getScopeScopeKeyPage |
サイトのオブジェクトエントリーの完全なリストを返します。結果は、ページ分割、絞り込み、検索、およびソートが可能です |
| POST | /scopes/{scopesKey} |
postScopeScopeKey |
API呼び出しで提供された詳細を使用して、指定されたサイトに新しいオブジェクトエントリーを作成します |
| DELETE | /{objectNameId} |
deleteObjectName |
指定されたオブジェクトエントリーを削除します |
| GET | /{objectNameId} |
getObjectName |
指定されたオブジェクトエントリーの詳細を返します |
| PATCH | /{objectNameId} |
patchObjectName |
指定されたオブジェクトエントリーのAPI呼び出しで指定されたフィールドを更新します。他のフィールドは変更されません |
| PUT | /{objectNameId} |
putObjectName |
指定されたオブジェクトエントリーの詳細を、API呼び出しで提供されたものに置き換えます |
APIの scopesKeyパラメーターには、目的のデータスコープの適切な識別子（サイトID、ユーザーロールなど）を使用します。