Documentation Index

Fetch the complete documentation index at: https://docs.lobstersoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

Get profile by id

Prev Next
Get
/platform/api/preview/profiles/{id}

Returns a single integration profile by its identifier.

Security
OAuth

OAuth2 client-credentials flow for machine-to-machine access. Exchange a client id/secret at /dw/register/oauth/token for a bearer token, then send it as Authorization: Bearer <access_token>. Client credentials are provisioned in the Lobster administration UI.

FlowClient Credentials
Token URL/dw/register/oauth/token
Refresh URL/dw/register/oauth/token
HTTP
Type bearer

Bearer token obtained from an authenticated browser or guest-user session.

Flow 1 — UI login: Log in via the Lobster web UI at /, then call GET /auth/sessionBearerToken to exchange the session cookie for a bearer token.

Flow 2 — Guest user login token: Append a GuestUser loginToken as a URL query parameter to the base URL to establish a password-free session:

GET <host>?loginToken=<GuestUser token>

Then call GET /auth/sessionBearerToken to obtain the bearer token.

Path parameters
id
stringRequired

Profile identifier.

Responses
400

The request was malformed or failed validation.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_validation_400",
    "errorLevel": 0,
    "errorText": "Invalid request payload."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

401

Authentication is required or the supplied credentials are invalid.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_AuthenticationManager_401",
    "errorLevel": 0,
    "errorText": "You are not logged in"
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

403

The authenticated client is not permitted to perform this operation.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_permission_403",
    "errorLevel": 0,
    "errorText": "Access denied."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

404

The requested resource does not exist.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_notFound_404",
    "errorLevel": 0,
    "errorText": "Resource not found."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

500

An unexpected server error occurred.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_internalServerError_500",
    "errorLevel": 0,
    "errorText": "Server Error. See logs for more details."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

default

default response

object

core:IntegrationProfile

class
string
Valid values[ "core:IntegrationProfile" ]
active
boolean
created
integer (int32)
description
string
encoding
string
group
string
id
string
inputAgentSettings

core:ProfileInputAgentSettings

OneOf
KafkaAgentSettings
object (KafkaAgentSettings)
class
string
Valid values[ "core:KafkaAgentSettings" ]
alias
string
assigned
boolean
binaryConverterClassName
string
clientId
string
commitEach
boolean
commitInterval
integer (int32)
complexDataType
string
dataType
string
delimiter
string
finalValueFunction
string
genericDataType
integer (int32)
keyType
string
messageBufferSize
integer (int32)
messageIntervalCheck
integer (int32)
nullInstance
boolean
registryChannelId
integer (int64)
schemaRegistryUrl
string
timeout
integer (int32)
topicName
string
triggerOnAnyServer
boolean
typeName
string
AS2AgentSettings
object (AS2AgentSettings)
class
string
Valid values[ "core:AS2AgentSettings" ]
channels
Array of object (IntegrationPartnerChannelAS2)
object

core:IntegrationPartnerChannelAS2

class
string
Valid values[ "core:IntegrationPartnerChannelAS2" ]
active
boolean
as2Url
string
encryptionAlgorithm
string
id
integer (int64)
localCertificateId
string
mdnMode
integer (int32)
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
partnerAs2Id
string
remoteCertificateId
string
signingAlgorithm
string
stationId
string
filePattern
string
mimeType
string
subject
string
typeName
string
CronCloudStorageAgentSettings
object (CronCloudStorageAgentSettings)
class
string
Valid values[ "core:CronCloudStorageAgentSettings" ]
acceptEmptyFiles
boolean
bucket
string
comChannelId
integer (int64)
cronSchedule
Array of string
string
deleteEmptyFiles
boolean
dir
string
dmz
boolean
documentLibrary
string
excludeHour
integer (int32)
excludeMinute
integer (int32)
excludeSecond
integer (int32)
fileHandling
integer (int32)
filePattern
string
fileSortAscending
boolean
fileSortItem
integer (int32)
readTempFiles
boolean
recursiveDir
boolean
runInBackground
boolean
typeName
string
CronLdapAgentSettings
object (CronLdapAgentSettings)
class
string
Valid values[ "core:CronLdapAgentSettings" ]
alias
string
attributes
string
baseDN
string
cronSchedule
Array of string
string
resultLimit
integer (int32)
search
string
searchScope
integer (int32)
timeLimit
integer (int32)
typeName
string
wrapFields
boolean
DataQueueAgentSettings
object (DataQueueAgentSettings)
class
string
Valid values[ "core:DataQueueAgentSettings" ]
alias
string
className
string
errorOnNoData
boolean
factoryName
string
host
string
interval
integer (int64)
key
string
queue
string
sqlStatement
string
typeName
string
useSql
boolean
AS4AgentSettings
object (AS4AgentSettings)
class
string
Valid values[ "core:AS4AgentSettings" ]
channels
Array of object (IntegrationPartnerChannelAS4)
object

core:IntegrationPartnerChannelAS4

class
string
Valid values[ "core:IntegrationPartnerChannelAS4" ]
active
boolean
endpointUrl
string
id
integer (int64)
localCertificateId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
remoteCertificateId
string
filePattern
string
mimeType
string
typeName
string
FaxAgentSettings
object (FaxAgentSettings)
class
string
Valid values[ "core:FaxAgentSettings" ]
acceptAll
boolean
channelIds
Array of integer
integer (int64)
typeName
string
HttpAgentSettings
object (HttpAgentSettings)
class
string
Valid values[ "core:HttpAgentSettings" ]
acceptEmptyBody
boolean
acceptEmptyResponse
boolean
acceptHttpDelete
boolean
acceptHttpGet
boolean
acceptHttpHead
boolean
acceptHttpPatch
boolean
acceptHttpPost
boolean
acceptHttpPut
boolean
acceptREST
boolean
asyncRequest
boolean
authenticationType
string
deleteHasPayload
boolean
enableApi
boolean
errorCode
string
invisibleForDmz
boolean
jwtScopes
string
mimeType
string
multiPartFileKey
string
namespaceUrl
string
responseOnError
string
responseOnSuccess
string
restUrlPlaceholder
string
swaggerResponseDesc
string
swaggerTransformerVersion
string
typeName
string
url
string
useResponseOnSuccess
boolean
webservice
boolean
wsdlCreator
string
CronOftpAgentSettings
object (CronOftpAgentSettings)
class
string
Valid values[ "core:CronOftpAgentSettings" ]
acceptEmptyFiles
boolean
channel
object (IntegrationPartnerChannelOFTP)

core:IntegrationPartnerChannelOFTP

class
string
Valid values[ "core:IntegrationPartnerChannelOFTP" ]
active
boolean
endpointUrl
string
id
integer (int64)
localCertificateId
string
localSsid
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
remoteCertificateId
string
remoteSfid
string
cronSchedule
Array of string
string
destination
string
oftpDmzOption
string
oftpPort
integer (int32)
oftpServiceName
string
oftpTLS
boolean
origin
string
runInBackground
boolean
typeName
string
SFTPAgentSettings
object (SFTPAgentSettings)
class
string
Valid values[ "core:SFTPAgentSettings" ]
acceptEmptyFiles
boolean
channels
Array of object (IntegrationPartnerChannelSFTP)
object

core:IntegrationPartnerChannelSFTP

class
string
Valid values[ "core:IntegrationPartnerChannelSFTP" ]
active
boolean
host
string
id
integer (int64)
keyFingerprint
string
keyType
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
port
integer (int32)
privateKeyId
string
remotePath
string
dir
string
fileName
string
processOnLogout
boolean
transferType
integer (int32)
typeName
string
ManualUploadAgentSettings
object (ManualUploadAgentSettings)
class
string
Valid values[ "core:ManualUploadAgentSettings" ]
typeName
string
TcpAgentSettings
object (TcpAgentSettings)
class
string
Valid values[ "core:TcpAgentSettings" ]
alias
string
binaryConverterClassName
string
factoryName
string
typeName
string
CronCustomAgentSettings
object (CronCustomAgentSettings)
class
string
Valid values[ "core:CronCustomAgentSettings" ]
configFile
string
cronSchedule
Array of string
string
customClass
string
runInBackground
boolean
typeName
string
FTPAgentSettings
object (FTPAgentSettings)
class
string
Valid values[ "core:FTPAgentSettings" ]
acceptEmptyFiles
boolean
channels
Array of object (IntegrationPartnerChannelFTP)
object

core:IntegrationPartnerChannelFTP

class
string
Valid values[ "core:IntegrationPartnerChannelFTP" ]
active
boolean
host
string
id
integer (int64)
localCertificateId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
port
integer (int32)
remoteCertificateId
string
remotePath
string
dir
string
fileName
string
processOnLogout
boolean
typeName
string
CronPop3AgentSettings
object (CronPop3AgentSettings)
class
string
Valid values[ "core:CronPop3AgentSettings" ]
channel
object (IntegrationPartnerChannelMail)

core:IntegrationPartnerChannelMail

class
string
Valid values[ "core:IntegrationPartnerChannelMail" ]
active
boolean
id
integer (int64)
imapFolder
string
incomingMaxSize
integer (int64)
localCertificateId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
remoteCertificateId
string
retrievalAuthMechanism
string
smtpAuthMechanism
string
smtpServerUrl
string
cronSchedule
Array of string
string
handleUnknownMailData
integer (int32)
runInBackground
boolean
skipCorruptMail
boolean
supportSMIME
boolean
typeName
string
MQTTAgentSettings
object (MQTTAgentSettings)
class
string
Valid values[ "core:MQTTAgentSettings" ]
alias
string
binaryConverterClassName
string
complexDataType
string
delimiter
string
finalValueFunction
string
genericDataType
integer (int32)
messageBufferSize
integer (int32)
messageIntervalCheck
integer (int32)
qos
string
timeout
integer (int32)
topic
string
typeName
string
MessageAgentSettings
object (MessageAgentSettings)
class
string
Valid values[ "core:MessageAgentSettings" ]
comChannelId
integer (int64)
context
string
param
string
queue
string
typeName
string
OFTPAgentSettings
object (OFTPAgentSettings)
class
string
Valid values[ "core:OFTPAgentSettings" ]
channels
Array of object (IntegrationPartnerChannelOFTP)
object

core:IntegrationPartnerChannelOFTP

class
string
Valid values[ "core:IntegrationPartnerChannelOFTP" ]
active
boolean
endpointUrl
string
id
integer (int64)
localCertificateId
string
localSsid
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
remoteCertificateId
string
remoteSfid
string
destination
string
fileName
string
origin
string
processOnLogout
boolean
typeName
string
CronImapAgentSettings
object (CronImapAgentSettings)
class
string
Valid values[ "core:CronImapAgentSettings" ]
channel
object (IntegrationPartnerChannelMail)

core:IntegrationPartnerChannelMail

