OpenAPI Profiles

All the APIs exposed by Liferay DXP are available under the liferayinc SwaggerHub organization.

Liferay DXP’s headless APIs are categorized in two different use cases:

  • Delivering content (delivery APIs)
  • Managing and administering content (admin APIs)

The available APIs demonstrate this categorization.

Headless Delivery

The following table lists the APIs that Headless Delivery contains. Note that the second column shows which internal model in Liferay DXP that the API maps to.

API Internal Model
BlogPostingBlogsEntry
BlogPostingImageDLFileEntry (associated with a BlogsEntry)
CommentDiscussionComment
ContentDocumentDLFileEntry (associated with a JournalArticle)
ContentSetAssetListEntry
ContentStructureDDMStructure
DocumentDLFileEntry
DocumentFolderFolder
KnowledgeBaseArticleKBArticle
KnowledgeBaseAttachmentFileEntry (associated with a KBArticle)
KnowledgeBaseFolderKBFolder
MessageBoardAttachmentFileEntry (associated with a MBMessage)
MessageBoardMessageMBMessage
MessageBoardSectionMBCategory
MessageBoardThreadMBThread
RatingRatingsEntry
StructuredContentJournalArticle
StructuredContentFolderJournalFolder

Headless Administration

There are several headless admin APIs, each containing its own set of APIs. The following tables list these, as well as any internal models in Liferay DXP that each API maps to.

Headless Admin User contains the following APIs for retrieving and managing information about users and organizations.

API Internal Model
EmailAddressN/A
OrganizationN/A
PhoneN/A
PostalAddressAddress
RoleN/A
SegmentSegmentEntry
SegmentUserN/A
SiteBriefN/A
UserAccountUser
WebUrlWebSite

Headless Admin Taxonomy contains the following APIs for managing asset categories, asset vocabularies, and asset tags.

API Internal Model
KeywordAssetTag
TaxonomyCategoryAssetCategory
TaxonomyVocabularyAssetVocabulary

Headless Admin Workflow contains APIs for transitioning workflows.

API Formats and Content Negotiation

« API Formats and Content NegotiationFilter, Sort, and Search »
Este artigo foi útil?
Utilizadores que acharam útil: 0 de 0