Orchestration (o11n) Gateway Service API Data Structures
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
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
ElementValuesPagingInfo
JSON Example
{
"offset": "integer",
"count": "integer"
}integer As int32 As int32
offset
Optional
offset
integer As int32 As int32
count
Optional
count
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.
Link
JSON Example
{
"rel": "string",
"href": "string"
}string
rel
Optional
rel
string
href
Optional
href
LiteralMapEntry
JSON Example
{
"key": "string"
}string
key
Optional
key
O11nIcon
JSON Example
{
"data": [
"string"
],
"href": "string",
"contentType": "string"
}array of string
data
Optional
data
string
href
Optional
href
string
contentType
Optional
contentType
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": [
{}
]
}
}
]
}
booleanLiteral
AllOf
JSON Example
{
"value": "boolean"
}
elementValues
JSON Example
{
"values": [
{
"label": "string"
}
]
}
elementValuesRequest
JSON Example
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}string
tenantId
Optional
tenantId
string
text
Optional
text
string
userId
Optional
userId
entities
JSON Example
{
"links": [
{
"rel": "string",
"href": "string"
}
],
"content": [
{
"systemDefault": "boolean",
"password": "string",
"port": "integer",
"name": "string",
"host": "string",
"ssoMode": "boolean",
"tenantId": "string",
"certificate": "string",
"description": "string",
"id": "string",
"embedded": "boolean",
"username": "string"
}
]
}
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"
}
]
}
o11n-action
JSON Example
{
"fqn": "string",
"name": "string",
"description": "string",
"resultContentType": {
"typeId": "string"
},
"inputParameters": [
{
"name": "string",
"type": "string",
"contentType": {
"typeId": "string"
}
}
],
"resultType": "string"
}string
fqn
Required
fqn
string
name
Required
name
string
description
Required
description
string
resultType
Optional
resultType
o11n-actionParameter
JSON Example
{
"name": "string",
"type": "string",
"contentType": {
"typeId": "string"
}
}
o11n-configuration
Represents a Configuration for vCO server
JSON Example
{
"systemDefault": "boolean",
"password": "string",
"port": "integer",
"name": "string",
"host": "string",
"ssoMode": "boolean",
"tenantId": "string",
"certificate": "string",
"description": "string",
"id": "string",
"embedded": "boolean",
"username": "string"
}boolean
systemDefault
Optional
systemDefault
string
password
Optional
user password to use for authentication
integer As int32 As int32
port
Optional
vRO port
string
name
Required
Configuration name
string
host
Required
vRO host
boolean
ssoMode
Optional
Indicates whether this condifuration is for sso mode or not
string
tenantId
Required
the id of the tenant where this condifuration belongs to
string
certificate
Optional
certificate used to connect to vRO
string
description
Optional
Configuration description
string
id
Optional
id
boolean
embedded
Optional
embedded
string
username
Optional
username to use for authentication
Property Of
o11n-endpointMetadata
Represents an endpoint metadata (e.g. vRO plugin metadata)
JSON Example
{
"displayName": "string",
"name": "string",
"icon": {
"data": [
"string"
],
"href": "string",
"contentType": "string"
},
"version": "string",
"buildNumber": "integer",
"enabled": "boolean",
"configurable": "boolean"
}string
displayName
Optional
displayName
string
name
Optional
name
string
version
Optional
version
integer As int64 As int64
buildNumber
Optional
buildNumber
boolean
enabled
Optional
enabled
boolean
configurable
Optional
configurable
o11n-inventoryResource
JSON Example
{
"pluginType": "string",
"pluginName": "string",
"displayName": "string",
"id": "string",
"href": "string"
}string
pluginType
Optional
pluginType
string
pluginName
Optional
pluginName
string
displayName
Optional
displayName
string
id
Optional
id
string
href
Optional
href
object
additionalAttributes
Optional
additionalAttributes
o11n-inventoryType
JSON Example
{
"pluginType": "string",
"pluginName": "string",
"name": "string",
"icon": {
"data": [
"string"
],
"href": "string",
"contentType": "string"
},
"description": "string",
"properties": [
{
"displayName": "string",
"name": "string",
"description": "string"
}
]
}string
pluginType
Optional
pluginType
string
pluginName
Optional
pluginName
string
name
Optional
name
string
description
Optional
description
o11n-inventoryTypeProperty
JSON Example
{
"displayName": "string",
"name": "string",
"description": "string"
}string
displayName
Optional
displayName
string
name
Optional
name
string
description
Optional
description
o11n-logEntry
Represents a Workflow run log entry
JSON Example
{
"severity": "string",
"description": "string",
"user": "string",
"short-description": "string",
"timestamp": "string"
}string
severity
Optional
severity
string
description
Optional
long description
string
user
Optional
user
string
short-description
Optional
short description
string As date-time As date-time
timestamp
Optional
timestamp
o11n-logs
Represents a Workflow run logs. Contains list of o11n-logEntry.
JSON Example
{
"logEntries": [
{
"severity": "string",
"description": "string",
"user": "string",
"short-description": "string",
"timestamp": "string"
}
]
}
o11n-tagInstanceList
JSON Example
{
"id": "string"
}object
userTags
Optional
userTags
string
id
Optional
id
object
globalTags
Optional
globalTags
o11n-workflow
Represents a Workflow definition
JSON Example
{
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"outputParameters": [
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
}string
name
Required
Workflow name
string
description
Required
Workflow description
string
id
Required
Workflow id
o11n-workflowCategory
Represents a Workflow category
JSON Example
{
"name": "string",
"id": "string",
"categories": [
"o11n-workflowCategory Object"
],
"workflows": [
{
"name": "string",
"description": "string",
"id": "string",
"inputParameters": [
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}
],
"outputParameters": [
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
}
]
}string
name
Required
Workflow category name
string
id
Required
Workflow category id
o11n-workflowParameter
Represents a Workflow parameter
JSON Example
{
"parameterType": "string",
"name": "string",
"description": "string",
"type": "string"
}string
parameterType
Optional
Workflow parameter type
string
name
Required
Workflow parameter name
string
description
Optional
Workflow parameter description
string
type
Required
Workflow parameter value type
routineRunCorrelation
Represents a Routine run correlation
JSON Example
{
"correlationType": "string",
"correlationId": "string"
}string
correlationType
Required
correlationType
string
correlationId
Required
correlationId
routineRunInfo
Represents a Routine run information
JSON Example
{
"traceId": "string",
"executionId": "string",
"correlation": {
"correlationType": "string",
"correlationId": "string"
},
"tenantId": "string",
"id": "string",
"routineId": "string",
"routineRunStatus": "string"
}string
traceId
Optional
traceId
string
executionId
Optional
executionId
string
tenantId
Optional
tenantId
string As uuid As uuid
id
Required
id
string
routineId
Optional
routineId
string
routineRunStatus
Optional
routineRunStatus
routineRunRequest
Represents a Routine run request
JSON Example
{
"requestedBy": "string",
"correlation": {
"correlationType": "string",
"correlationId": "string"
},
"routineRunId": "string",
"description": "string",
"callbackServiceId": "string",
"requestHeader": {
"entries": [
{
"key": "string"
}
]
},
"requestData": {
"entries": [
{
"key": "string"
}
]
}
}string
requestedBy
Optional
name/id of the user requested the routine run
string
routineRunId
Optional
optional parameter which sets the id of the routine run once created. may be disregarded
string
description
Optional
human readable description for the routine run request
string
callbackServiceId
Optional
service id to callback on routine run complete/fail
routineRunRunResult
Represents a Routine run result
JSON Example
{
"requestedBy": "string",
"correlation": {
"correlationType": "string",
"correlationId": "string"
},
"resultData": {
"entries": [
{
"key": "string"
}
]
},
"requestId": "string",
"runDetails": "string",
"resultHeader": {
"entries": [
{
"key": "string"
}
]
},
"runStatus": "string",
"createDate": "string",
"completeDate": "string"
}string
requestedBy
Optional
requestedBy
string
requestId
Optional
requestId
string
runDetails
Optional
runDetails
string
runStatus
Optional
runStatus
string As date-time As date-time
createDate
Optional
createDate
string As date-time As date-time
completeDate
Optional
completeDate
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-0:8080: