Manage Web Content with Postman and Liferay’s Headless API

Share On :

Problem

Using the rest api to obtain and update web content.

Solution 

The Liferay Rest API can be used to programmatically Manage Web Content with Liferay Headless API. Additionally, update that webcontent. And delete the webcontent.

Benefits  
  • Liferay offers a REST API for updating web content with localization.
  • With this API, we can create our own custom implementation to update the webcontent as needed.
Prerequisites 
  • Postman 
  • Liferay 7.x
  • Basic understanding of Liferay
Environmental Requirements 
  • Postman
  • Liferay
Follow the following steps to get a webcontent on the Liferay Site.
  • We have two ways to get a webcontent in liferay which are as follows.
  1. From the postman.
  2. From the Liferay Rest API editor
  1. From the postman:
    1. Add a new request and make the request type “get”.
    2. Enter the following URL in the “Enter Requested URL”.

http://localhost:8080/o/headless-delivery/v1.0/structured-contents/${ResourcePrimaryKey}

  • You have to enter the Resource Primary Key of the web content that you want to get into the URL.
    1.  Now we have to assign the authorization.
      • Select the type as Basic Auth.
      • Enter the username and password of the admin user.
Enter Resource Primary Key for URL
    1. After hitting send, you will get the webcontent with the Resource Primary Key you have entered.
Web content with entered Resource Key request body
    1. Make sure you get the 200 as a response.
  1. From the Liferay Rest API Editor :
    1. Login as an admin on the Liferay Portal.
    2. Access the following URL to access the Liferay Swagger editor.

http://localhost:8080/o/api

    1. Access the accordion called “StructuredContent”.
StructuredContent accordion in Liferay Portal
    1. Enter the Resource Primary Key of the webcontent that you want to get.
Structured content API with primary key in Liferay Portal
    1. Make sure you get the success code 200 and you will get the response.
Structured content API response body with JSON format
Follow the following steps to update a webcontent on the Liferay Site.
  • We have two ways to update a webcontent in liferay which are as follows.
  1. From the postman.
  2. From the Liferay Rest API editor
  1. From the postman
    1. Add a new request and make the request type “put”.
    2. Enter the following URL in the “Enter Requested URL”.

http://localhost:8080/o/headless-delivery/v1.0/structured-contents/${ResourcePrimaryKey}

  • You have to enter the Resource Primary Key of the web content that you want to get into the URL.
    1.  Now we have to assign the authorization.
      • Select the type as Basic Auth.
      • Enter the username and password of the admin user.
Retrieve web content with authorization
    1. Select Body from the Navigation on the postman.
    2. Select “raw” from the first drop down and select “JSON” from the second drop down menu.
    3. Enter the following Json Object.
				
					
{
"actions": {},
"availableLanguages": [
"en-US",
"ar-SA"
],
"contentFields": [
{
"contentFieldValue": {
"document": {
"id": ${documentId}
}
},
"contentFieldValue_i18n": {
"ar-SA": {
"document": {
"id": ${documentId}
}
},
"en-US": {
"document": {
"id": ${documentId}
}
}
},
"dataType": "document",
"label": "File Upload",
"label_i18n": {
"en-US": "File Upload"
},
"name": "file_upload"
}
],
"contentStructureId": ${StructureContentId},
"datePublished": "2021-08-30T02:14:00Z",
"siteId": ${siteId},
"title": "Webcontent created for the testing",
"title_i18n": {
"ar-SA": "تم إنشاء نص ملف جديد آخر",
"en-US": "Webcontent created for the testing"
}
}
  • Brief description of the JSON keys are following.
    1. availableLanguages: –
      • Enter the languages that the web contents will support the localization.
    2. ContentFields :-
      • Content Fields will be responsible for giving the data to the structured input that we have used for web content creation.
      • In our case, we have a repeatable field in the structure of Web content
    3. ContentFieldValue : –
      • Content Field Value will fill in the data in the structure of Web content.
      • In our case, we have the repeatable file upload field. That’s why we are providing the document details under the content field value.
      • In the “contentFieldValue”  key only, it will contain the data of the default-language set on the liferay.
      • If we want to localize it. This means if we want to add a document to the language ID, then we have to use “contentFieldValue_i18n”.
    1. contentFieldValue_i18n : –
      •  This Content Field Value will be responsible for the localization of the webcontent.
      • Webcontent Data Will Be Different According to Their Locale (Example :- “en-Us” and “ar-SA”).
      • As per the localization, we have to provide the document ID for the different language support.
      1. ar-SA :-
        • We have to localization, weIDrovide the document details under this language to attach the document to the Arabic version of web content.
      2. en-US :-
        • We have to provide the document details in this language to attach the document to the English version of the web content.
    2. document : –
      • Document will be responsible for attaching the document file to the webcontent.
    3. Id : –
      • In this ID key, we have to provide the document ID of the document that we have to attach.
    4. dataType : –
      • This will be the data type of the structured content field.
    5. label : –
      • Enter the languages that the web contents will support the localization.
    1. label_i18n : –
      • label_i18n will be responsible for the localization as per the “contentFieldValue_i18n”.
    2.  name : –
      • Enter the languages that the web contents will support the localization.
    3.  contentStructureId :-
      • This will be the structure ID of the web content that will be created.
    4.  datePublished :-
      • This will set the “Display Date” over the Web content fields.
      • We have used this “Display Date” to show the date of publications on Scad.
    5.  siteId :-
      • Site ID: Which site do we have to create the Webcontent.
    6.  taxonomyCategoryIds :-
      • We have to assign the category ID array to attach the different categories to the web content.
    7.  title :-
      • Title of the Webcontent We have to enter the title of the default language IDtitles of the Liferay .
    8.  title_i18n :-
      • This title_i18n will be responsible for the localization.
      • We have to enter the titles of different languages that we have allowed in the “availableLanguages”.
      • Like the following.
      1. ar-SA :-
        • We want titles in Arabic, so we will put the Arabic conversion or the Arabic version title of webcontent.
    1. After adding the json object to the post Body.
    2. Post the request and if you get 200 response codes, then webcontent has been added to the Liferay site.
