Search Results

All Results 6991
ソート
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
オブジェクトAPI
Object APIs You can use headless APIs to interface with objects and picklists. Here are resources to help you understand and integrate these APIs to enhance your ability to manage objects.
オブジェクトAPIの基本
Official Documentation
Object API Basics When you publish an Object, Liferay automatically generates REST APIs for it. These APIs differ for Company and Site scoped Objects, but they all use the c/[pluralobjectlabel]...
バッチAPIの使用
Official Documentation
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...
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...
GraphQL を使用したオブジェクトエントリの管理
Official Documentation
Managing Object Entries Using GraphQL You can use GraphQL to manage custom object entries in Liferay efficiently. This API framework simplifies data interaction and serves as an alternative to REST...
nestedFields を使用してエントリ履歴を監査する
Official Documentation
Using nestedFields to Audit Entry History Liferay 7.4 U72+/GA72+ When you enable entry history for an object definition, you can use the nestedFields parameter with REST APIs to audit entry...
関連REST APIの利用
Official Documentation
Using Relationship REST APIs Liferay 7.4 U70+/GA70+ When you add relationships to custom or system objects, Liferay generates REST endpoints for accessing those relationships. You can relate and...
REST APIでの集計用語の使用
Official Documentation
Using Aggregation Terms with REST APIs When querying Object entries using REST APIs, you can use an Object's fields as facet criteria for aggregating entry data. To do this, add the...
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
Notifications API Basics Liferay's headless delivery application provides REST and GraphQL services for subscribing to or unsubscribing from notifications for platform events across several default...
ワークフロー定義リンク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
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
Process Automation APIs You can use headless APIs to interface with automation features in Liferay DXP, including workflows. Here are resources to help you understand and integrate these APIs to...
アカウントユーザーとロールの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...
アカウント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 ...
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
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
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
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
Consuming APIs APIs, or Application Programming Interfaces, serve as the bridge between different software applications, allowing them to communicate and exchange data. By consuming external APIs,...
バッチエンジンAPIの基本 - データのエクスポート
Official Documentation
Batch Engine API Basics - Exporting Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to export data from Liferay. Exporting Data Then,...
ユーザーアカウント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...
ヘッドレスプラットフォームとしてのLiferayの使用
Using Liferay as a Headless Platform Liferay provides a suite of APIs that perform the same kinds of actions available in the web interface. This is essential when you must get data in a...
リージョン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 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 Query Parameters Whether you consume REST APIs or GraphQL APIs, different query parameters are available to help you filter the responses. Some endpoints do not make use of the filter, sort,...
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: ...
JSON Webサービスの構成
Official Documentation
Configuring JSON Web Services Liferay’s services are exposed as JSON web services out-of-the-box. This is enabled by default. You can access these services via the API page at...
データ移行センター
Official Documentation
Data Migration Center Liferay DXP 2023.Q4+/Portal GA102+ [Beta Feature](../../../../security-and-administration/administration/configuring-liferay/feature-flags.md#beta-feature-flags) Currently,...
サンプルAPIチュートリアル
Official Documentation
Sample API Tutorials Follow the links below for sample API tutorials that include example requests and example code. Building Applications (Objects) Custom Objects API Basics Custom Objects...
OAuth 2.0の使用
Official Documentation
Using OAuth 2.0 OAuth 2.0 is an industry-standard authorization protocol. Users with accounts on a Liferay-based website can share select credentials with various clients seamlessly. OAuth 2.0...
JWTベアラーフローの設定
Official Documentation
Configuring the JWT Bearer Flow The JWT Bearer flow trades a signed JWT from an external token service in exchange for an access token from Liferay. To use this flow, create an OAuth 2 client and...
JSON Web トークン (JWT)
Official Documentation
JSON Web Tokens (JWTs) JSON Web Tokens (JWTs) represent encoded data. They are compact, self-contained, and secure. There are two primary types of JSON Web Tokens: Encrypted JWT: ensures the...
外部参照コードの使用
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...
認証されていないリクエストを行う
Official Documentation
Making Unauthenticated Requests By default, Liferay DXP restricts API access for the sake of security, requiring authentication to get a valid response. However, in certain cases it may make sense...
OAuth2によるアカウントアクセスの承認
Official Documentation
Authorizing Account Access with OAuth2 Once you have an application registered, you can start authorizing users. To do that, you must construct the URL to the authorization server (Liferay DXP)....
クライアントシークレット JWT
Official Documentation
Client Secret JWT Liferay supports client secret JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion and signs it using the client secret....
秘密鍵 JWT (JSON Web Token) の使用
Official Documentation
Using Private Key JWT (JSON Web Token) Liferay supports private key JWT as an authentication method for OAuth 2 clients. In this flow, the client itself creates the assertion. Liferay authenticates...
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...
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: ...
JSON Web トークンアサーション
Official Documentation
JSON Web Token Assertions An assertion helps in sharing identity and security information across different domains. There are two uses for assertions: Authorization grants Client authentication...
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...
アプリビルダー
Official Documentation
App Builder Liferay CE/DXP 7.3 (deprecated and removed in 7.4) App Builder is a low-code application development solution for Liferay DXP. Build a data model, define the application's forms (for...
ローコード
Official Documentation
Low Code
ロール変更リクエストオブジェクトの作成
Official Documentation
Creating the Role Change Request Object Subscribers Consider a Human Resources application that collects employee requests to change Roles within the software engineering department: the Role...
JAX-RS
JAX-RS JAX-RS web services work in Liferay modules the same way they work outside of Liferay, though you must register the class in the OSGi framework. To learn how to create these applications,...
RESTビルダー
Official Documentation
REST Builder REST Builder is a code generation tool that makes it easy for you to take your local APIs and make them available on the web. It uses the OpenAPI Specification to generate REST and...
ワークフロー対応アプリケーションの作成
Official Documentation
Creating a Workflow Powered Application Subscribers Workflow Powered Applications require data from multiple stakeholders. These process-driven applications can go through multiple stages before...
ロール変更リクエストアプリの作成
Official Documentation
Creating the Role Change Request App Subscribers The Role Change Request App starts with the employee submitting a request form. Processing then proceeds to the Current Manager, then to the...
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...
標準アプリケーションの作成
Official Documentation
Creating a Standard Application To create applications based on a custom object takes four steps: create the object, create at least one form view, create at least one table view, and deploy the...
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...
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...
データセット
Official Documentation
Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). Data sets collect data from Liferay headless APIs for you to manage and...
Liferay Webhooksを使ってCamundaでイベントをトリガーする
Official Documentation
Triggering Events in Camunda with Liferay Webhooks You can send payloads from Liferay's webhook object actions to your Camunda process instances. This enables inbound communication from Liferay to...
データセットの作成
Official Documentation
Creating Data Sets Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). You can create data sets from different resources available through...
データセットアクションの使用
Official Documentation
Using Data Set Actions Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). Here are some examples for how to use data set actions and perform...
データセットのソート
Official Documentation
Data Set Sorting Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can set default sorting rules for Data Sets...
フォームの作成と管理
Official Documentation
Creating and Managing 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...