class
string
Valid values[ "core:IntegrationPartnerChannelMail" ]
active
boolean
id
integer (int64)
imapFolder
string
incomingMaxSize
integer (int64)
localCertificateId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
remoteCertificateId
string
retrievalAuthMechanism
string
smtpAuthMechanism
string
smtpServerUrl
string
cronSchedule
Array of string
string
dir
string
handleUnknownMailData
integer (int32)
imapMoveDir
string
runInBackground
boolean
skipCorruptMail
boolean
supportSMIME
boolean
typeName
string
CronMongodbAgentSettings
object (CronMongodbAgentSettings)
class
string
Valid values[ "core:CronMongodbAgentSettings" ]
alias
string
collectionName
string
cronSchedule
Array of string
string
databaseName
string
jsonType
string
maxBatchSize
integer (int32)
maxRows
integer (int32)
oneDocument
boolean
projection
string
query
string
typeName
string
CronOrchestrationAgentSettings
object (CronOrchestrationAgentSettings)
class
string
Valid values[ "core:CronOrchestrationAgentSettings" ]
configFile
string
cronSchedule
Array of string
string
customClass
string
runInBackground
boolean
typeName
string
AMQPAgentSettings
object (AMQPAgentSettings)
class
string
Valid values[ "core:AMQPAgentSettings" ]
alias
string
confirmMessageAtEnd
boolean
delimiter
string
finalValueFunction
string
genericDataType
integer (int32)
jmsUnsubscribeTopic
boolean
messageBufferSize
integer (int32)
messageIntervalCheck
integer (int32)
persistent
boolean
prefetchCount
integer (int32)
prefetchSize
integer (int32)
propertyKeyForFileName
string
qualityOfService
string
queueName
string
queueType
integer (int32)
requeue091
boolean
routingKey
string
subscriberName
string
timeout
integer (int32)
typeName
string
PortalAgentSettings
object (PortalAgentSettings)
class
string
Valid values[ "core:PortalAgentSettings" ]
allowAnonymousAccess
boolean
eventTimeout
integer (int32)
form
string
readOnly
boolean
roles
Array of string
string
synchronous
boolean
typeName
string
upload
boolean
userIds
Array of string
string
CronFileAgentSettings
object (CronFileAgentSettings)
class
string
Valid values[ "core:CronFileAgentSettings" ]
acceptEmptyFiles
boolean
cronSchedule
Array of string
string
deleteEmptyFiles
boolean
dirIsMounted
boolean
directory
string
excludeHour
integer (int32)
excludeMinute
integer (int32)
excludeSecond
integer (int32)
fileHandling
integer (int32)
filePattern
string
fileSortAscending
boolean
fileSortItem
integer (int32)
lockFile
string
readTempFiles
boolean
recursiveDir
boolean
runInBackground
boolean
singleFile
boolean
typeName
string
CronSqlAgentSettings
object (CronSqlAgentSettings)
class
string
Valid values[ "core:CronSqlAgentSettings" ]
cronSchedule
Array of string
string
dbAlias
string
encodeBlob
boolean
sql
string
sqlTestTimeout
integer (int32)
sqlTimeout
integer (int32)
typeName
string
CronSapAgentSettings
object (CronSapAgentSettings)
class
string
Valid values[ "core:CronSapAgentSettings" ]
alias
string
cronSchedule
Array of string
string
format
integer (int32)
rfcName
string
typeName
string
waitTime
integer (int32)
SMTPAgentSettings
object (SMTPAgentSettings)
class
string
Valid values[ "core:SMTPAgentSettings" ]
active
boolean
cc
string
channelId
integer (int64)
channelMatchType
integer (int32)
contentType
integer (int32)
exactSubjectMatch
boolean
filePattern
string
mailType
integer (int32)
mimeType
string
profileName
string
sender
string
subject
string
to
string
typeName
string
CronSshAgentSettings
object (CronSshAgentSettings)
class
string
Valid values[ "core:CronSshAgentSettings" ]
channel
object (IntegrationPartnerChannelSFTP)

core:IntegrationPartnerChannelSFTP

class
string
Valid values[ "core:IntegrationPartnerChannelSFTP" ]
active
boolean
host
string
id
integer (int64)
keyFingerprint
string
keyType
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
port
integer (int32)
privateKeyId
string
remotePath
string
cronSchedule
Array of string
string
dir
string
fileHandling
integer (int32)
filePattern
string
fileRename
string
runInBackground
boolean
typeName
string
CronWebdavAgentSettings
object (CronWebdavAgentSettings)
class
string
Valid values[ "core:CronWebdavAgentSettings" ]
certId
integer (int64)
comChannelId
integer (int64)
cronSchedule
Array of string
string
dir
string
fileHandling
integer (int32)
filePattern
string
fileRename
string
runInBackground
boolean
typeName
string
url
string
CronSftpAgentSettings
object (CronSftpAgentSettings)
class
string
Valid values[ "core:CronSftpAgentSettings" ]
acceptEmptyFiles
boolean
as400Member
boolean
channel
object (IntegrationPartnerChannelSFTP)

core:IntegrationPartnerChannelSFTP