Check status after posting request
    1. Make sure you get the success code 200 and you will get the response.
    2. If you get a success code 200, but if you do not get the response, then there is some issue with the authentication.

Note:- Make sure you enter the URL and do not have a blank space after the URL completion.

  1. From the Liferay Rest API Editor 
    1. Login as an admin on the Liferay Portal.
    2. Access the following URL to access the Liferay Swagger editor.

http://localhost:8080/o/api

    1. Access the accordion called “StructuredContent”.
PUT Structured Content API accordion in Liferay Portal
    1. Enter the Resource Primary Key of the web content that you want to update.
PUT Structured content API with primary key
    1. Enter the JSON object in the request body.
				
					
{
"actions": {},
"availableLanguages": [
"en-US",
"ar-SA"
],
"contentFields": [
{
"contentFieldValue": {
"document": {
"id": 49278
}
},
"contentFieldValue_i18n": {
"ar-SA": {
"document": {
"id": 49278
}
},
"en-US": {
"document": {
"id": 49278
}
}
},
"dataType": "document",
"label": "File Upload",
"label_i18n": {
"en-US": "File Upload"
},
"name": "file_upload"
}
],
"contentStructureId": 137904,
"datePublished": "2021-08-30T02:14:00Z",
"siteId": 39603,
"title": "Webcontent created for the testing",
"title_i18n": {
"ar-SA": "تم إنشاء نص ملف جديد آخر",
"en-US": "Webcontent created for the testing"
}
}
    1. The postman method is used to explain JSON objects with their keys. Please go through with that.
    2. Execute the Rest API.
    3. Make sure you get the success code 200 and you will get the response.
PUT Structured content API response body in Liferay Portal
    1. Your webcontent has been updated successfully.
Follow the following steps to delete a webcontent on the Liferay Site.
  • We have two ways to get a webcontent in liferay which are as follows.
  1. From the postman.
  2. From the Liferay Rest API editor
  1. From the postman
    1. Add a new request and make the request type “delete”.
    2. Enter the following URL in the “Enter Requested URL”.

http://localhost:8080/o/headless-delivery/v1.0/structured-contents/${ResourcePrimaryKey}

  • You have to enter the Resource Primary Key of the webcontent that you want to get into the URL.
    1.  Now we have to assign the authorization.
      • Select the type as Basic Auth.
      • Enter the username and password of the admin user.
Basic auth in postman for authorization
    1. Now, when you hit the send button, the webcontent will be deleted.
    2. If you get 204 as a response that means your web content has been successfully deleted.
Sending deletes web content and getting 204 response
  1. From the Liferay Rest API Editor :
    1. Login as an admin on the Liferay Portal.
    2. Access the following URL to access the Liferay Swagger editor.

http://localhost:8080/o/api

    1. Access the accordion called “StructuredContent”.
Access delete Structured Content API in Liferay Portal
    1. Enter the Resource Primary Key of the webcontent that you want to delete.
Trigger delete Structured Content API with primary key
    1. Execute the API and you will get a 204 as a response.
Response of delete Structured Content API
Loading...

Related Blogs

Loading...

Explore Our Services

Discover how we can help your business thrive, whether you’re running a small startup, an SME, or a large enterprise. We’re here to understand your unique needs and goals, offering the expertise and resources to support your journey to success.

Stay informed about our Liferay services and updates by subscribing to our newsletter—just fill in the details below to subscribe.