PREVIEW: This API is in preview and under active development. Endpoints and schemas are subject to breaking changes, and backward compatibility is not guaranteed until the API is promoted to a stable version.
REST API of the Lobster Platform for headless and AI-agent consumption.
Authentication
Three authentication flows are available. All three produce a bearer token that must be sent as Authorization: Bearer <token> on every request.
1. OAuth2 Client Credentials (machine-to-machine)
Exchange a client id/secret provisioned in the Lobster administration UI:
POST /dw/register/oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=<id>&client_secret=<secret>
2. UI Session Bearer Token
Log in via the Lobster web UI, then exchange the session cookie for a token:
GET /auth/sessionBearerToken
3. Guest User Login Token
Append a GuestUser loginToken as a URL query parameter to establish a session without a password, then retrieve the bearer token the same way:
GET <host>?loginToken=<GuestUser token>
GET /auth/sessionBearerToken
Errors
Errors share a single envelope (see the Error schema): an errorInfo object with a machine-readable errorCode, a human-readable errorText, and the httpResponseStatus.
Schemas
IntegrationPartnerChannel
One of: IntegrationPartnerChannelIoT, IntegrationPartnerChannelHTTP, IntegrationPartnerChannelSMB, IntegrationPartnerChannelFTP, IntegrationPartnerChannelFax, IntegrationPartnerChannelSFTP, IntegrationPartnerChannelMail, IntegrationPartnerChannelX400, IntegrationPartnerChannelAS2, IntegrationPartnerChannelOFTP, IntegrationPartnerChannelAS4. Discriminator: class.
IntegrationPartnerChannelIoT
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelIoT | no |
active | boolean | no |
endpointUrl | string | no |
id | integer (int64) | no |
localCertificateId | string | no |
name | string | no |
opcSecurityPolicy | string | no |
partner | IntegrationPartner | no |
remoteCertificateId | string | no |
IntegrationPartner
| Property | Type | Required |
|---|
class | string: core:IntegrationPartner | no |
id | integer (int64) | no |
name | string | no |
IntegrationPartnerChannelHTTP
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelHTTP | no |
active | boolean | no |
groupName | string | no |
id | integer (int64) | no |
localCertificateId | string | no |
name | string | no |
partner | IntegrationPartner | no |
remoteCertificateId | string | no |
url | string | no |
userRoles | array of string | no |
IntegrationPartnerChannelSMB
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelSMB | no |
active | boolean | no |
host | string | no |
id | integer (int64) | no |
name | string | no |
partner | IntegrationPartner | no |
share | string | no |
smbDomain | string | no |
IntegrationPartnerChannelFTP
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelFTP | no |
active | boolean | no |
host | string | no |
id | integer (int64) | no |
localCertificateId | string | no |
name | string | no |
partner | IntegrationPartner | no |
port | integer (int32) | no |
remoteCertificateId | string | no |
remotePath | string | no |
IntegrationPartnerChannelFax
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelFax | no |
active | boolean | no |
defaultSendHeadline | string | no |
defaultSendStationID | string | no |
expectedHeadline | string | no |
expectedStationID | string | no |
faxIncomingDirectory | string | no |
faxOutgoingDirectory | string | no |
id | integer (int64) | no |
isdnLocalNumber | string | no |
isdnRemoteNumber | string | no |
name | string | no |
partner | IntegrationPartner | no |
IntegrationPartnerChannelSFTP
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelSFTP | no |
active | boolean | no |
host | string | no |
id | integer (int64) | no |
keyFingerprint | string | no |
keyType | string | no |
name | string | no |
partner | IntegrationPartner | no |
port | integer (int32) | no |
privateKeyId | string | no |
remotePath | string | no |
IntegrationPartnerChannelMail
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelMail | no |
active | boolean | no |
id | integer (int64) | no |
imapFolder | string | no |
incomingMaxSize | integer (int64) | no |
localCertificateId | string | no |
name | string | no |
partner | IntegrationPartner | no |
remoteCertificateId | string | no |
retrievalAuthMechanism | string | no |
smtpAuthMechanism | string | no |
smtpServerUrl | string | no |
IntegrationPartnerChannelX400
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelX400 | no |
active | boolean | no |
id | integer (int64) | no |
localId | string | no |
name | string | no |
partner | IntegrationPartner | no |
presentationSelector | string | no |
remoteId | string | no |
sessionSelector | string | no |
transportAccessPoint | string | no |
uafiConfigDirectory | string | no |
uafiInDirectory | string | no |
uafiOutDirectory | string | no |
IntegrationPartnerChannelAS2
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelAS2 | no |
active | boolean | no |
as2Url | string | no |
encryptionAlgorithm | string | no |
id | integer (int64) | no |
localCertificateId | string | no |
mdnMode | integer (int32) | no |
name | string | no |
partner | IntegrationPartner | no |
partnerAs2Id | string | no |
remoteCertificateId | string | no |
signingAlgorithm | string | no |
stationId | string | no |
IntegrationPartnerChannelOFTP
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelOFTP | no |
active | boolean | no |
endpointUrl | string | no |
id | integer (int64) | no |
localCertificateId | string | no |
localSsid | string | no |
name | string | no |
partner | IntegrationPartner | no |
remoteCertificateId | string | no |
remoteSfid | string | no |
IntegrationPartnerChannelAS4
| Property | Type | Required |
|---|
class | string: core:IntegrationPartnerChannelAS4 | no |
active | boolean | no |
endpointUrl | string | no |
id | integer (int64) | no |
localCertificateId | string | no |
name | string | no |
partner | IntegrationPartner | no |
remoteCertificateId | string | no |
IntegrationProfile
| Property | Type | Required |
|---|
class | string: core:IntegrationProfile | no |
active | boolean | no |
created | integer (int32) | no |
description | string | no |
encoding | string | no |
group | string | no |
id | string | no |
inputAgentSettings | ProfileInputAgentSettings | no |
inputFileFormatMetadata | AbstractFileFormatMetadata | no |
inputFormat | IntegrationDataFormat | no |
integrationClientId | string | no |
integrationSettings | ProfileIntegrationSettings | no |
lastModified | integer (int32) | no |
lastModifiedGUI | integer (int32) | no |
mappingSettings | MappingSettings | no |
name | string | no |
responseSettings | ProfileResponseSettings | no |
skipMapping | boolean | no |
tags | string | no |
targetFileFormatMetadata | AbstractFileFormatMetadata | no |
targetFormat | IntegrationDataFormat | no |
One of: KafkaAgentSettings, AS2AgentSettings, CronCloudStorageAgentSettings, CronLdapAgentSettings, DataQueueAgentSettings, AS4AgentSettings, FaxAgentSettings, HttpAgentSettings, CronOftpAgentSettings, SFTPAgentSettings, ManualUploadAgentSettings, TcpAgentSettings, CronCustomAgentSettings, FTPAgentSettings, CronPop3AgentSettings, MQTTAgentSettings, MessageAgentSettings, OFTPAgentSettings, CronImapAgentSettings, CronMongodbAgentSettings, CronOrchestrationAgentSettings, AMQPAgentSettings, PortalAgentSettings, CronFileAgentSettings, CronSqlAgentSettings, CronSapAgentSettings, SMTPAgentSettings, CronSshAgentSettings, CronWebdavAgentSettings, CronSftpAgentSettings, SolutionAgentSettings, CronX400AgentSettings, CronHttpAgentSettings, CronFtpAgentSettings, IoTAgentSettings. Discriminator: class.
KafkaAgentSettings
| Property | Type | Required |
|---|
class | string: core:KafkaAgentSettings | no |
alias | string | no |
assigned | boolean | no |
binaryConverterClassName | string | no |
clientId | string | no |
commitEach | boolean | no |
commitInterval | integer (int32) | no |
complexDataType | string | no |
dataType | string | no |
delimiter | string | no |
finalValueFunction | string | no |
genericDataType | integer (int32) | no |
keyType | string | no |
messageBufferSize | integer (int32) | no |
messageIntervalCheck | integer (int32) | no |
nullInstance | boolean | no |
registryChannelId | integer (int64) | no |
schemaRegistryUrl | string | no |
timeout | integer (int32) | no |
topicName | string | no |
triggerOnAnyServer | boolean | no |
typeName | string | no |
AS2AgentSettings
| Property | Type | Required |
|---|
class | string: core:AS2AgentSettings | no |
channels | array of IntegrationPartnerChannelAS2 | no |
filePattern | string | no |
mimeType | string | no |
subject | string | no |
typeName | string | no |
CronCloudStorageAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronCloudStorageAgentSettings | no |
acceptEmptyFiles | boolean | no |
bucket | string | no |
comChannelId | integer (int64) | no |
cronSchedule | array of string | no |
deleteEmptyFiles | boolean | no |
dir | string | no |
dmz | boolean | no |
documentLibrary | string | no |
excludeHour | integer (int32) | no |
excludeMinute | integer (int32) | no |
excludeSecond | integer (int32) | no |
fileHandling | integer (int32) | no |
filePattern | string | no |
fileSortAscending | boolean | no |
fileSortItem | integer (int32) | no |
readTempFiles | boolean | no |
recursiveDir | boolean | no |
runInBackground | boolean | no |
typeName | string | no |
CronLdapAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronLdapAgentSettings | no |
alias | string | no |
attributes | string | no |
baseDN | string | no |
cronSchedule | array of string | no |
resultLimit | integer (int32) | no |
search | string | no |
searchScope | integer (int32) | no |
timeLimit | integer (int32) | no |
typeName | string | no |
wrapFields | boolean | no |
DataQueueAgentSettings
| Property | Type | Required |
|---|
class | string: core:DataQueueAgentSettings | no |
alias | string | no |
className | string | no |
errorOnNoData | boolean | no |
factoryName | string | no |
host | string | no |
interval | integer (int64) | no |
key | string | no |
queue | string | no |
sqlStatement | string | no |
typeName | string | no |
useSql | boolean | no |
AS4AgentSettings
| Property | Type | Required |
|---|
class | string: core:AS4AgentSettings | no |
channels | array of IntegrationPartnerChannelAS4 | no |
filePattern | string | no |
mimeType | string | no |
typeName | string | no |
FaxAgentSettings
| Property | Type | Required |
|---|
class | string: core:FaxAgentSettings | no |
acceptAll | boolean | no |
channelIds | array of integer (int64) | no |
typeName | string | no |
HttpAgentSettings
| Property | Type | Required |
|---|
class | string: core:HttpAgentSettings | no |
acceptEmptyBody | boolean | no |
acceptEmptyResponse | boolean | no |
acceptHttpDelete | boolean | no |
acceptHttpGet | boolean | no |
acceptHttpHead | boolean | no |
acceptHttpPatch | boolean | no |
acceptHttpPost | boolean | no |
acceptHttpPut | boolean | no |
acceptREST | boolean | no |
asyncRequest | boolean | no |
authenticationType | string | no |
deleteHasPayload | boolean | no |
enableApi | boolean | no |
errorCode | string | no |
invisibleForDmz | boolean | no |
jwtScopes | string | no |
mimeType | string | no |
multiPartFileKey | string | no |
namespaceUrl | string | no |
responseOnError | string | no |
responseOnSuccess | string | no |
restUrlPlaceholder | string | no |
swaggerResponseDesc | string | no |
swaggerTransformerVersion | string | no |
typeName | string | no |
url | string | no |
useResponseOnSuccess | boolean | no |
webservice | boolean | no |
wsdlCreator | string | no |
CronOftpAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronOftpAgentSettings | no |
acceptEmptyFiles | boolean | no |
channel | IntegrationPartnerChannelOFTP | no |
cronSchedule | array of string | no |
destination | string | no |
oftpDmzOption | string | no |
oftpPort | integer (int32) | no |
oftpServiceName | string | no |
oftpTLS | boolean | no |
origin | string | no |
runInBackground | boolean | no |
typeName | string | no |
SFTPAgentSettings
| Property | Type | Required |
|---|
class | string: core:SFTPAgentSettings | no |
acceptEmptyFiles | boolean | no |
channels | array of IntegrationPartnerChannelSFTP | no |
dir | string | no |
fileName | string | no |
processOnLogout | boolean | no |
transferType | integer (int32) | no |
typeName | string | no |
ManualUploadAgentSettings
| Property | Type | Required |
|---|
class | string: core:ManualUploadAgentSettings | no |
typeName | string | no |
TcpAgentSettings
| Property | Type | Required |
|---|
class | string: core:TcpAgentSettings | no |
alias | string | no |
binaryConverterClassName | string | no |
factoryName | string | no |
typeName | string | no |
CronCustomAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronCustomAgentSettings | no |
configFile | string | no |
cronSchedule | array of string | no |
customClass | string | no |
runInBackground | boolean | no |
typeName | string | no |
FTPAgentSettings
| Property | Type | Required |
|---|
class | string: core:FTPAgentSettings | no |
acceptEmptyFiles | boolean | no |
channels | array of IntegrationPartnerChannelFTP | no |
dir | string | no |
fileName | string | no |
processOnLogout | boolean | no |
typeName | string | no |
CronPop3AgentSettings
| Property | Type | Required |
|---|
class | string: core:CronPop3AgentSettings | no |
channel | IntegrationPartnerChannelMail | no |
cronSchedule | array of string | no |
handleUnknownMailData | integer (int32) | no |
runInBackground | boolean | no |
skipCorruptMail | boolean | no |
supportSMIME | boolean | no |
typeName | string | no |
MQTTAgentSettings
| Property | Type | Required |
|---|
class | string: core:MQTTAgentSettings | no |
alias | string | no |
binaryConverterClassName | string | no |
complexDataType | string | no |
delimiter | string | no |
finalValueFunction | string | no |
genericDataType | integer (int32) | no |
messageBufferSize | integer (int32) | no |
messageIntervalCheck | integer (int32) | no |
qos | string | no |
timeout | integer (int32) | no |
topic | string | no |
typeName | string | no |
MessageAgentSettings
| Property | Type | Required |
|---|
class | string: core:MessageAgentSettings | no |
comChannelId | integer (int64) | no |
context | string | no |
param | string | no |
queue | string | no |
typeName | string | no |
OFTPAgentSettings
| Property | Type | Required |
|---|
class | string: core:OFTPAgentSettings | no |
channels | array of IntegrationPartnerChannelOFTP | no |
destination | string | no |
fileName | string | no |
origin | string | no |
processOnLogout | boolean | no |
typeName | string | no |
CronImapAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronImapAgentSettings | no |
channel | IntegrationPartnerChannelMail | no |
cronSchedule | array of string | no |
dir | string | no |
handleUnknownMailData | integer (int32) | no |
imapMoveDir | string | no |
runInBackground | boolean | no |
skipCorruptMail | boolean | no |
supportSMIME | boolean | no |
typeName | string | no |
CronMongodbAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronMongodbAgentSettings | no |
alias | string | no |
collectionName | string | no |
cronSchedule | array of string | no |
databaseName | string | no |
jsonType | string | no |
maxBatchSize | integer (int32) | no |
maxRows | integer (int32) | no |
oneDocument | boolean | no |
projection | string | no |
query | string | no |
typeName | string | no |
CronOrchestrationAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronOrchestrationAgentSettings | no |
configFile | string | no |
cronSchedule | array of string | no |
customClass | string | no |
runInBackground | boolean | no |
typeName | string | no |
AMQPAgentSettings
| Property | Type | Required |
|---|
class | string: core:AMQPAgentSettings | no |
alias | string | no |
confirmMessageAtEnd | boolean | no |
delimiter | string | no |
finalValueFunction | string | no |
genericDataType | integer (int32) | no |
jmsUnsubscribeTopic | boolean | no |
messageBufferSize | integer (int32) | no |
messageIntervalCheck | integer (int32) | no |
persistent | boolean | no |
prefetchCount | integer (int32) | no |
prefetchSize | integer (int32) | no |
propertyKeyForFileName | string | no |
qualityOfService | string | no |
queueName | string | no |
queueType | integer (int32) | no |
requeue091 | boolean | no |
routingKey | string | no |
subscriberName | string | no |
timeout | integer (int32) | no |
typeName | string | no |
PortalAgentSettings
| Property | Type | Required |
|---|
class | string: core:PortalAgentSettings | no |
allowAnonymousAccess | boolean | no |
eventTimeout | integer (int32) | no |
form | string | no |
readOnly | boolean | no |
roles | array of string | no |
synchronous | boolean | no |
typeName | string | no |
upload | boolean | no |
userIds | array of string | no |
CronFileAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronFileAgentSettings | no |
acceptEmptyFiles | boolean | no |
cronSchedule | array of string | no |
deleteEmptyFiles | boolean | no |
dirIsMounted | boolean | no |
directory | string | no |
excludeHour | integer (int32) | no |
excludeMinute | integer (int32) | no |
excludeSecond | integer (int32) | no |
fileHandling | integer (int32) | no |
filePattern | string | no |
fileSortAscending | boolean | no |
fileSortItem | integer (int32) | no |
lockFile | string | no |
readTempFiles | boolean | no |
recursiveDir | boolean | no |
runInBackground | boolean | no |
singleFile | boolean | no |
typeName | string | no |
CronSqlAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronSqlAgentSettings | no |
cronSchedule | array of string | no |
dbAlias | string | no |
encodeBlob | boolean | no |
sql | string | no |
sqlTestTimeout | integer (int32) | no |
sqlTimeout | integer (int32) | no |
typeName | string | no |
CronSapAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronSapAgentSettings | no |
alias | string | no |
cronSchedule | array of string | no |
format | integer (int32) | no |
rfcName | string | no |
typeName | string | no |
waitTime | integer (int32) | no |
SMTPAgentSettings
| Property | Type | Required |
|---|
class | string: core:SMTPAgentSettings | no |
active | boolean | no |
cc | string | no |
channelId | integer (int64) | no |
channelMatchType | integer (int32) | no |
contentType | integer (int32) | no |
exactSubjectMatch | boolean | no |
filePattern | string | no |
mailType | integer (int32) | no |
mimeType | string | no |
profileName | string | no |
sender | string | no |
subject | string | no |
to | string | no |
typeName | string | no |
CronSshAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronSshAgentSettings | no |
channel | IntegrationPartnerChannelSFTP | no |
cronSchedule | array of string | no |
dir | string | no |
fileHandling | integer (int32) | no |
filePattern | string | no |
fileRename | string | no |
runInBackground | boolean | no |
typeName | string | no |
CronWebdavAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronWebdavAgentSettings | no |
certId | integer (int64) | no |
comChannelId | integer (int64) | no |
cronSchedule | array of string | no |
dir | string | no |
fileHandling | integer (int32) | no |
filePattern | string | no |
fileRename | string | no |
runInBackground | boolean | no |
typeName | string | no |
url | string | no |
CronSftpAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronSftpAgentSettings | no |
acceptEmptyFiles | boolean | no |
as400Member | boolean | no |
channel | IntegrationPartnerChannelSFTP | no |
controlSuffix | string | no |
cronSchedule | array of string | no |
deleteEmptyFiles | boolean | no |
deleteMasterCtrlFile | boolean | no |
dir | string | no |
dmz | boolean | no |
fetchControlFile | boolean | no |
fetchMasterCtrlFile | boolean | no |
fileHandling | integer (int32) | no |
filePattern | string | no |
fileRename | string | no |
fileSortAscending | boolean | no |
fileSortItem | integer (int32) | no |
ftpControlNameType | integer (int32) | no |
ftpPassive | boolean | no |
ftpSiteCommands | string | no |
ftpTransferMode | boolean | no |
keepLocalFtpFileIfDeleteWasUnsuccessful | boolean | no |
masterCtrlFile | string | no |
masterCtrlFileInSubDir | boolean | no |
maxFilesPerBatch | integer (int32) | no |
runInBackground | boolean | no |
typeName | string | no |
useControlFile | boolean | no |
useFtpShortList | boolean | no |
SolutionAgentSettings
| Property | Type | Required |
|---|
class | string: core:SolutionAgentSettings | no |
acceptHttpDelete | boolean | no |
acceptHttpGet | boolean | no |
acceptHttpHead | boolean | no |
acceptHttpPatch | boolean | no |
acceptHttpPost | boolean | no |
acceptHttpPut | boolean | no |
mimeType | string | no |
restUrlPlaceholder | string | no |
solutionName | string | no |
swaggerPath | string | no |
swaggerUrl | string | no |
typeName | string | no |
url | string | no |
CronX400AgentSettings
| Property | Type | Required |
|---|
class | string: core:CronX400AgentSettings | no |
channel | IntegrationPartnerChannelX400 | no |
cronSchedule | array of string | no |
dmz | boolean | no |
filterOnlyNewX400 | boolean | no |
filterX400Addresses | boolean | no |
filterX400Date | boolean | no |
handleUnknownMailData | integer (int32) | no |
runInBackground | boolean | no |
typeName | string | no |
x400DoNotDelete | boolean | no |
CronHttpAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronHttpAgentSettings | no |
certId | integer (int64) | no |
continueHttpCronWithSameUrl | boolean | no |
cronSchedule | array of string | no |
dmz | boolean | no |
encodeUrl | boolean | no |
httpContentType | string | no |
httpSettings | HttpClientSettings | no |
httpTimeOut | integer (int32) | no |
ignoreHttpError | boolean | no |
maxPaging | integer (int32) | no |
runInBackground | boolean | no |
selfTrigger | boolean | no |
soapData | string | no |
typeName | string | no |
validCertificateChain | boolean | no |
webServiceRequest | boolean | no |
HttpClientSettings
| Property | Type | Required |
|---|
class | string: core:HttpClientSettings | no |
headers | object | no |
host | string | no |
httpMethod | HttpMethod | no |
port | string | no |
sslEnabled | boolean | no |
uri | string | no |
HttpMethod
CronFtpAgentSettings
| Property | Type | Required |
|---|
class | string: core:CronFtpAgentSettings | no |
acceptEmptyFiles | boolean | no |
as400Member | boolean | no |
channel | IntegrationPartnerChannelFTP | no |
controlSuffix | string | no |
cronSchedule | array of string | no |
deleteEmptyFiles | boolean | no |
deleteMasterCtrlFile | boolean | no |
dir | string | no |
dmz | boolean | no |
fetchControlFile | boolean | no |
fetchMasterCtrlFile | boolean | no |
fileHandling | integer (int32) | no |
filePattern | string | no |
fileRename | string | no |
fileSortAscending | boolean | no |
fileSortItem | integer (int32) | no |
ftpControlNameType | integer (int32) | no |
ftpPassive | boolean | no |
ftpSiteCommands | string | no |
ftpTransferMode | boolean | no |
keepLocalFtpFileIfDeleteWasUnsuccessful | boolean | no |
masterCtrlFile | string | no |
masterCtrlFileInSubDir | boolean | no |
maxFilesPerBatch | integer (int32) | no |
runInBackground | boolean | no |
typeName | string | no |
useControlFile | boolean | no |
useFtpShortList | boolean | no |
IoTAgentSettings
| Property | Type | Required |
|---|
class | string: core:IoTAgentSettings | no |
agentType | string | no |
channelIds | array of integer (int64) | no |
ignoreErrorStatus | boolean | no |
notifyInitial | boolean | no |
sendGenericOKResponse | boolean | no |
subscriptionAlias | string | no |
subscriptionInterval | integer (int64) | no |
subscriptionType | string | no |
typeName | string | no |
One of: CSVFileMetadata. Discriminator: class.
| Property | Type | Required |
|---|
class | string: core:CSVFileMetadata | no |
delimiter | string | no |
loadAsExampleData | boolean | no |
ProfileIntegrationSettings
| Property | Type | Required |
|---|
class | string: core:ProfileIntegrationSettings | no |
postExecutionClass | string | no |
unit | ProfileIU | no |
ProfileIU
One of: XMLCreationIU, JsonCreationIU, EdifactCreationIU. Discriminator: class.
XMLCreationIU
| Property | Type | Required |
|---|
class | string: core:XMLCreationIU | no |
rootName | string | no |
JsonCreationIU
| Property | Type | Required |
|---|
class | string: core:JsonCreationIU | no |
startAtNode | string | no |
EdifactCreationIU
| Property | Type | Required |
|---|
class | string: core:EdifactCreationIU | no |
MappingSettings
| Property | Type | Required |
|---|
class | string: core:MappingSettings | no |
mappings | array of MappingLink | no |
sourceStructure | SourceDataStructure | no |
targetStructure | DestinationDataStructure | no |
MappingLink
| Property | Type | Required |
|---|
class | string: core:MappingLink | no |
destination | string | no |
source | string | no |
xpath | string | no |
SourceDataStructure
| Property | Type | Required |
|---|
class | string: core:SourceDataStructure | no |
nodes | array of DataStructureItem | no |
DataStructureItem
| Property | Type | Required |
|---|
class | string: core:DataStructureItem | no |
children | array of DataStructureItem | no |
name | string | no |
sourceObjectId | string | no |
DestinationDataStructure
| Property | Type | Required |
|---|
class | string: core:DestinationDataStructure | no |
nodes | array of DataStructureItem | no |
ProfileResponseSettings
| Property | Type | Required |
|---|
class | string: core:ProfileResponseSettings | no |
units | array of ProfileResponseUnit | no |
ProfileResponseUnit
One of: FileProfileResponseUnit, AS2ProfileResponseUnit, MailProfileResponseUnit, HttpProfileResponseUnit, FtpProfileResponseUnit. Discriminator: class.
FileProfileResponseUnit
| Property | Type | Required |
|---|
class | string: core:FileProfileResponseUnit | no |
active | boolean | no |
contentType | ResponseContentType | no |
encoding | string | no |
fileName | string | no |
targetBackup | boolean | no |
ResponseContentType
One of: ResponseContentType_ORIG, ResponseContentType_ORIG_UNZIPPED_DIFF_CODING, ResponseContentType_CSV, ResponseContentType_TRIGGER, ResponseContentType_ORIG_UNZIPPED, ResponseContentType_FIX, ResponseContentType_NONE, ResponseContentType_IU. Discriminator: class.
ResponseContentType_ORIG
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_ORIG | no |
ResponseContentType_ORIG_UNZIPPED_DIFF_CODING
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_ORIG_UNZIPPED_DIFF_CODING | no |
ResponseContentType_CSV
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_CSV | no |
ResponseContentType_TRIGGER
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_TRIGGER | no |
ResponseContentType_ORIG_UNZIPPED
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_ORIG_UNZIPPED | no |
ResponseContentType_FIX
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_FIX | no |
ResponseContentType_NONE
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_NONE | no |
ResponseContentType_IU
| Property | Type | Required |
|---|
class | string: core:ResponseContentType_IU | no |
AS2ProfileResponseUnit
| Property | Type | Required |
|---|
class | string: core:AS2ProfileResponseUnit | no |
active | boolean | no |
channel | IntegrationPartnerChannelAS2 | no |
contentType | ResponseContentType | no |
encoding | string | no |
fileName | string | no |
MailProfileResponseUnit
| Property | Type | Required |
|---|
class | string: core:MailProfileResponseUnit | no |
active | boolean | no |
body | string | no |
contentType | ResponseContentType | no |
encoding | string | no |
from | string | no |
subject | string | no |
to | string | no |
HttpProfileResponseUnit
| Property | Type | Required |
|---|
class | string: core:HttpProfileResponseUnit | no |
active | boolean | no |
contentType | ResponseContentType | no |
encoding | string | no |
httpSettings | HttpClientSettings | no |
FtpProfileResponseUnit
| Property | Type | Required |
|---|
class | string: core:FtpProfileResponseUnit | no |
active | boolean | no |
channel | IntegrationPartnerChannelFTP | no |
contentType | ResponseContentType | no |
encoding | string | no |
fileName | string | no |
Error
Standard error envelope returned for all failed requests.
| Property | Type | Required |
|---|
errorInfo | object | no |