Search Results

All Results 6969
ソート
Resource Type
Applicable Versions
Deployment Approach
Capability
Feature
タグAPIの基本
Official Documentation
Tags API Basics Liferay's REST APIs provide services for managing tags (referred to as keywords in Liferay's codebase). You can create, edit, and delete tags using the API. Start with an example of...
Wiki APIの基本
Official Documentation
Wiki API Basics Wiki is deprecated as of Liferay DXP 2024.Q4/Portal GA129. For data continuity, consider transitioning to alternative content management solutions like Liferay Objects or Web...
WebコンテンツAPIの詳細設定
Official Documentation
Advanced Web Content API Using the Liferay DXP REST services, you can create and manage your site's structured content. Structured content is web content that uses a web content structure (or...
GraphQL を使用した Web コンテンツ API の基礎
Official Documentation
Web Content API Basics Using GraphQL Use Liferay DXP GraphQL services to manage web content by creating, retrieving, updating, and deleting structured content on your site. Structured content...
ドキュメントタイプとメタデータセットAPIの基礎
Official Documentation
Document Types and Metadata Sets API Basics Liferay DXP 2025.Q1+/Portal GA132+ Liferay's headless delivery application provides REST services for Documents and Media that add document types and...
ドキュメントAPIの基本
Official Documentation
Document API Basics Liferay's headless delivery application provides REST services for Documents and Media that add documents and folders, list their information, modify them, delete them, and...
ドキュメント・ショートカットAPIの基本
Official Documentation
Document Shortcut API Basics Liferay's headless delivery application provides REST services for Documents and Media that add document shortcuts to sites or asset libraries, list their information,...
LiferayセキュリティAPI
Liferay Security APIs You can use headless APIs to interface with important Liferay security features, including CAPTCHA configurations and SCIM. Here are resources to help you understand and...
デジタル資産管理API
Digital Asset Management APIs You can use headless APIs to interface with Liferay's documents and media. Here are resources to help you understand and integrate these APIs.
キャプチャAPIの基礎
Official Documentation
Captcha API Basics Liferay provides a headless API to retrieve and submit captchas using the SimpleCAPTCHA engine. Using the /captcha endpoint from the API Explorer, you can add captchas in your...
オブジェクト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]...
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...
オブジェクトエントリバージョンの管理
Official Documentation
Managing Object Entry Versions Liferay DXP 2025.Q4+/Portal 2026.Q1+ Object entry versioning is used in Liferay's Content Management System (CMS). To use versioning with a custom object's entries,...
バッチ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...
カスタムオブジェクト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グループAPIの基礎
Official Documentation
SCIM Group API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM groups to keep their information in sync with your company's...
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...
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...
オブジェクト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.
SCIM ユーザー API の基礎
Official Documentation
SCIM User API Basics Liferay DXP 2024.Q1+/Portal GA112+ Liferay provides a headless API to perform CRUD operations on SCIM users to keep their identity information in sync with your company's...
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...
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...
関連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...
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...
ナビゲーションメニューAPIの基本
Official Documentation
Navigation Menu API Basics Liferay's REST APIs provide services for Liferay's navigation menus. You can create and edit navigation menus with the API. Start by seeing an example of adding a new...
通知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
Site APIs Use Liferay’s REST APIs to manage site elements programmatically. This guide introduces the Navigation Menu API and shows how to create, retrieve, update, and delete navigation menus...
検索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
User Management APIs You can use headless APIs to interface with important Liferay user management features, including user accounts, organizations, and roles. Here are resources to help you...
ワークフロー定義リンク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 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
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
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
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
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
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
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
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...
郵便番号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...
ヘッドレスプラットフォームとしての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
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
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
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
Batch Engine API Basics - Importing Data Liferay's Headless Batch Engine provides REST APIs to import and export data. Call these services to import data to Liferay. Importing Data Then follow...
認証されていないリクエストを行う
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...
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...
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...
バッチエンジン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,...
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...
RESTサービスの使用
Official Documentation
Consuming REST Services Liferay DXP contains REST services for most of its applications. These services are fully OpenAPI compliant. Here, learn how to consume them. This takes only three steps: ...
データ移行センター
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...
OAuth2アプリケーションの作成
Official Documentation
Creating an OAuth2 Application When you have an application that can use OAuth 2.0 for authorization, you must register that application so Liferay can recognize it. Open the Global Menu...
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...