class
string
Valid values[ "core:IntegrationPartnerChannelSFTP" ]
active
boolean
host
string
id
integer (int64)
keyFingerprint
string
keyType
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
port
integer (int32)
privateKeyId
string
remotePath
string
controlSuffix
string
cronSchedule
Array of string
string
deleteEmptyFiles
boolean
deleteMasterCtrlFile
boolean
dir
string
dmz
boolean
fetchControlFile
boolean
fetchMasterCtrlFile
boolean
fileHandling
integer (int32)
filePattern
string
fileRename
string
fileSortAscending
boolean
fileSortItem
integer (int32)
ftpControlNameType
integer (int32)
ftpPassive
boolean
ftpSiteCommands
string
ftpTransferMode
boolean
keepLocalFtpFileIfDeleteWasUnsuccessful
boolean
masterCtrlFile
string
masterCtrlFileInSubDir
boolean
maxFilesPerBatch
integer (int32)
runInBackground
boolean
typeName
string
useControlFile
boolean
useFtpShortList
boolean
SolutionAgentSettings
object (SolutionAgentSettings)
class
string
Valid values[ "core:SolutionAgentSettings" ]
acceptHttpDelete
boolean
acceptHttpGet
boolean
acceptHttpHead
boolean
acceptHttpPatch
boolean
acceptHttpPost
boolean
acceptHttpPut
boolean
mimeType
string
restUrlPlaceholder
string
solutionName
string
swaggerPath
string
swaggerUrl
string
typeName
string
url
string
CronX400AgentSettings
object (CronX400AgentSettings)
class
string
Valid values[ "core:CronX400AgentSettings" ]
channel
object (IntegrationPartnerChannelX400)

core:IntegrationPartnerChannelX400

class
string
Valid values[ "core:IntegrationPartnerChannelX400" ]
active
boolean
id
integer (int64)
localId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
presentationSelector
string
remoteId
string
sessionSelector
string
transportAccessPoint
string
uafiConfigDirectory
string
uafiInDirectory
string
uafiOutDirectory
string
cronSchedule
Array of string
string
dmz
boolean
filterOnlyNewX400
boolean
filterX400Addresses
boolean
filterX400Date
boolean
handleUnknownMailData
integer (int32)
runInBackground
boolean
typeName
string
x400DoNotDelete
boolean
CronHttpAgentSettings
object (CronHttpAgentSettings)
class
string
Valid values[ "core:CronHttpAgentSettings" ]
certId
integer (int64)
continueHttpCronWithSameUrl
boolean
cronSchedule
Array of string
string
dmz
boolean
encodeUrl
boolean
httpContentType
string
httpSettings
object (HttpClientSettings)

core:HttpClientSettings

class
string
Valid values[ "core:HttpClientSettings" ]
headers
object

map

host
string
httpMethod
string

core:HttpMethod

Valid values[ "GET", "GETWITHCONTENT", "POST", "PUT", "PATCH", "DELETE", "DELETEWITHCONTENT", "HEAD" ]
port
string
sslEnabled
boolean
uri
string
httpTimeOut
integer (int32)
ignoreHttpError
boolean
maxPaging
integer (int32)
runInBackground
boolean
selfTrigger
boolean
soapData
string
typeName
string
validCertificateChain
boolean
webServiceRequest
boolean
CronFtpAgentSettings
object (CronFtpAgentSettings)
class
string
Valid values[ "core:CronFtpAgentSettings" ]
acceptEmptyFiles
boolean
as400Member
boolean
channel
object (IntegrationPartnerChannelFTP)

core:IntegrationPartnerChannelFTP

class
string
Valid values[ "core:IntegrationPartnerChannelFTP" ]
active
boolean
host
string
id
integer (int64)
localCertificateId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
port
integer (int32)
remoteCertificateId
string
remotePath
string
controlSuffix
string
cronSchedule
Array of string
string
deleteEmptyFiles
boolean
deleteMasterCtrlFile
boolean
dir
string
dmz
boolean
fetchControlFile
boolean
fetchMasterCtrlFile
boolean
fileHandling
integer (int32)
filePattern
string
fileRename
string
fileSortAscending
boolean
fileSortItem
integer (int32)
ftpControlNameType
integer (int32)
ftpPassive
boolean
ftpSiteCommands
string
ftpTransferMode
boolean
keepLocalFtpFileIfDeleteWasUnsuccessful
boolean
masterCtrlFile
string
masterCtrlFileInSubDir
boolean
maxFilesPerBatch
integer (int32)
runInBackground
boolean
typeName
string
useControlFile
boolean
useFtpShortList
boolean
IoTAgentSettings
object (IoTAgentSettings)
class
string
Valid values[ "core:IoTAgentSettings" ]
agentType
string
channelIds
Array of integer
integer (int64)
ignoreErrorStatus
boolean
notifyInitial
boolean
sendGenericOKResponse
boolean
subscriptionAlias
string
subscriptionInterval
integer (int64)
subscriptionType
string
typeName
string
inputFileFormatMetadata

core:AbstractFileFormatMetadata

OneOf
CSVFileMetadata
object (CSVFileMetadata)
class
string
Valid values[ "core:CSVFileMetadata" ]
delimiter
string
loadAsExampleData
boolean
inputFormat
string

core:IntegrationDataFormat

Valid values[ "CSV", "XML", "EXCEL", "FIX", "DB", "EDI", "SAP_ALE", "X12", "BWA", "API", "JSON", "CARGO", "SCHEMA", "SWAGGER", "RAML", "YAML", "JSON_SCHEMA", "MESSAGE_PACK" ]
integrationClientId
string
integrationSettings
object (ProfileIntegrationSettings)

core:ProfileIntegrationSettings

class
string
Valid values[ "core:ProfileIntegrationSettings" ]
postExecutionClass
string
unit

core:ProfileIU

OneOf
XMLCreationIU
object (XMLCreationIU)
class
string
Valid values[ "core:XMLCreationIU" ]
rootName
string
JsonCreationIU
object (JsonCreationIU)
class
string
Valid values[ "core:JsonCreationIU" ]
startAtNode
string
EdifactCreationIU
object (EdifactCreationIU)
class
string
Valid values[ "core:EdifactCreationIU" ]
lastModified
integer (int32)
lastModifiedGUI
integer (int32)
mappingSettings
object (MappingSettings)

core:MappingSettings

class
string
Valid values[ "core:MappingSettings" ]
mappings
Array of object (MappingLink)
object

core:MappingLink

class
string
Valid values[ "core:MappingLink" ]
destination
string
source
string
xpath
string
sourceStructure
object (SourceDataStructure)

core:SourceDataStructure

class
string
Valid values[ "core:SourceDataStructure" ]
nodes
Array of object (DataStructureItem)
object

core:DataStructureItem

class
string
Valid values[ "core:DataStructureItem" ]
children
Array of object (DataStructureItem)
object Recursive

core:DataStructureItem

name
string
sourceObjectId
string
targetStructure
object (DestinationDataStructure)

core:DestinationDataStructure

class
string
Valid values[ "core:DestinationDataStructure" ]
nodes
Array of object (DataStructureItem)
object

core:DataStructureItem

class
string
Valid values[ "core:DataStructureItem" ]
children
Array of object (DataStructureItem)
object Recursive

core:DataStructureItem

name
string
sourceObjectId
string
name
string
responseSettings
object (ProfileResponseSettings)

core:ProfileResponseSettings

class
string
Valid values[ "core:ProfileResponseSettings" ]
units
Array of object (ProfileResponseUnit)

core:ProfileResponseUnit

OneOf
FileProfileResponseUnit
object (FileProfileResponseUnit)
class
string
Valid values[ "core:FileProfileResponseUnit" ]
active
boolean
contentType

core:ResponseContentType

OneOf
ResponseContentType_ORIG
object (ResponseContentType_ORIG)
class
string
Valid values[ "core:ResponseContentType_ORIG" ]
ResponseContentType_ORIG_UNZIPPED_DIFF_CODING
object (ResponseContentType_ORIG_UNZIPPED_DIFF_CODING)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED_DIFF_CODING" ]
ResponseContentType_CSV
object (ResponseContentType_CSV)
class
string
Valid values[ "core:ResponseContentType_CSV" ]
ResponseContentType_TRIGGER
object (ResponseContentType_TRIGGER)
class
string
Valid values[ "core:ResponseContentType_TRIGGER" ]
ResponseContentType_ORIG_UNZIPPED
object (ResponseContentType_ORIG_UNZIPPED)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED" ]
ResponseContentType_FIX
object (ResponseContentType_FIX)
class
string
Valid values[ "core:ResponseContentType_FIX" ]
ResponseContentType_NONE
object (ResponseContentType_NONE)
class
string
Valid values[ "core:ResponseContentType_NONE" ]
ResponseContentType_IU
object (ResponseContentType_IU)
class
string
Valid values[ "core:ResponseContentType_IU" ]
encoding
string
fileName
string
targetBackup
boolean
AS2ProfileResponseUnit
object (AS2ProfileResponseUnit)
class
string
Valid values[ "core:AS2ProfileResponseUnit" ]
active
boolean
channel
object (IntegrationPartnerChannelAS2)

core:IntegrationPartnerChannelAS2

class
string
Valid values[ "core:IntegrationPartnerChannelAS2" ]
active
boolean
as2Url
string
encryptionAlgorithm
string
id
integer (int64)
localCertificateId
string
mdnMode
integer (int32)
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
partnerAs2Id
string
remoteCertificateId
string
signingAlgorithm
string
stationId
string
contentType

core:ResponseContentType

OneOf
ResponseContentType_ORIG
object (ResponseContentType_ORIG)
class
string
Valid values[ "core:ResponseContentType_ORIG" ]
ResponseContentType_ORIG_UNZIPPED_DIFF_CODING
object (ResponseContentType_ORIG_UNZIPPED_DIFF_CODING)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED_DIFF_CODING" ]
ResponseContentType_CSV
object (ResponseContentType_CSV)
class
string
Valid values[ "core:ResponseContentType_CSV" ]
ResponseContentType_TRIGGER
object (ResponseContentType_TRIGGER)
class
string
Valid values[ "core:ResponseContentType_TRIGGER" ]
ResponseContentType_ORIG_UNZIPPED
object (ResponseContentType_ORIG_UNZIPPED)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED" ]
ResponseContentType_FIX
object (ResponseContentType_FIX)
class
string
Valid values[ "core:ResponseContentType_FIX" ]
ResponseContentType_NONE
object (ResponseContentType_NONE)
class
string
Valid values[ "core:ResponseContentType_NONE" ]
ResponseContentType_IU
object (ResponseContentType_IU)
class
string
Valid values[ "core:ResponseContentType_IU" ]
encoding
string
fileName
string
MailProfileResponseUnit
object (MailProfileResponseUnit)
class
string
Valid values[ "core:MailProfileResponseUnit" ]
active
boolean
body
string
contentType

core:ResponseContentType

OneOf
ResponseContentType_ORIG
object (ResponseContentType_ORIG)
class
string
Valid values[ "core:ResponseContentType_ORIG" ]
ResponseContentType_ORIG_UNZIPPED_DIFF_CODING
object (ResponseContentType_ORIG_UNZIPPED_DIFF_CODING)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED_DIFF_CODING" ]
ResponseContentType_CSV
object (ResponseContentType_CSV)
class
string
Valid values[ "core:ResponseContentType_CSV" ]
ResponseContentType_TRIGGER
object (ResponseContentType_TRIGGER)
class
string
Valid values[ "core:ResponseContentType_TRIGGER" ]
ResponseContentType_ORIG_UNZIPPED
object (ResponseContentType_ORIG_UNZIPPED)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED" ]
ResponseContentType_FIX
object (ResponseContentType_FIX)
class
string
Valid values[ "core:ResponseContentType_FIX" ]
ResponseContentType_NONE
object (ResponseContentType_NONE)
class
string
Valid values[ "core:ResponseContentType_NONE" ]
ResponseContentType_IU
object (ResponseContentType_IU)
class
string
Valid values[ "core:ResponseContentType_IU" ]
encoding
string
from
string
subject
string
to
string
HttpProfileResponseUnit
object (HttpProfileResponseUnit)
class
string
Valid values[ "core:HttpProfileResponseUnit" ]
active
boolean
contentType

core:ResponseContentType

OneOf
ResponseContentType_ORIG
object (ResponseContentType_ORIG)
class
string
Valid values[ "core:ResponseContentType_ORIG" ]
ResponseContentType_ORIG_UNZIPPED_DIFF_CODING
object (ResponseContentType_ORIG_UNZIPPED_DIFF_CODING)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED_DIFF_CODING" ]
ResponseContentType_CSV
object (ResponseContentType_CSV)
class
string
Valid values[ "core:ResponseContentType_CSV" ]
ResponseContentType_TRIGGER
object (ResponseContentType_TRIGGER)
class
string
Valid values[ "core:ResponseContentType_TRIGGER" ]
ResponseContentType_ORIG_UNZIPPED
object (ResponseContentType_ORIG_UNZIPPED)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED" ]
ResponseContentType_FIX
object (ResponseContentType_FIX)
class
string
Valid values[ "core:ResponseContentType_FIX" ]
ResponseContentType_NONE
object (ResponseContentType_NONE)
class
string
Valid values[ "core:ResponseContentType_NONE" ]
ResponseContentType_IU
object (ResponseContentType_IU)
class
string
Valid values[ "core:ResponseContentType_IU" ]
encoding
string
httpSettings
object (HttpClientSettings)

core:HttpClientSettings

class
string
Valid values[ "core:HttpClientSettings" ]
headers
object

map

host
string
httpMethod
string

core:HttpMethod

Valid values[ "GET", "GETWITHCONTENT", "POST", "PUT", "PATCH", "DELETE", "DELETEWITHCONTENT", "HEAD" ]
port
string
sslEnabled
boolean
uri
string
FtpProfileResponseUnit
object (FtpProfileResponseUnit)
class
string
Valid values[ "core:FtpProfileResponseUnit" ]
active
boolean
channel
object (IntegrationPartnerChannelFTP)

core:IntegrationPartnerChannelFTP

class
string
Valid values[ "core:IntegrationPartnerChannelFTP" ]
active
boolean
host
string
id
integer (int64)
localCertificateId
string
name
string
partner
object (IntegrationPartner)

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string
port
integer (int32)
remoteCertificateId
string
remotePath
string
contentType

core:ResponseContentType

OneOf
ResponseContentType_ORIG
object (ResponseContentType_ORIG)
class
string
Valid values[ "core:ResponseContentType_ORIG" ]
ResponseContentType_ORIG_UNZIPPED_DIFF_CODING
object (ResponseContentType_ORIG_UNZIPPED_DIFF_CODING)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED_DIFF_CODING" ]
ResponseContentType_CSV
object (ResponseContentType_CSV)
class
string
Valid values[ "core:ResponseContentType_CSV" ]
ResponseContentType_TRIGGER
object (ResponseContentType_TRIGGER)
class
string
Valid values[ "core:ResponseContentType_TRIGGER" ]
ResponseContentType_ORIG_UNZIPPED
object (ResponseContentType_ORIG_UNZIPPED)
class
string
Valid values[ "core:ResponseContentType_ORIG_UNZIPPED" ]
ResponseContentType_FIX
object (ResponseContentType_FIX)
class
string
Valid values[ "core:ResponseContentType_FIX" ]
ResponseContentType_NONE
object (ResponseContentType_NONE)
class
string
Valid values[ "core:ResponseContentType_NONE" ]
ResponseContentType_IU
object (ResponseContentType_IU)
class
string
Valid values[ "core:ResponseContentType_IU" ]
encoding
string
fileName
string
skipMapping
boolean
tags
string
targetFileFormatMetadata

core:AbstractFileFormatMetadata

OneOf
CSVFileMetadata
object (CSVFileMetadata)
class
string
Valid values[ "core:CSVFileMetadata" ]
delimiter
string
loadAsExampleData
boolean
targetFormat
string

core:IntegrationDataFormat

Valid values[ "CSV", "XML", "EXCEL", "FIX", "DB", "EDI", "SAP_ALE", "X12", "BWA", "API", "JSON", "CARGO", "SCHEMA", "SWAGGER", "RAML", "YAML", "JSON_SCHEMA", "MESSAGE_PACK" ]