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...

Asset Libraries API Basics

Official Documentation

Asset Libraries API Basics Liferay's REST APIs provide endpoints for creating, retrieving, updating, and deleting asset libraries. Starting with Liferay DXP 2025.Q4, these same endpoints also...

Managing Object Entries Using 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...

Using Object APIs With Base64 Encoded Files

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...

Using Relationship REST APIs

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...

Organizations API Basics

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...

Configuring the JWT Bearer Flow

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...

Data Set Actions

Official Documentation

Data Set Actions Liferay DXP 2024.Q1+/Portal GA112+ Currently, this feature is behind a release feature flag (LPS-164563). While managing data set, define actions to be used in the data set...

Account Groups API Basics

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. ...

Accounts API Basics

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 ...

Managing Data Sets

Official Documentation

Managing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ This feature is behind a release feature flag (LPS-164563). Once you create a data set, you can customize how users see it. Choose which...

Site API Basics

Official Documentation

Site API Basics Liferay's REST APIs provide services for Liferay sites. You can create and edit sites with the API. The Sites API uses External Reference Codes (ERCs) to reference sites, enabling...

Creating Data Sets

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...

Data Set Filters

Official Documentation

Data Set Filters Liferay DXP 2024.Q1/Portal GA112 Currently, this feature is behind a release feature flag (LPS-164563). While managing data sets, you can define pre-applied filters to be used...

Account Users and Roles APIs

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...

Consuming GraphQL APIs

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: ...

Data Set Visualization Modes

Official Documentation

Data Set Visualization Modes Liferay DXP 2024.Q2+/Portal GA120+ Currently, this feature is behind a release feature flag (LPS-164563). To customize the data display in your data set, use the...

Data Set Sorting

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...

Migrating to Liferay Objects

Official Documentation

Migrating to Liferay Objects Dynamic Data Lists is deprecated and scheduled for removal by the end of 2024. To prevent data loss and achieve the same functionality, please migrate your structures...

Defining Object Actions

Official Documentation

Defining Object Actions Liferay 7.4 U60+/GA60+ Object actions define operations that you can run manually or automatically for object entry events. To add an action, Open the Global Menu (...

Exporting and Importing Object Definitions

Official Documentation

Exporting and Importing Object Definitions You can export and import object definitions as .json files. These files include the definition's complete schema (e.g., configurations, fields, actions,...

Creating Objects

Official Documentation

Creating Objects Liferay DXP 2023.Q4+/Portal GA102+ Liferay Objects provides development capabilities in the Liferay UI. Using Objects, you can build fully integrated Liferay applications without...

Using the Notification Queue

Official Documentation

Using the Notification Queue Liferay 7.4 U75+/GA75+ Liferay provides the Notification Queue application for reviewing email notifications triggered by an object action. You can verify the status...

Viewing Data Sets

Official Documentation

Viewing Data Sets Liferay DXP 2024.Q1+/Portal GA112+ This feature is behind a release feature flag (LPS-164563). Once you create a data set, add it to a page to present it to your users. Users...

Auditing Object Events

Official Documentation

Auditing Object Events Liferay 7.4 U72+/GA72+ You can use Liferay's audit framework to track events for custom object definitions and their entries. To track entry events, you must enable entry...

Creating Notification Templates

Official Documentation

Creating Notification Templates Liferay DXP 2023.Q4+/Portal GA102+ With notification templates, you can design automated email and user notifications for Liferay services. Each template identifies...

Activating and Deactivating Objects

Official Documentation

Activating and Deactivating Objects Custom objects are activated when published. While active, you can use the object to create entries via the Liferay UI or dedicated REST APIs. If needed, you can...

Deleting Objects

Official Documentation

Deleting Objects Liferay 7.4 U26+/GA26+ You can delete draft and published object definitions. Deleting a definition removes its associated data, including the stored entries for published...

Fields

Official Documentation

Fields Liferay DXP 2023.Q4+/Portal GA102+ Object fields are data definitions that represent database columns and store different types of values. All objects include default system fields, but you...

Adding and Managing Custom States

Official Documentation

Adding and Managing Custom States Liferay 7.4+ Some use cases may require assigning multiple states to an object entry at the same time. For example, when building an Order application, you may...

Adding Fields to Objects

Official Documentation

Adding Fields to Objects Liferay DXP 2023.Q4+/Portal GA102+ Fields are data definitions that represent database columns and store different types of values. By default, all objects include these...

Organizing Objects with Folders

Official Documentation

Organizing Objects with Folders By default, object definitions are grouped in the Uncategorized folder, but you can add object folders to organize data models and manage access to definitions. ...

Accessing Accounts Data from Custom Objects

Official Documentation

Accessing Accounts Data from Custom Objects Liferay 7.4 U35+/GA35+ In some use cases, you may want to access account data from a custom object. For example, if you're building a custom returns...

Managing Objects with Headless APIs

Official Documentation

Managing Objects with Headless APIs Liferay 7.4+ You can create and manage objects from the Applications menu, but you can also use Liferay's REST APIs. Call these services to create and manage...

Defining Object Relationships

Official Documentation

Defining Object Relationships Liferay 7.4+ Relationships add fields and tables to object definitions for relating their entries to one another. Follow these steps to add relationships to object...

Encrypted Fields

Official Documentation

Encrypted Fields Self-Hosted and PaaS Only Liferay 7.4 U72+/GA72+ Liferay provides the encrypted field type for storing sensitive user data. To use encrypted fields, first add an encryption...

Designing Object Layouts

Official Documentation

Designing Object Layouts Liferay 7.4 U31+/GA31+ Layouts define how fields and relationships appear when creating and editing object entries. Each layout can include multiple tabs containing...

Removing Relationships

Official Documentation

Removing Relationships Liferay 7.4 U26+/GA26+ You can remove relationships from both draft and published object definitions. Removing a relationship permanently deletes its field from the related...

Phone Number Fields

Official Documentation

Phone Number Fields Liferay DXP 2026.Q3+ Phone Number fields store contact numbers with built-in validation and normalization. All values are stored in E.164 format (a + followed by 7–15 digits,...

Email Address Fields

Official Documentation

Email Address Fields Liferay DXP 2026.Q3+ Email Address fields store and validate email addresses entered on forms and through the API. Objects normalizes every value to lowercase before storage,...

Search Results