Event Broker Service API Data Structures
{
"endpoint": "string",
"id": "string",
"sessionId": "string",
"userId": "string"
}
endpoint
id
sessionId
userId
{
"timeStamp": "string",
"headers": {
"entries": [
{
"key": "string"
}
]
},
"data": {
"entries": [
{
"key": "string"
}
]
},
"sourceType": "string",
"correlationId": "string",
"id": "string",
"eventTopicId": "string",
"sourceIdentity": "string"
}
timeStamp
sourceType
correlationId
id
eventTopicId
sourceIdentity
{
"typeId": "string"
}
typeId
{
"ignoreUnknownFields": "boolean",
"tenantId": "string",
"ids": [
"string"
]
}
ignoreUnknownFields
tenantId
ids
{
"values": {
"entries": [
{
"key": "string"
}
]
}
}
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"providerEntityId": "string"
}
providerEntityId
{
"dependencies": [
"string"
],
"facets": [
{}
]
}
dependencies
{
"offset": "integer",
"count": "integer"
}
offset
count
{
"blockable": "boolean",
"name": "string",
"replyable": "boolean",
"serviceTypeId": "string",
"description": "string",
"persistable": "boolean",
"id": "string",
"type": "string"
}
blockable
name
replyable
serviceTypeId
description
persistable
id
type
{
"canSubscribe": "boolean",
"canPublish": "boolean"
}
canSubscribe
canPublish
{
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
}
extensionId
{
"facets": [
{
"type": "string"
}
]
}
{
"type": "string"
}
type
{
"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": [
{}
]
}
}
displayAdvice
isMultiValued
description
orderIndex
id
label
isMultiValued
description
label
labelSize
displayAdvice
orderIndex
id
{
"size": "integer"
}
size
{
"size": "integer",
"extensionRendererContext": {
"parameterMappings": {
"params": [
{
"key": "string"
}
]
},
"extensionId": "string"
},
"columns": [
"LayoutField Object"
],
"dataType": {
"typeId": "string"
},
"isMultiValued": "boolean",
"description": "string",
"label": "string",
"labelSize": "integer",
"permissibleValues": {
"customAllowed": "boolean"
},
"displayAdvice": "string",
"orderIndex": "integer",
"id": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
}
}
{
"size": "integer"
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
id
label
{
"items": [
{
"size": "integer"
}
]
}
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
id
label
{
"key": "string"
}
key
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"blockable": "boolean",
"name": "string",
"replyable": "boolean",
"serviceTypeId": "string",
"description": "string",
"persistable": "boolean",
"id": "string",
"type": "string"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"number": "integer",
"size": "integer",
"last": "boolean",
"numberOfElements": "integer",
"totalPages": "integer",
"content": [
{
"endpoint": "string",
"endpoints": [
{
"protocol": "string",
"endpoint": "string"
}
],
"blocking": "boolean",
"criteria": "string",
"subscriberId": "string",
"description": "string",
"id": "string",
"eventTopicId": "string",
"requeueDelay": "integer",
"reply": "boolean",
"messageTTL": "integer"
}
],
"first": "boolean",
"totalElements": "integer"
}
number
size
last
numberOfElements
totalPages
first
totalElements
{
"key": "string"
}
key
{
"params": [
{
"key": "string"
}
]
}
{
"customAllowed": "boolean"
}
customAllowed
{
"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": [
{}
]
}
}
]
}
{
"endpoint": "string",
"endpoints": [
{
"protocol": "string",
"endpoint": "string"
}
],
"blocking": "boolean",
"criteria": "string",
"subscriberId": "string",
"description": "string",
"id": "string",
"eventTopicId": "string",
"requeueDelay": "integer",
"reply": "boolean",
"messageTTL": "integer"
}
endpoint
blocking
criteria
subscriberId
description
id
eventTopicId
requeueDelay
reply
messageTTL
{
"protocol": "string",
"endpoint": "string"
}
protocol
endpoint
{
"blocking": "boolean",
"criteria": "string",
"subscriberId": "string",
"description": "string",
"id": "string",
"eventTopicId": "string",
"requeueDelay": "integer",
"messageTTL": "integer"
}
blocking
criteria
subscriberId
description
id
eventTopicId
requeueDelay
messageTTL
{
"formValues": {
"entries": [
{
"key": "string"
}
]
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"trigger": "string",
"triggeredDetailsLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"affectedElements": [
"string"
]
}
trigger
affectedElements
Wraps a boolean value.
{
"value": "boolean"
}
The boolean value.
{
"values": [
{
"label": "string"
}
]
}
{
"pagingInfo": {
"offset": "integer",
"count": "integer"
},
"headers": {
"entries": [
{
"key": "string"
}
]
},
"tenantId": "string",
"text": "string",
"userId": "string",
"dependencyValues": {
"entries": [
{
"key": "string"
}
]
}
}
tenantId
text
userId
{
"elementUpdates": [
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
]
}
{
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
}
Wraps a value such that values of different types can be treated generically.
Equivalent of java.util.Map
{
"entries": [
{
"key": "string"
}
]
}
A literal defining period of time. This period is represented some integral number of a specified timeUnit.e.g. 6 days.
{
"unit": "string",
"amount": "integer"
}
The unit of measure for the time span. e.g: days.
The amount for the time span.
{
"permissibleValues": [
{
"label": "string"
}
],
"extensionRendererContext": {
"entries": [
{
"key": "string"
}
]
},
"facetValues": {
"facets": [
{
"type": "string"
}
]
},
"id": "string",
"detailLayout": {
"pages": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"sections": [
{
"id": "string",
"label": "string",
"state": {
"dependencies": [
"string"
],
"facets": [
{}
]
},
"rows": [
{
"items": [
{
"size": "integer"
}
]
}
]
}
]
}
]
},
"errors": [
"string"
]
}
id
errors
{
"label": "string"
}
label