Site Search - Liferay Learn

Using Batch APIs When you publish an Object, Liferay automatically generates REST APIs for it. These include the batch APIs for bulk POST, PUT, and DELETE operations. Here you'll use cURL commands...

nestedFieldsを使用して関連エントリをクエリする

Official Documentation

Using nestedFields to Query Related Entries Liferay 7.4 U69+/GA69+ The nestedFields parameter returns multiple levels of related object entries in a single GET request. Pass the nestedFields...

候補リストAPIの基本

Official Documentation

Picklists API Basics Liferay provides the headless-admin-list-types REST APIs for creating and managing picklist definitions (ListTypeDefinition) and their entries (ListTypeEntry). You can view and...

検索API

Official Documentation

Search APIs Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search with headless APIs using the endpoints at /o/search. These are the primary endpoints: Use the GET /search...

カスタムオブジェクトAPI

Official Documentation

Custom Object APIs Liferay 7.4+ When you publish a custom object definition, Liferay generates default REST APIs for interacting with the object and its data. These APIs vary depending on the...

SCIM リソースタイプ、サービスプロバイダー、スキーマの基本

Official Documentation

SCIM Resource Type, Service Provider, and Schema Basics Liferay DXP 2025.Q2+ Liferay provides a headless API to query the SCIM resource types, service providers, and schemas available. Use the...

Base64 エンコードされたファイルでオブジェクト API を使用する

Official Documentation

Using Object APIs With Base64 Encoded Files Liferay DXP 2024.Q2+/Portal GA120+ When creating object entries with attachment fields through APIs, you can generally upload files from your computer...

ワークフロー定義リンクAPIの基本

Official Documentation

Workflow Definition Link API Basics Liferay DXP 2025.Q1+/Portal GA132+ You can manage workflow definition links from the Liferay UI or using Liferay's REST APIs. In Liferay, the Control Panel →...

APIクエリパラメーター

Official Documentation

API Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Fields Parameter Use this parameter to specify and...

GraphQL APIの使用

Official Documentation

Consuming GraphQL APIs Liferay DXP contains GraphQL APIs for most of its applications. The GraphQL APIs are available at http://[host]:[port]/o/graphql. Here's how to consume them in three steps: ...

検索APIの基本

Official Documentation

Search API Basics Generally Available in Liferay DXP 2025.Q4+/Portal 2026.Q1+ You can search for content from a Liferay search page, but you can also use the /search API endpoints. If you're...

アカウントユーザーとロールのAPI

Official Documentation

Account Users and Roles APIs You can manage Account Users and Account Roles from the Applications menu, but you can also use Liferay's REST APIs. Call these services to create and manage account...

UADフレームワークの追加

Official Documentation

Adding the UAD Framework You can manage and delete user data with Liferay's User Associated Data (UAD) management tool. The tool is available out-of-the-box for many of Liferay's applications (e.g....

郵便番号APIの基礎

Official Documentation

Postal Address API Basics Liferay DXP/Portal 7.4+ Use Liferay's REST APIs to manage postal addresses. Add Postal Address to Account Then, follow these steps: Download and unzip Postal Address...

アカウントグループ API の基礎

Official Documentation

Account Groups API Basics Liferay DXP/Portal 7.4+ You can manage account groups from the Applications menu or use Liferay's REST APIs. Call these services to create and manage account groups. ...

検索候補API

Official Documentation

Search Suggestions API DXP 7.4 U36+/Portal GA36+ You can return suggestions using the /suggestions headless API. This API is used by Liferay's Search Bar Suggestions feature. There are two primary...

アカウントAPIの基本

Official Documentation

Accounts API Basics Liferay DXP/Portal 7.4+ You can manage accounts from the Applications menu or use Liferay's REST APIs. Call these services to create and manage accounts. Adding an Account ...

国別APIの基礎

Official Documentation

Countries API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's Rest APIs to create and manage countries. Adding a Country Then, follow these steps: Download and unzip Countries API Basics. ...

組織APIの基礎

Official Documentation

Organizations API Basics You can Create and Manage Organizations from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage organizations. Adding an...

リージョンAPIの基礎

Official Documentation

Regions API Basics Liferay 7.4 U24+ and GA24+ Use Liferay's REST APIs to create and manage regions. Adding a Region Then, follow these steps: Download and unzip Regions API Basics. curl...

ユーザーアカウントAPIの基本

Official Documentation

User Account API Basics You can add and manage users from the Control Panel, but you can also use Liferay's REST APIs. You can call these services to add, edit, delete users. Start with adding a...

ロールAPIの基本

Official Documentation

Roles API Basics You can create and manage roles from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage roles. Associate a User to a Regular Role Then,...

ユーザーグループ API の基本

Official Documentation

User Groups API Basics You can Create and Manage User Groups from the Application menu, but you can also use Liferay's REST APIs. Call these services to manage user groups. Adding a User Group ...

APIヘッダーリファレンス

Official Documentation

API Headers Reference API headers are components of HTTP requests that provide essential information to the server about the client's request and how the server should handle it. You can use API...

外部参照コードの使用

Official Documentation

Using External Reference Codes Liferay DXP/Portal 7.4+ Many of Liferay's headless API endpoints support an external reference code (ERC). The ERC field is useful in wide range of scenarios. For...

JWTベアラーフローの設定

Official Documentation

Configuring the JWT Bearer Flow To use JWT Bearer as a grant type in Liferay, you must create an OAuth 2 client with the Client Authentication Method set to Client Secret Basic or Post. The client...

JWTアクセストークンの発行

Official Documentation

Issuing JWT Access Tokens Liferay DXP 7.4 U45+/GA45+ You can configure Liferay to issue access tokens in the JWT format from System Settings. Enabling JWT Tokens Open the Global Menu...

OAuth2によるユーザーの認証

Official Documentation

Using OAuth2 to Authorize Users You can create applications that access Liferay's headless REST APIs using the OAuth 2.0 authorization protocol. The provided sample React app demonstrates three...

OAuth 2のスコープ

Official Documentation

OAuth 2 Scopes In OAuth 2.0, applications are granted access to limited subsets of user data. These are called scopes (not to be confused with Liferay scopes). You can create them in two ways: ...

RESTビルダーを使用したAPIの作成と実装

Official Documentation

Producing and Implementing APIs with REST Builder With REST Builder, you can define the API you want to build, and REST Builder provides the framework and endpoints for you. Deploy an Example REST...

CamundaからLiferay APIを呼び出す

Official Documentation

Calling Liferay APIs from Camunda The Liferay Connector enables calling Liferay APIs from your Camunda tasks. It's a protocol connector built on top of the Camunda HTTP REST connector. Follow...

Camundaビジネスプロセスの使用

Official Documentation

Using Camunda Business Processes Liferay 7.4+, and all quarterly releases Liferay's native workflow features are designed for business processes requiring basic review and approval. If your...

データセット

Official Documentation

Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Data sets are like virtual containers that help organize and manage related...

フォームの作成

Official Documentation

Creating Forms You can create multi-field forms with the Forms application. Only authenticated users with the requisite permissions can create forms. At minimum, they should have permission to...

フォーム

Official Documentation

Forms The Forms application is in maintenance mode as of Liferay DXP 2024.Q4/Portal GA129. Migrate your forms to objects and form container fragments to future-proof your solutions. You can use...

条件付きフィールドを使用したフォームの作成

Official Documentation

Building Forms with Conditional Fields Forms can become dynamic forms where the answer to one question may allow the respondent to skip the next three questions, or require the respondent to answer...

自動保存動作のカスタマイズ

Official Documentation

Customizing Auto-Save Behavior The Forms application automatically saves the form creation progress as you create a form. By default, a form's draft is auto-saved every minute. To change the...

フォームレイアウトのカスタマイズ

Official Documentation

Customizing Form Layouts By default, new elements on your form are added to a new row and occupy the entire width of the form. Form with all elements occupying entire width of form. Sometimes it...

送信ボタンのカスタマイズ

Official Documentation

Customizing the Submit Button Available 7.4+ When a User is finished entering data into a form, they must submit the form. By default a button that says Submit is displayed for this purpose. ...

フィールドの自動補完

Official Documentation

Field Autocompletion You can configure form field autocompletion in the Forms application: Autocompletion TypeConfigurationField Types ManualType a list of autocompletion optionsText Data...

Search Results