Content Service API Data Structures
Content
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"contentId": "string",
"name": "string",
"contentTypeId": "string",
"tenantId": "string",
"description": "string",
"subtenantId": "string",
"id": "string",
"mimeType": "string",
"version": "integer",
"dependencies": [
"string"
]
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
contentId
Optional
contentId
string
name
Optional
name
string
contentTypeId
Optional
contentTypeId
string
tenantId
Optional
tenantId
string
description
Optional
description
string
subtenantId
Optional
subtenantId
string As uuid As uuid
id
Optional
id
string
mimeType
Optional
mimeType
integer As int64 As int64
version
Optional
version
array of string
dependencies
Optional
dependencies
ContentData
JSON Example
{
"data": [
"string"
],
"mimeType": "string"
}array of string
data
Required
data
string
mimeType
Required
mimeType
ContentDependency
JSON Example
{
"entityReference": {
"classId": "string",
"componentId": "string",
"id": "string",
"label": "string"
},
"isOptional": "boolean"
}boolean
isOptional
Optional
isOptional
ContentType
JSON Example
{
"classId": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
}string
classId
Optional
classId
string
name
Optional
name
string
description
Optional
description
string
serviceTypeId
Optional
serviceTypeId
string
id
Optional
id
Property Of
Parameter To
OperationError
JSON Example
{
"errorMessage": "string",
"errorCode": "integer"
}string
errorMessage
Optional
errorMessage
integer As int32 As int32
errorCode
Optional
errorCode
OperationInfo
JSON Example
{
"operationStatus": "string",
"operationResults": [
{
"operationErrors": [
{
"errorMessage": "string",
"errorCode": "integer"
}
],
"operationStatus": "string",
"contentId": "string",
"contentTypeId": "string",
"messages": [
"string"
],
"contentName": "string"
}
],
"operationType": "string"
}string
operationStatus
Optional
operationStatus
string
operationType
Required
operationType
OperationResult
JSON Example
{
"operationErrors": [
{
"errorMessage": "string",
"errorCode": "integer"
}
],
"operationStatus": "string",
"contentId": "string",
"contentTypeId": "string",
"messages": [
"string"
],
"contentName": "string"
}string
operationStatus
Optional
operationStatus
string
contentId
Optional
contentId
string
contentTypeId
Optional
contentTypeId
array of string
messages
Optional
messages
string
contentName
Optional
contentName
Package
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"contents": [
"string"
],
"name": "string",
"tenantId": "string",
"description": "string",
"subtenantId": "string",
"id": "string",
"version": "integer"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
array of string
contents
Required
contents
string
name
Required
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
subtenantId
Optional
subtenantId
string As uuid As uuid
id
Optional
id
integer As int64 As int64
version
Optional
version
PageContent
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"lastUpdated": "string",
"createdDate": "string",
"contentId": "string",
"name": "string",
"contentTypeId": "string",
"tenantId": "string",
"description": "string",
"subtenantId": "string",
"id": "string",
"mimeType": "string",
"version": "integer",
"dependencies": [
"string"
]
}
],
"first": "boolean",
"totalElements": "integer"
}integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
PageContentType
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"classId": "string",
"name": "string",
"description": "string",
"serviceTypeId": "string",
"id": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
PagePackage
JSON Example
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"lastUpdated": "string",
"createdDate": "string",
"contents": [
"string"
],
"name": "string",
"tenantId": "string",
"description": "string",
"subtenantId": "string",
"id": "string",
"version": "integer"
}
],
"first": "boolean",
"totalElements": "integer"
}integer As int32 As int32
number
Optional
number
integer As int32 As int32
size
Optional
size
boolean
last
Optional
last
integer As int32 As int32
numberOfElements
Optional
numberOfElements
integer As int32 As int32
totalPages
Optional
totalPages
boolean
first
Optional
first
integer As int64 As int64
totalElements
Optional
totalElements
ProviderContent
JSON Example
{
"subTenantId": "string",
"contentData": {
"data": [
"string"
],
"mimeType": "string"
},
"contentId": "string",
"name": "string",
"contentTypeId": "string",
"tenantId": "string",
"description": "string",
"storageType": "string",
"serviceId": "string",
"dependencies": [
{
"entityReference": {
"classId": "string",
"componentId": "string",
"id": "string",
"label": "string"
},
"isOptional": "boolean"
}
]
}string
subTenantId
Optional
subTenantId
string
contentId
Required
contentId
string
name
Required
name
string
contentTypeId
Required
contentTypeId
string
tenantId
Required
tenantId
string
description
Optional
description
string
storageType
Required
storageType
string
serviceId
Required
serviceId
Sort
This data structure has no properties.
entityRef
Represents a reference to an entity defined somewhere in the suite.
JSON Example
{
"classId": "string",
"componentId": "string",
"id": "string",
"label": "string"
}string
classId
Optional
The identifier of the type or category to which the referenced entity belongs.
string
componentId
Optional
The durable identifier of a component registered in the suite component registry that owns and manages the referenced entity. This can be omitted if this component can be derived from the context within which this entity reference occurs. It must be specified, if no such context exists or if the component differs from that defined by the context.
string
id
Optional
The unique identifier of the referenced entity, encoded as a string
string
label
Optional
label
Node: apidepo-liferay-dxp-v1-be-w-1:8080: