Api Documentation Data Structures
ContentSource
JSON Example
{
"config": {
"contentType": "string",
"integrationId": "string",
"repository": "string",
"branch": "string",
"path": "string"
},
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"syncEnabled": "boolean",
"typeId": "string"
}object
config
Optional
Source custom configuration
string As date-time As date-time
createdAt
Optional
Creation time
string
createdBy
Optional
Created By
string
description
Optional
Content Source description
string As uuid As uuid
id
Required
Content Source id
string As date-time As date-time
lastUpdatedAt
Optional
Update time
string
lastUpdatedBy
Optional
Updated By
string
name
Required
Content Source name
string
orgId
Optional
Associated org
string
projectId
Optional
Associated projects
boolean
syncEnabled
Optional
Is Sync Enabled
object
syncProperties
Optional
Sync related properties
string
typeId
Required
Content Source type
Property Of
Parameter To
ContentSources
JSON Example
{
"_embedded": [
{
"config": {
"contentType": "string",
"integrationId": "string",
"repository": "string",
"branch": "string",
"path": "string"
},
"createdAt": "string",
"createdBy": "string",
"description": "string",
"id": "string",
"lastUpdatedAt": "string",
"lastUpdatedBy": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"syncEnabled": "boolean",
"typeId": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
Document
JSON Example
{
"downloadUrl": "string",
"title": "string",
"type": "string"
}string
downloadUrl
Optional
Document Link
string
title
Optional
Document Title
string
type
Optional
Document Type
ExecutionMessage
JSON Example
{
"message": "string"
}string
message
Optional
Execution Message
Link
JSON Example
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}string
deprecation
Optional
deprecation
string
href
Optional
href
string
hreflang
Optional
hreflang
string
media
Optional
media
string
rel
Optional
rel
boolean
templated
Optional
templated
string
title
Optional
title
string
type
Optional
type
MarketplaceContent
JSON Example
{
"description": "string",
"developer": "string",
"displayName": "string",
"documents": [
{
"downloadUrl": "string",
"title": "string",
"type": "string"
}
],
"eula": "string",
"highlights": [
"string"
],
"icon": "string",
"id": "string",
"overview": "string",
"rating": "string",
"screenshots": [
"string"
],
"support": {
"email": "string",
"hours": "string",
"phone": "string",
"statement": "string",
"url": "string"
},
"techSpecs": "string",
"totalReviews": "integer",
"updatedAt": "string",
"version": "string",
"video": "string"
}string
description
Optional
Description
string
developer
Optional
Developer
string
displayName
Optional
Display Name
string
eula
Optional
EULA
array of string
highlights
Optional
Highlights
string
icon
Optional
Icon
string
id
Optional
ID
string
overview
Optional
Overview
string
rating
Optional
Rating
array of string
screenshots
Optional
Screenshots
string
techSpecs
Optional
Tech Specs
integer As int32 As int32
totalReviews
Optional
Total Reviews
string As date-time As date-time
updatedAt
Optional
Updated Date
string
version
Optional
Version
string
video
Optional
Video
MarketplaceContentDownloadRequest
JSON Example
{
"contentId": "string",
"contentName": "string",
"contentType": "string",
"createdAt": "string",
"downloadedContentId": "string",
"executionMessages": [
{
"message": "string"
}
],
"id": "string",
"lastUpdatedAt": "string",
"sourceId": "string",
"status": "string",
"targetId": "string",
"targetType": "string"
}string
contentId
Required
Content Id
string
contentName
Required
Content Name
string
contentType
Required
Content Type
string As date-time As date-time
createdAt
Optional
Request Created Time
string
downloadedContentId
Optional
Downloaded Content Id
string As uuid As uuid
id
Optional
Request Id
string As date-time As date-time
lastUpdatedAt
Optional
Request Last Updated Time
string As uuid As uuid
sourceId
Required
Content Source Id
string
status
Optional
Request Status
string
targetId
Required
Target Id
string
targetType
Required
Target Type
Parameter To
MarketplaceContentLink
JSON Example
{
"id": "string",
"link": "string"
}string
id
Optional
Content Id
string
link
Optional
Content Link
MarketplaceContentReview
JSON Example
{
"comment": "string",
"contentId": "string",
"id": "string",
"rating": "string",
"title": "string",
"user": "string"
}string
comment
Optional
Comment
string
contentId
Optional
Content ID
string
id
Optional
Review ID
string
rating
Optional
Rating
string
title
Optional
Title
string
user
Optional
User
MarketplaceContentReviews
JSON Example
{
"_embedded": [
{
"comment": "string",
"contentId": "string",
"id": "string",
"rating": "string",
"title": "string",
"user": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
MarketplaceContents
JSON Example
{
"_embedded": [
{
"description": "string",
"developer": "string",
"displayName": "string",
"documents": [
{
"downloadUrl": "string",
"title": "string",
"type": "string"
}
],
"eula": "string",
"highlights": [
"string"
],
"icon": "string",
"id": "string",
"overview": "string",
"rating": "string",
"screenshots": [
"string"
],
"support": {
"email": "string",
"hours": "string",
"phone": "string",
"statement": "string",
"url": "string"
},
"techSpecs": "string",
"totalReviews": "integer",
"updatedAt": "string",
"version": "string",
"video": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
MarketplaceDownloadHistories
JSON Example
{
"_embedded": [
{
"contentId": "string",
"contentName": "string",
"contentType": "string",
"downloadedOn": "string",
"id": "string",
"status": "string",
"targetId": "string",
"targetName": "string",
"targetType": "string",
"updatedOn": "string",
"username": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
MarketplaceDownloadHistory
JSON Example
{
"contentId": "string",
"contentName": "string",
"contentType": "string",
"downloadedOn": "string",
"id": "string",
"status": "string",
"targetId": "string",
"targetName": "string",
"targetType": "string",
"updatedOn": "string",
"username": "string"
}string
contentId
Optional
Downloaded Content Id
string
contentName
Optional
Downloaded Content Name
string
contentType
Optional
Downloaded Content Type
string As date-time As date-time
downloadedOn
Optional
Downloaded On
string
id
Optional
History Id
string
status
Optional
Download Status
string
targetId
Optional
Target Id
string
targetName
Optional
Target Name
string
targetType
Optional
Target Type
string As date-time As date-time
updatedOn
Optional
Updated On
string
username
Optional
Username
MarketplaceFilter
JSON Example
{
"entries": {
"_embedded": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
},
"id": "string",
"name": "string",
"type": "string",
"valueType": "string"
}string
id
Optional
Filter Id
string
name
Optional
Filter Display Name
string
type
Optional
Filter Type
string
valueType
Optional
Filter Value Type
MarketplaceFilterEntries
JSON Example
{
"_embedded": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
MarketplaceFilterEntry
JSON Example
{
"count": "integer",
"id": "string",
"name": "string"
}integer As int64 As int64
count
Optional
Entry count for this filter
string
id
Optional
id
string
name
Optional
Filter Entry Display Name
MarketplaceFilterSchema
JSON Example
{
"filters": [
{
"entries": {
"_embedded": [
{
"count": "integer",
"id": "string",
"name": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
},
"id": "string",
"name": "string",
"type": "string",
"valueType": "string"
}
]
}
PageMetadata
JSON Example
{
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}integer As int64 As int64
number
Optional
number
integer As int64 As int64
size
Optional
size
integer As int64 As int64
totalElements
Optional
totalElements
integer As int64 As int64
totalPages
Optional
totalPages
SourceControlSyncAllRequest
JSON Example
{
"projectIds": [
"string"
]
}array of string
projectIds
Optional
Project Ids
SourceControlSyncHistory
JSON Example
{
"_embedded": [
{
"contentFullPath": "string",
"contentName": "string",
"contentType": "string",
"details": [
"string"
],
"id": "string",
"integrationId": "string",
"projectId": "string",
"projectName": "string",
"requestId": "string",
"sourceId": "string",
"status": "string",
"timestamp": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
SourceControlSyncHistoryItem
JSON Example
{
"contentFullPath": "string",
"contentName": "string",
"contentType": "string",
"details": [
"string"
],
"id": "string",
"integrationId": "string",
"projectId": "string",
"projectName": "string",
"requestId": "string",
"sourceId": "string",
"status": "string",
"timestamp": "string"
}string
contentFullPath
Optional
Content Full Path
string
contentName
Optional
Content Name
string
contentType
Optional
Content Type
array of string
details
Optional
Details
string As uuid As uuid
id
Optional
Unique Id for the Source Control History
string
integrationId
Optional
Integration Id
string
projectId
Optional
Project Id
string
projectName
Optional
Project Name
string As uuid As uuid
requestId
Optional
Id of the sync request
string As uuid As uuid
sourceId
Optional
Content source Id
string
status
Optional
Status
string As date-time As date-time
timestamp
Optional
Timestamp
SourceControlSyncRequest
JSON Example
{
"createdAt": "string",
"lastUpdatedAt": "string",
"message": "string",
"projectId": "string",
"requestId": "string",
"sourceId": "string",
"status": "string"
}string As date-time As date-time
createdAt
Optional
Created at
string As date-time As date-time
lastUpdatedAt
Optional
Last Updated at
string
message
Optional
Message
string
projectId
Optional
Project Id
string As uuid As uuid
requestId
Optional
Request Id
string As uuid As uuid
sourceId
Optional
Content Source Id
string
status
Optional
Status
Property Of
Parameter To
SourceControlSyncRequests
JSON Example
{
"_embedded": [
{
"createdAt": "string",
"lastUpdatedAt": "string",
"message": "string",
"projectId": "string",
"requestId": "string",
"sourceId": "string",
"status": "string"
}
],
"_links": [
{
"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"rel": "string",
"templated": "boolean",
"title": "string",
"type": "string"
}
],
"page": {
"number": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}
}
Support
JSON Example
{
"email": "string",
"hours": "string",
"phone": "string",
"statement": "string",
"url": "string"
}string
email
Optional
Support Email
string
hours
Optional
Support Hours
string
phone
Optional
Support Phone
string
statement
Optional
Support Statement
string
url
Optional
Support URL
Node: apidepo-liferay-dxp-v1-be-w-1:8080: