Endpoint Configuration Service API Data Structures
Association
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"customProperties": "string",
"fromEndpointType": "string",
"associationTypeInfoId": "string",
"id": "string",
"toEndpointId": "string",
"toEndpointType": "string",
"version": "integer",
"fromEndpointId": "string"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
customProperties
Optional
customProperties
string
fromEndpointType
Optional
fromEndpointType
string As uuid As uuid
associationTypeInfoId
Optional
associationTypeInfoId
string As uuid As uuid
id
Optional
id
string As uuid As uuid
toEndpointId
Optional
toEndpointId
string
toEndpointType
Optional
toEndpointType
integer As int64 As int64
version
Optional
version
string As uuid As uuid
fromEndpointId
Optional
fromEndpointId
AssociationType
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"toType": "string",
"fromType": "string",
"name": "string",
"description": "string",
"id": "string",
"version": "integer",
"cardinality": "integer"
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
toType
Optional
toType
string
fromType
Optional
fromType
string
name
Optional
name
string
description
Optional
description
string As uuid As uuid
id
Optional
id
integer As int64 As int64
version
Optional
version
integer As int32 As int32
cardinality
Required
cardinality
CertificateInfo
JSON Example
{
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
}string As date-time As date-time
notValidBefore
Optional
notValidBefore
boolean
identityCertificateExists
Optional
identityCertificateExists
string
issuerName
Optional
issuerName
string As date-time As date-time
notValidAfter
Optional
notValidAfter
string
thumbprint
Optional
thumbprint
string
principalName
Optional
principalName
Clause
This data structure has no properties.
CriteriaOperator
This data structure has no properties.
DataType
JSON Example
{
"typeId": "string"
}string
typeId
Optional
typeId
DynamicDataRequest
JSON Example
{
"ignoreUnknownFields": "boolean",
"tenantId": "string",
"ids": [
"string"
]
}boolean
ignoreUnknownFields
Optional
ignoreUnknownFields
string
tenantId
Optional
tenantId
array of string
ids
Optional
ids
DynamicDataResponse
JSON Example
{
"values": {
"entries": [
{
"key": "string"
}
]
}
}
DynamicValueContext
JSON Example
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}string
providerEntityId
Optional
providerEntityId
ElementState
JSON Example
{
"dependencies": [
"string"
],
"facets": [
{}
]
}array of string
dependencies
Optional
dependencies
Endpoint
JSON Example
{
"associations": [
{
"lastUpdated": "string",
"createdDate": "string",
"customProperties": "string",
"fromEndpointType": "string",
"associationTypeInfoId": "string",
"id": "string",
"toEndpointId": "string",
"toEndpointType": "string",
"version": "integer",
"fromEndpointId": "string"
}
],
"lastUpdated": "string",
"createdDate": "string",
"name": "string",
"tenantId": "string",
"description": "string",
"typeId": "string",
"id": "string",
"typeDisplayName": "string",
"version": "integer",
"uri": "string",
"extensionData": {
"entries": [
{
"key": "string"
}
]
}
}string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
name
Optional
name
string
tenantId
Optional
tenantId
string
description
Optional
description
string
typeId
Optional
typeId
string As uuid As uuid
id
Optional
id
string
typeDisplayName
Optional
typeDisplayName
integer As int64 As int64
version
Optional
version
string
uri
Optional
uri
EndpointMenuItem
JSON Example
{
"displayName": "string",
"icon": "string",
"menuId": "string",
"location": "string",
"id": "integer",
"extensionId": "string"
}string
displayName
Optional
displayName
string
icon
Optional
icon
string
menuId
Optional
menuId
string
location
Optional
location
integer As int32 As int32
id
Optional
id
string
extensionId
Optional
extensionId
EndpointType
JSON Example
{
"schema": {
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
},
"serviceProviderId": "string",
"capabilities": "string",
"displayName": "string",
"categoryDisplayName": "string",
"menuItems": [
{
"displayName": "string",
"icon": "string",
"menuId": "string",
"location": "string",
"id": "integer",
"extensionId": "string"
}
],
"description": "string",
"version": "integer",
"tenantable": "boolean",
"lastUpdated": "string",
"createdDate": "string",
"tenantId": "string",
"id": "string",
"category": "string"
}string
serviceProviderId
Optional
serviceProviderId
string
capabilities
Optional
capabilities
string
displayName
Optional
displayName
string
categoryDisplayName
Optional
categoryDisplayName
string
description
Optional
description
integer As int64 As int64
version
Optional
version
boolean
tenantable
Optional
tenantable
string As date-time As date-time
lastUpdated
Optional
lastUpdated
string As date-time As date-time
createdDate
Optional
createdDate
string
tenantId
Optional
tenantId
string
id
Optional
id
string
category
Optional
category
EndpointTypeCategory
JSON Example
{
"lastUpdated": "string",
"createdDate": "string",
"name": "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
string
name
Optional
name
string
id
Optional
id
integer As int64 As int64
version
Optional
version
EndpointValidationResult
JSON Example
{
"message": "string",
"certificateInfo": {
"notValidBefore": "string",
"identityCertificateExists": "boolean",
"issuerName": "string",
"notValidAfter": "string",
"thumbprint": "string",
"principalName": "string"
},
"status": "string"
}string
message
Optional
message
string
status
Optional
status
Evaluator
This data structure has no properties.
Field
JSON Example
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}string
displayAdvice
Optional
displayAdvice
boolean
isMultiValued
Optional
isMultiValued
string
description
Optional
description
integer As int32 As int32
orderIndex
Optional
orderIndex
string
id
Optional
id
string
label
Optional
label
InlinebooleanLiteral1
Wraps a boolean value.
This data structure has no properties.
boolean
value
Optional
The boolean value.
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
ParameterMapping
JSON Example
{
"key": "string"
}string
key
Optional
key
ParameterMappingCollection
JSON Example
{
"params": [
{
"key": "string"
}
]
}
PermissibleValueList
JSON Example
{
"customAllowed": "boolean"
}boolean
customAllowed
Optional
customAllowed
Schema
JSON Example
{
"fields": [
{
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"columns": [
"Field Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"orderIndex": "integer",
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
]
}
Property Of
Sort
This data structure has no properties.
booleanLiteral
AllOf
JSON Example
{
"value": "boolean"
}
literal
Wraps a value such that values of different types can be treated generically.
This data structure has no properties.
literalMap
Equivalent of java.util.Map
JSON Example
{
"entries": [
{
"key": "string"
}
]
}
timeSpan
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
JSON Example
{
"unit": "string",
"amount": "integer"
}string
unit
Optional
The unit of measure for the time span. e.g: days.
integer As int64 As int64
amount
Optional
The amount for the time span.
value
JSON Example
{
"label": "string"
}string
label
Optional
label
Node: apidepo-liferay-dxp-v1-be-w-1:8080: