Waiting for engine...
Skip to main content

Shared Communication Channel Component object

The Shared Communication Channel Component object allows users to retrieve, query, update, and delete Shared Communication Channel components through the Boomi Enterprise Platform API.

Structure​


<SharedCommunicationChannelComponent xmlns:ns1="http://api.platform.boomi.com/" componentName="" componentId="" folderName="" folderId="" branchId="" branchName="">
   <PartnerCommunication>
      <DiskCommunicationOptions>
         <DiskGetOptions useDefaultGetOptions="" deleteAfterRead="" maxFileCount="" filterMatchType="">
            <fileFilter></fileFilter>
            <getDirectory></getDirectory>
         </DiskGetOptions>
         <DiskSendOptions useDefaultSendOptions="" createDirectory="" writeOption="">
            <sendDirectory></sendDirectory>
         </DiskSendOptions>
      </DiskCommunicationOptions>
   </PartnerCommunication>
   <PartnerArchiving>
      <enableArchiving></enableArchiving>
      <inboundDirectory></inboundDirectory>
      <outboundDirectory></outboundDirectory>
   </PartnerArchiving>
</SharedCommunicationChannelComponent>

The PartnerCommunication portion of this structure varies depending on which communication option you want to use for the Shared Communication Channel component. The following sections include the structures for AS2, Disk, FTP, SFTP, HTTP, OFTP2, and Generic.

AS2 communication options​


    <AS2CommunicationOptions>
      <AS2SendSettings useDefaultSettings="" authenticationType="">
        <url>SampleUrl</url>
        <sslCertificate componentId=""/>
        <clientSSLCertificate componentId=""/>
        <AuthSettings/>
        <verifyHostname/>
      </AS2SendSettings>
      <AS2SendOptions>
        <AS2PartnerInfo>
          <as2Id></as2Id>
          <signingPublicCertificate componentId=""/>
          <encryptionPublicCertificate componentId=""/>
          <mdnSignaturePublicCertificate componentId=""/>
          <clientSSLCertificate componentId=""/>
          <basicAuthEnabled></basicAuthEnabled>
          <rejectDuplicateMessages></rejectDuplicateMessages>
          <requireEncryptedMessages></requireEncryptedMessages>
          <requireSignedMessages></requireSignedMessages>
          <messagesToCheckForDuplicates></messagesToCheckForDuplicates>
          <ListenAuthSettings user="" password=""/>
          <ListenAttachmentSettings multipleAttachments="" attachmentCache="">
             <attachmentContentType></attachmentContentType>
          </ListenAttachmentSettings>
          <enabledLegacySMIME></enabledLegacySMIME>
          <enabledFoldedHeaders></enabledFoldedHeaders>
        </AS2PartnerInfo>
        <AS2MessageOptions encryptionAlgorithm="" dataContentType="" signingDigestAlg="" signed="" encrypted="" compressed="" multipleAttachments="" maxDocumentCount="">
          <subject></subject>
        </AS2MessageOptions>
        <AS2MDNOptions requestMDN="" synchronous="" signed="" useSSL="" mdnDigestAlg="" useExternalURL="">
               <externalURL></externalURL>
            </AS2MDNOptions>
      </AS2SendOptions>
  </AS2CommunicationOptions>

note

The requireEncryptedMessages and requireSignedMessages fields determine whether incoming AS2 messages must be encrypted or signed. Their behavior varies based on the operation type and field value:

  • If not specified, the value defaults to true for CREATE operations and false for UPDATE operations
  • If an invalid value is provided, it is treated as not specified. Values consisting of a single character or starting with "f" are interpreted as false

Disk communication options​


    <DiskCommunicationOptions>
      <DiskGetOptions useDefaultGetOptions="" deleteAfterRead="" maxFileCount="" filterMatchType="">
        <fileFilter></fileFilter>
        <getDirectory></getDirectory>
      </DiskGetOptions>
      <DiskSendOptions useDefaultSendOptions="" createDirectory="" writeOption="">
        <sendDirectory></sendDirectory>
      </DiskSendOptions>
    </DiskCommunicationOptions>

FTP communication options​


    <FTPCommunicationOptions>
      <FTPSettings useDefaultSettings="" connectionMode="">
        <host></host>
        <port></port>
        <user>Sampleuer</user>
        <FTPSSLOptions useClientAuthentication="" sslmode="">
        <clientSSLCertificate componentId=""/>
      </FTPSSLOptions>
      </FTPSettings>
        <FTPGetOptions useDefaultGetOptions="" ftpAction="" transferType="">
        <remoteDirectory></remoteDirectory>
        <fileToMove></fileToMove>
        <maxFileCount></maxFileCount>
      </FTPGetOptions>
      <FTPSendOptions useDefaultSendOptions="" ftpAction="" transferType="">
        <remoteDirectory></remoteDirectory>
        <moveToDirectory></moveToDirectory>
      </FTPSendOptions>
    </FTPCommunicationOptions>

SFTP communication options​

This section contains the fields for the new SFTP communication method.

<GenericCommunicationOptions connectorType="" CommunicationSettings="">
        <GenericConnectionConfig useDefaultSettings="">
           <field id="remoteDirectory" value="" type="string"/>
           <field id="host" value="" type="string"/>
           <field id="port" value="" type="integer"/>
           <field id="username" value="" type="string"/>
           <field id="password" value="" type="password"/>
           <field id="authType" value="" type="string"/>
           <field id="keyPath" value="" type="string"/>
           <field id="keyPswrd" value="" type="password"/>
           <field id="prvkeyContent" value="" type="password"/>
           <field id="keyContentPwd" value="" type="password"/>
           <field id="pubkeyContent" value="" type="password"/>
           <field id="keyPairName" value="" type="string"/>
           <field id="enablePooling" value="" type="boolean"/>
           <field id="proxyEnable" value="" type="boolean"/>
           <field id="proxyType" value="" type="string"/>
           <field id="proxyHost" value="" type="string"/>
           <field id="proxyPort" value="" type="integer"/>
           <field id="proxyuserName" value="" type="string"/>
           <field id="hostEntry" value="" type="string"/>
           <field id="connectionTimeout" value="" type="integer"/>
           <field id="readTimeout" value="" type="integer"/>
           <field id="kex" value="curve25519-sha256,curve25519-sha256@libssh.org,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,diffie-hellman-group14-sha256" type="string"/>
           <field id="server_host_key" value="ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-512,rsa-sha2-256" type="string"/>
           <field id="cipher.s2c" value="aes128-ctr,aes192-ctr,aes256-ctr,aes128-gcm@openssh.com,aes256-gcm@openssh.com" type="string"/>
           <field id="cipher.c2s" value="aes128-ctr,aes192-ctr,aes256-ctr,aes128-gcm@openssh.com,aes256-gcm@openssh.com" type="string"/>
           <field id="mac.s2c" value="hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,hmac-sha1-etm@openssh.com,hmac-sha2-256,hmac-sha2-512,hmac-sha1" type="string"/>
           <field id="mac.c2s" value="hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,hmac-sha1-etm@openssh.com,hmac-sha2-256,hmac-sha2-512,hmac-sha1" type="string"/>
           <field id="compression.s2c" value="none" type="string"/>
           <field id="compression.c2s" value="none" type="string"/>
           <field id="lang.s2c" value="" type="string"/>
           <field id="lang.c2s" value="" type="string"/>
           <field id="CheckKexes" value="sntrup761x25519-sha512@openssh.com,curve25519-sha256,curve25519-sha256@libssh.org,curve448-sha512" type="string"/>
           <field id="CheckMacs" value="" type="string"/>
           <field id="CheckCiphers" value="chacha20-poly1305@openssh.com" type="string"/>
           <field id="CheckSignatures" value="ssh-ed25519,ssh-ed448" type="string"/>
           <field id="sftpCustomConfiguration" type="customproperties">
               <customProperties/>
            </field>
         </GenericConnectionConfig>
        <GenericOperationConfig operationType="QUERY" customOperationType="" requestProfileType="" responseProfileType="" useDefaultOperationOptions="">
           <field id-="subDirectory" value="" type="string"/>
           <field id="includeChildDirectories" value="false" type="boolean"/>
           <field id="maximumDepth" value="" type="integer"/>
           <field id="fileName" value="" type="string"/>
           <field id="fileNameStrategy" value="WILDCARD" type="string"/>
           <field id="sortBy" value="" type="string"/>
           <field id="sortOrder" value="" type="string"/>
           <field id="count" value="1" type="integer"/>
           <field id="actionAfterRead" value="none" type="string"/>
           <field id="destination" value="" type="string"/>
         </GenericOperationConfig>
        <GenericOperationConfig operationType="CREATE" customOperationType="" requestProfileType="" responseProfileType="" useDefaultOperationOptions="">
            <field id="subDirectory" value="" type="string"/>
            <field id="createDir" value="false" type="boolean"/>
            <field id="actionIfFileExists" value="ERROR" type="string"/>
            <field id="stagingDirectory" value="" type="string"/>
            <field id="tempExtension" value="" type="string"/>
            <field id="targetFileName" value="" type="string"/>
            <field id="tempFileName" value="" type="string"/>
         </GenericOperationConfig>
  </GenericCommunicationOptions>

SFTP (Legacy) communication options​

This section contains the fields for the SFTP (Legacy) communication method.


    <SFTPCommunicationOptions>
      <SFTPSettings useDefaultSettings="">
        <host></host>
        <port></port>
        <user></user>
        <SFTPProxySettings proxyEnabled="" type="">
          <host></host>
          <port></port>
          <user></user>
        </SFTPProxySettings>
        <SFTPSSHOptions sshkeyauth="" dhKeySizeMax1024="">
          <sshkeypath></sshkeypath>
          <knownHostEntry></knownHostEntry>
        </SFTPSSHOptions>
      </SFTPSettings>
      <SFTPGetOptions useDefaultGetOptions="" ftpAction="" moveToForceOverride="">
        <remoteDirectory></remoteDirectory>
        <fileToMove></fileToMove>
        <maxFileCount></maxFileCount>
        <moveToDirectory></moveToDirectory>
      </SFTPGetOptions>
      <SFTPSendOptions useDefaultSendOptions="" ftpAction="" moveToForceOverride="">
        <remoteDirectory></remoteDirectory>
        <moveToDirectory></moveToDirectory>
      </SFTPSendOptions>
    </SFTPCommunicationOptions>

HTTP communication options​


    <HTTPCommunicationOptions>
      <HTTPSettings url="" useBasicAuth="" useCustomAuth="" authenticationType="" connectTimeout="" readTimeout="" cookieScope="" useDefaultSettings="">
        <HTTPAuthSettings user=""/>
        <HTTPOAuthSettings suppressBlankAccessToken=""/>
        <HTTPOAuth2Settings grantType="">
          <credentials clientId=""/>
          <authorizationTokenEndpoint url=""/>
          <authorizationParameters/>
          <accessTokenEndpoint url=""/>
          <accessTokenParameters/>
          <scope></scope>
        </HTTPOAuth2Settings>
        <HTTPSSLOptions clientauth="" clientsslalias="" trustServerCert="" trustedcertalias=""/>
      </HTTPSettings>
      <HTTPGetOptions requestProfileType="" responseProfileType="" responseProfile="" requestProfile="" dataContentType="" methodType="" returnErrors="" followRedirects="" useDefaultOptions="">
        <requestHeaders/>
        <pathElements/>
        <responseHeaderMapping/>
        <reflectHeaders/>
      </HTTPGetOptions>
      <HTTPSendOptions requestProfileType="" responseProfileType="" dataContentType="" methodType="" returnErrors="" followRedirects="" useDefaultOptions="">
        <requestHeaders/>
        <pathElements/>
        <responseHeaderMapping/>
        <reflectHeaders/>
      </HTTPSendOptions>
      <HTTPListenOptions objectName="" username="" useDefaultListenOptions="" mimePassthrough=""/>
    </HTTPCommunicationOptions>

OFTP2 communication options​


    <OFTPCommunicationOptions>
      <OFTPConnectionSettings>
        <host></host>
        <port></port>
        <tls>false</tls>
        <ssidauth>false</ssidauth>
        <sfidciph>"",0</sfidciph>
        <useClientSSL>false</useClientSSL>
        <useGateway>false</useGateway>
      </OFTPConnectionSettings>
      <OFTPGetOptions>
        <OFTPPartnerGroup>
          <myPartnerInfo>
            <ssidcode></ssidcode>
            <encrypting-certificate></encrypting-certificate>
            <ssidcmpr></ssidcmpr>
            <sfidsec-sign></sfidsec-sign>
            <sfidsec-encrypt></sfidsec-encrypt>
            <sfidsign></sfidsign>
          </myPartnerInfo>
        </OFTPPartnerGroup>
      </OFTPGetOptions>
      <OFTPSendOptions type="OFTPSendOptions">
        <OFTPPartnerGroup>
          <myPartnerInfo>
            <ssidcode></ssidcode>
            <encrypting-certificate></encrypting-certificate>
            <ssidcmpr></ssidcmpr>
            <sfidsec-sign></sfidsec-sign>
            <sfidsec-encrypt></sfidsec-encrypt>
            <sfidsign></sfidsign>
          </myPartnerInfo>
        </OFTPSendOptions>
      <OFTPSendOptions type="OFTPSendOptionsInfo">
        <gatewayMode></gatewayMode>
        <sendeerp></sendeerp>
        <cd></cd>
      </OFTPSendOptions>
      <OFTPServerListenOptions>
        <OFTPPartnerGroup>
          <myPartnerInfo>
            <ssidcode></ssidcode>
            <encrypting-certificate></encrypting-certificate>
            <ssidcmpr></ssidcmpr>
            <sfidsec-sign></sfidsec-sign>
            <sfidsec-encrypt></sfidsec-encrypt>
            <sfidsign></sfidsign>
          </myPartnerInfo>
        </OFTPPartnerGroup>
      </OFTPServerListenOptions>
    </OFTPCommunicationOptions>

OFTP2 partner archiving​


    <PartnerArchiving enableArchiving="">
      <componentName></componentName>
      <componentId></componentId>
      <folderName></folderName>
      <folderId></folderId>
    </PartnerArchiving>

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
 SupportedSupportedSupportedSupportedNot Supported Supported

Using the QUERY operation​

You can use the following fields as QUERY filters for the Shared Communication Channel object:

FieldAllowed values
nameAny string value.
communicationTypeas2, disk, ftp, sftp, or http.
note

The name field in a QUERY filter represents the object's componentName field.

SOAP implementation​

  • GET operation

    Request:


    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:api="http://api.platform.boomi.com/">
      <soapenv:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
        </wsse:Security>
      </soapenv:Header>
      <soapenv:Body>
        <api:get>
          <api:objectType>SharedCommunicationChannelComponent</api:objectType>
          <api:objectId>12345678-9abc-def0-1234-56789abcdef0</api:objectId>
        </api:get>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:


    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <S:Body>
        <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <bns:result xsi:type="bns:SharedCommunicationChannelComponent" componentName="New API SFTP Communication Channel" componentId="fe51f351-2554-45ae-a4c0-31210de9f19c" folderName="Samplefolder" folderId="3230906" branchName="main" branchId="QjoyNzQ0NzA" deleted="true">
            <bns:PartnerCommunication>
                  <bns:AS2CommunicationOptions>
                  <bns:AS2SendSettings useDefaultSettings="false" authenticationType="NONE">
                    <bns:AuthSettings/>
                    <bns:verifyHostname>false</bns:verifyHostname>
                  </bns:AS2SendSettings>
                  <bns:AS2SendOptions>
                    <bns:AS2PartnerInfo>
                      <bns:basicAuthEnabled>false</bns:basicAuthEnabled>
                      <bns:rejectDuplicateMessages>false</bns:rejectDuplicateMessages>
                      <bns:messagesToCheckForDuplicates>100000</bns:messagesToCheckForDuplicates>
                      <bns:ListenAuthSettings/>
                      <bns:ListenAttachmentSettings/>
                      <bns:requireEncryptedMessages>true</bns:requireEncryptedMessages>
                      <bns:requireSignedMessages>true</bns:requireSignedMessages>
                    </bns:AS2PartnerInfo>
                    <bns:AS2MessageOptions encryptionAlgorithm="tripledes" dataContentType="textplain" signingDigestAlg="SHA1" signed="false" encrypted="false" compressed="false" multipleAttachments="false" enabledFoldedHeaders="false"/>
                    <bns:AS2MDNOptions requestMDN="false" synchronous="sync" signed="false" useSSL="false" mdnDigestAlg="SHA1" useExternalURL="false" enabledFoldedHeaders="false"/>
                  </bns:AS2SendOptions>
                </bns:AS2CommunicationOptions>            
              <bns:DiskCommunicationOptions>
                <bns:DiskGetOptions useDefaultGetOptions="false" deleteAfterRead="false" maxFileCount="0" filterMatchType="wildcard">
                  <bns:fileFilter>*</bns:fileFilter>
                  <bns:getDirectory>ExampleGetDirectory</bns:getDirectory>
                </bns:DiskGetOptions>
                <bns:DiskSendOptions useDefaultSendOptions="false" createDirectory="true" writeOption="unique">
                <bns:sendDirectory>ExampleSendDirectory</bns:sendDirectory>
                  </bns:DiskSendOptions>
              </bns:DiskCommunicationOptions>
              <bns:GenericCommunicationOptions connectorType="my-custom-connector">
                <bns:GenericConnectionConfig useDefaultSettings="false">
                  <bns:field id="remoteDirectory" value="/mnt/data/qauser/B2B SFTP vX/Outbound" type="string"/>
                  <bns:field id="host" value="ftp.boomi.com" type="string"/>
                  <bns:field id="port" value="22" type="integer"/>
                  <bns:field id="username" value="qauser" type="string"/>
                  <bns:field id="authType" value="None" type="string"/>
                  <bns:field id="keyPath" value="" type="string"/>
                  <bns:field id="keyPairName" value="" type="string"/>
                  <bns:field id="enablePooling" value="false" type="boolean"/>
                  <bns:field id="proxyEnable" value="false" type="boolean"/>
                  <bns:field id="proxyType" value="atom" type="string"/>
                  <bns:field id="proxyHost" value="" type="string"/>
                  <bns:field id="proxyPort" value="" type="integer"/>
                  <bns:field id="proxyuserName" value="" type="string"/>
                  <bns:field id="hostEntry" value="" type="string"/>
                  <bns:field id="connectionTimeout" value="100000" type="integer"/>
                  <bns:field id="readTimeout" value="1000" type="integer"/>
                  <bns:field id="kex" value="curve25519-sha256,curve25519-sha256@libssh.org,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,diffie-hellman-group14-sha256" type="string"/>
                  <bns:field id="server_host_key" value="ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-512,rsa-sha2-256" type="string"/>
                  <bns:field id="cipher.s2c" value="aes128-ctr,aes192-ctr,aes256-ctr,aes128-gcm@openssh.com,aes256-gcm@openssh.com" type="string"/>
                  <bns:field id="cipher.c2s" value="aes128-ctr,aes192-ctr,aes256-ctr,aes128-gcm@openssh.com,aes256-gcm@openssh.com" type="string"/>
                  <bns:field id="mac.s2c" value="hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,hmac-sha1-etm@openssh.com,hmac-sha2-256,hmac-sha2-512,hmac-sha1" type="string"/>
                  <bns:field id="mac.c2s" value="hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,hmac-sha1-etm@openssh.com,hmac-sha2-256,hmac-sha2-512,hmac-sha1" type="string"/>
                  <bns:field id="compression.s2c" value="none" type="string"/>
                  <bns:field id="compression.c2s" value="none" type="string"/>
                  <bns:field id="lang.s2c" value="" type="string"/>
                  <bns:field id="lang.c2s" value="" type="string"/>
                  <bns:field id="CheckKexes" value="sntrup761x25519-sha512@openssh.com,curve25519-sha256,curve25519-sha256@libssh.org,curve448-sha512" type="string"/>
                  <bns:field id="CheckMacs" value="" type="string"/>
                  <bns:field id="CheckCiphers" value="chacha20-poly1305@openssh.com" type="string"/>
                  <bns:field id="CheckSignatures" value="ssh-ed25519,ssh-ed448" type="string"/>
                  <bns:field id="sftpCustomConfiguration" type="customproperties">
                    <bns:customProperties/>
                  </bns:field>
                </bns:GenericConnectionConfig>
                <bns:GenericOperationConfig operationType="CREATE" customOperationType="TPWrite" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <bns:field id="subDirectory" value="" type="string"/>
                  <bns:field id="createDir" value="true" type="boolean"/>
                  <bns:field id="actionIfFileExists" value="FORCE_UNIQUE_NAMES" type="string"/>
                  <bns:field id="stagingDirectory" value="" type="string"/>
                  <bns:field id="tempExtension" value="" type="string"/>
                  <bns:field id="targetFileName" value="$DATE.$EXTENSION" type="string"/>
                  <bns:field id="tempFileName" value="test.dat" type="string"/>
                </bns:GenericOperationConfig>
                <bns:GenericOperationConfig operationType="QUERY" customOperationType="TPList" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <bns:field id="subDirectory" value="" type="string"/>
                  <bns:field id="fileName" value="*.dat" type="string"/>
                  <bns:field id="fileNameStrategy" value="WILDCARD" type="string"/>
                  <bns:field id="sortBy" value="" type="string"/>
                  <bns:field id="sortOrder" value="" type="string"/>
                  <bns:field id="count" value="-1" type="integer"/>
                  <bns:field id="actionAfterRead" value="none" type="string"/>
                  <bns:field id="destination" value="" type="string"/>
                </bns:GenericOperationConfig>
              </bns:GenericCommunicationOptions>
            </bns:PartnerCommunication>
            <bns:PartnerArchiving>
              <bns:enableArchiving>false</bns:enableArchiving>
            </bns:PartnerArchiving>
          </bns:result>
        </bns:getResponse>
      </S:Body>
    </S:Envelope>

  • QUERY operation

    Request:


    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
      <soapenv:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
          <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
          </wsse:UsernameToken>
        </wsse:Security>
      </soapenv:Header>
      <soapenv:Body>
        <api:query>
          <api:objectType>SharedCommunicationChannelComponent</api:objectType>
          <api:queryConfig>
            <api:QueryFilter>
              <api:expression operator="EQUALS" property="standard" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                <api:argument>as2</api:argument>
              </api:expression>
            </api:QueryFilter>
          </api:queryConfig>
        </api:query>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:


    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <S:Body>
        <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <bns:results numberOfResults="3">
            <bns:result xsi:type="bns:SharedCommunicationChannelComponent" componentName="New Communication Channel" communicationType="as2" componentId="0cfe0d5a-0d33-48f8-825a-1d67667e0cd5" folderId="894" branchId="QjoyMDI1OTk" branchName="branch-1"/>
            <bns:result xsi:type="bns:SharedCommunicationChannelComponent" componentName="TestOfficeapi" communicationType="as2" componentId="1cbd3256-308c-4a9d-a70b-dd8b911bc72b" folderId="894" branchId="QjoyMDI1OTk" branchName="branch-1"/>
            <bns:result xsi:type="bns:SharedCommunicationChannelComponent" componentName="Shared AS2 API" communicationType="as2" componentId="24bdabb3-bf20-4138-9324-6270972b8472" folderId="921" branchId="QjoyMDI1OTk" branchName="branch-1"/>
          </bns:results>
        </bns:queryResponse>
      </S:Body>
    </S:Envelope>



  • CREATE operation

    Request:


    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
          <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
          </wsse:UsernameToken>
        </wsse:Security>
      </soapenv:Header>
      <soapenv:Body>
        <api:create>
          <object xsi:type="bns:SharedCommunicationChannelComponent" componentName="Disk Comms Channel" folderName="Boomi" folderId="894" branchId="QjoyMDI1OTk" branchName="branch-1">
            <bns:PartnerCommunication>
                <bns:AS2CommunicationOptions>
                  <bns:AS2SendSettings useDefaultSettings="false" authenticationType="NONE">
                    <bns:AuthSettings/>
                    <bns:verifyHostname>false</bns:verifyHostname>
                  </bns:AS2SendSettings>
                  <bns:AS2SendOptions>
                    <bns:AS2PartnerInfo>
                      <bns:basicAuthEnabled>false</bns:basicAuthEnabled>
                      <bns:rejectDuplicateMessages>false</bns:rejectDuplicateMessages>
                      <bns:messagesToCheckForDuplicates>100000</bns:messagesToCheckForDuplicates>
                      <bns:ListenAuthSettings/>
                      <bns:ListenAttachmentSettings/>
                      <bns:requireEncryptedMessages>true</bns:requireEncryptedMessages>
                      <bns:requireSignedMessages>true</bns:requireSignedMessages>
                    </bns:AS2PartnerInfo>
                    <bns:AS2MessageOptions encryptionAlgorithm="tripledes" dataContentType="textplain" signingDigestAlg="SHA1" signed="false" encrypted="false" compressed="false" multipleAttachments="false" enabledFoldedHeaders="false"/>
                    <bns:AS2MDNOptions requestMDN="false" synchronous="sync" signed="false" useSSL="false" mdnDigestAlg="SHA1" useExternalURL="false" enabledFoldedHeaders="false"/>
                  </bns:AS2SendOptions>
                </bns:AS2CommunicationOptions>            
              <bns:DiskCommunicationOptions>
                <bns:DiskGetOptions useDefaultGetOptions="false" deleteAfterRead="false" maxFileCount="0" filterMatchType="wildcard">
                  <bns:fileFilter>*</bns:fileFilter>
                  <bns:getDirectory>ExampleGetDirectory</bns:getDirectory>
                </bns:DiskGetOptions>
                <bns:DiskSendOptions useDefaultSendOptions="false" createDirectory="true" writeOption="unique">
                  <bns:sendDirectory>ExampleSendDirectory</bns:sendDirectory>
                </bns:DiskSendOptions>
              </bns:DiskCommunicationOptions>
              <api:GenericCommunicationOptions connectorType="my-custom-connector">
                <api:GenericConnectionConfig useDefaultSettings="false">
                  <api:field id="remoteDirectory" value="/mnt/data/qauser/B2B SFTP vX/Outbound" type="string"/>
                  <api:field id="host" value="ftp.boomi.com" type="string"/>
                  <api:field id="port" value="21" type="integer"/>
                  <api:field id="username" value="qauser" type="string"/>
                  <api:field id="authType" value="None" type="string"/>
                  <api:field id="keyPath" value="" type="string"/>
                  <api:field id="keyPairName" value="" type="string"/>
                  <api:field id="enablePooling" value="false" type="boolean"/>
                  <api:field id="proxyEnable" value="false" type="boolean"/>
                  <api:field id="proxyType" value="atom" type="string"/>
                  <api:field id="proxyHost" value="" type="string"/>
                  <api:field id="proxyPort" value="" type="integer"/>
                  <api:field id="proxyuserName" value="" type="string"/>
                  <api:field id="hostEntry" value="" type="string"/>
                  <api:field id="connectionTimeout" value="100000" type="integer"/>
                  <api:field id="readTimeout" value="1000" type="integer"/>
                </api:GenericConnectionConfig>
                <api:GenericOperationConfig operationType="CREATE" customOperationType="TPWrite" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <api:field id="subDirectory" value="" type="string"/>
                  <api:field id="createDir" value="true" type="boolean"/>
                  <api:field id="actionIfFileExists" value="FORCE_UNIQUE_NAMES" type="string"/>
                  <api:field id="stagingDirectory" value="" type="string"/>
                  <api:field id="tempExtension" value="" type="string"/>
                  <api:field id="targetFileName" value="$DATE.$EXTENSION" type="string"/>
                  <api:field id="tempFileName" value="test.dat" type="string"/>
                </api:GenericOperationConfig>
                <api:GenericOperationConfig operationType="QUERY" customOperationType="TPList" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <api:field id="subDirectory" value="" type="string"/>
                  <api:field id="fileName" value="*.dat" type="string"/>
                  <api:field id="fileNameStrategy" value="WILDCARD" type="string"/>
                  <api:field id="sortBy" value="" type="string"/>
                  <api:field id="sortOrder" value="" type="string"/>
                  <api:field id="count" value="-1" type="integer"/>
                  <api:field id="actionAfterRead" value="none" type="string"/>
                  <api:field id="destination" value="" type="string"/>
                </api:GenericOperationConfig>
              </api:GenericCommunicationOptions>
            </bns:PartnerCommunication>
            <bns:PartnerArchiving>
              <bns:enableArchiving>false</bns:enableArchiving>
            </bns:PartnerArchiving>
          </object>
        </api:create>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:

    The response contains the XML representation of the created Shared Communication Channel component, including the:

    • Assigned folder ID
    • Component ID
    • Certificate ID (only if certificates are created)

    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <S:Body>
        <bns:createResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
          <result xsi:type="bns:SharedCommunicationChannelComponent" componentName="TEST SHARED COMM CHANNEL" componentId="6686bf5c-4752-4d8d-a892-2d0c8d7c823d" folderName="Andrey Sentsov/SFTP" folderId="3162667" branchName="main" branchId="QjoyNzQ0NzA">
            <bns:PartnerCommunication>
              <bns:GenericCommunicationOptions connectorType="my-custom-connector">
                <bns:GenericConnectionConfig useDefaultSettings="false">
                  <bns:field id="remoteDirectory" value="/mnt/data/qauser/B2B SFTP vX/Outbound" type="string"/>
                  <bns:field id="host" value="ftp.boomi.com" type="string"/>
                  <bns:field id="port" value="21" type="integer"/>
                  <bns:field id="username" value="qauser" type="string"/>
                  <bns:field id="password" type="password"/>
                  <bns:field id="authType" value="None" type="string"/>
                  <bns:field id="keyPath" value="" type="string"/>
                  <bns:field id="keyPswrd" type="password"/>
                  <bns:field id="prvkeyContent" type="password"/>
                  <bns:field id="keyContentPwd" type="password"/>
                  <bns:field id="pubkeyContent" type="password"/>
                  <bns:field id="keyPairName" value="" type="string"/>
                  <bns:field id="enablePooling" value="false" type="boolean"/>
                  <bns:field id="proxyEnable" value="false" type="boolean"/>
                  <bns:field id="proxyType" value="atom" type="string"/>
                  <bns:field id="proxyHost" value="" type="string"/>
                  <bns:field id="proxyPort" value="" type="integer"/>
                  <bns:field id="proxyuserName" value="" type="string"/>
                  <bns:field id="proxyPassword" type="password"/>
                  <bns:field id="hostEntry" value="" type="string"/>
                  <bns:field id="connectionTimeout" value="100000" type="integer"/>
                  <bns:field id="readTimeout" value="1000" type="integer"/>
                </bns:GenericConnectionConfig>
                <bns:GenericOperationConfig operationType="CREATE" customOperationType="TPWrite" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <bns:field id="subDirectory" value="" type="string"/>
                  <bns:field id="createDir" value="true" type="boolean"/>
                  <bns:field id="actionIfFileExists" value="FORCE_UNIQUE_NAMES" type="string"/>
                  <bns:field id="stagingDirectory" value="" type="string"/>
                  <bns:field id="tempExtension" value="" type="string"/>
                  <bns:field id="targetFileName" value="$DATE.$EXTENSION" type="string"/>
                  <bns:field id="tempFileName" value="test.dat" type="string"/>
                </bns:GenericOperationConfig>
                <bns:GenericOperationConfig operationType="QUERY" customOperationType="TPList" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <bns:field id="subDirectory" value="" type="string"/>
                  <bns:field id="fileName" value="*.dat" type="string"/>
                  <bns:field id="fileNameStrategy" value="WILDCARD" type="string"/>
                  <bns:field id="sortBy" value="" type="string"/>
                  <bns:field id="sortOrder" value="" type="string"/>
                  <bns:field id="count" value="-1" type="integer"/>
                  <bns:field id="actionAfterRead" value="none" type="string"/>
                  <bns:field id="destination" value="" type="string"/>
                </bns:GenericOperationConfig>
              </bns:GenericCommunicationOptions>
            </bns:PartnerCommunication>
            <bns:PartnerArchiving>
              <bns:enableArchiving>false</bns:enableArchiving>
            </bns:PartnerArchiving>
          </result>
        </bns:createResponse>
      </S:Body>
    </S:Envelope>

  • UPDATE operation

    Request:


    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <soapenv:Header>
        <wsse:Security
    xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
          <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
          </wsse:UsernameToken>
        </wsse:Security>
      </soapenv:Header>
      <soapenv:Body>
        <api:update>
          <object xsi:type="bns:SharedCommunicationChannelComponent" componentName="Disk Comms Channel" folderName="Boomi" folderId="894" componentId="12345678-9abc-def0-1234-56789abcdef0" branchId="QjoyMDI1OTk" branchName="branch-1">
            <bns:PartnerCommunication>
                  <bns:AS2CommunicationOptions>
                  <bns:AS2SendSettings useDefaultSettings="false" authenticationType="NONE">
                    <bns:AuthSettings/>
                    <bns:verifyHostname>false</bns:verifyHostname>
                  </bns:AS2SendSettings>
                  <bns:AS2SendOptions>
                    <bns:AS2PartnerInfo>
                      <bns:basicAuthEnabled>false</bns:basicAuthEnabled>
                      <bns:rejectDuplicateMessages>false</bns:rejectDuplicateMessages>
                      <bns:messagesToCheckForDuplicates>100000</bns:messagesToCheckForDuplicates>
                      <bns:ListenAuthSettings/>
                      <bns:ListenAttachmentSettings/>
                      <bns:requireEncryptedMessages>true</bns:requireEncryptedMessages>
                      <bns:requireSignedMessages>true</bns:requireSignedMessages>
                    </bns:AS2PartnerInfo>
                    <bns:AS2MessageOptions encryptionAlgorithm="tripledes" dataContentType="textplain" signingDigestAlg="SHA1" signed="false" encrypted="false" compressed="false" multipleAttachments="false" enabledFoldedHeaders="false"/>
                    <bns:AS2MDNOptions requestMDN="false" synchronous="sync" signed="false" useSSL="false" mdnDigestAlg="SHA1" useExternalURL="false" enabledFoldedHeaders="false"/>
                  </bns:AS2SendOptions>
                </bns:AS2CommunicationOptions>
              <bns:DiskCommunicationOptions>
                <bns:DiskGetOptions useDefaultGetOptions="false" deleteAfterRead="false" maxFileCount="0" filterMatchType="wildcard">
                  <bns:fileFilter>*</bns:fileFilter>
                  <bns:getDirectory>ExampleGetDirectory</bns:getDirectory>
                </bns:DiskGetOptions>
                <bns:DiskSendOptions useDefaultSendOptions="false" createDirectory="true" writeOption="unique">
                  <bns:sendDirectory>ExampleSendDirectory</bns:sendDirectory>
                </bns:DiskSendOptions>
              </bns:DiskCommunicationOptions>
              <api:GenericCommunicationOptions connectorType="my-custom-connector">
                <api:GenericConnectionConfig useDefaultSettings="false">
                  <api:field id="remoteDirectory" value="/mnt/data/qauser/B2B SFTP vX/Outbound" type="string"/>
                  <api:field id="host" value="ftp.boomi.com" type="string"/>
                  <api:field id="port" value="22" type="integer"/>
                  <api:field id="username" value="qauser" type="string"/>
                  <api:field id="authType" value="None" type="string"/>
                  <api:field id="keyPath" value="" type="string"/>
                  <api:field id="keyPairName" value="" type="string"/>
                  <api:field id="enablePooling" value="false" type="boolean"/>
                  <api:field id="proxyEnable" value="false" type="boolean"/>
                  <api:field id="proxyType" value="atom" type="string"/>
                  <api:field id="proxyHost" value="" type="string"/>
                  <api:field id="proxyPort" value="" type="integer"/>
                  <api:field id="proxyuserName" value="" type="string"/>
                  <api:field id="hostEntry" value="" type="string"/>
                  <api:field id="connectionTimeout" value="100000" type="integer"/>
                  <api:field id="readTimeout" value="1000" type="integer"/>
                </api:GenericConnectionConfig>
                <api:GenericOperationConfig operationType="CREATE" customOperationType="TPWrite" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <api:field id="subDirectory" value="" type="string"/>
                  <api:field id="createDir" value="true" type="boolean"/>
                  <api:field id="actionIfFileExists" value="FORCE_UNIQUE_NAMES" type="string"/>
                  <api:field id="stagingDirectory" value="" type="string"/>
                  <api:field id="tempExtension" value="" type="string"/>
                  <api:field id="targetFileName" value="$DATE.$EXTENSION" type="string"/>
                  <api:field id="tempFileName" value="test.dat" type="string"/>
                </api:GenericOperationConfig>
                <api:GenericOperationConfig operationType="QUERY" customOperationType="TPList" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <api:field id="subDirectory" value="" type="string"/>
                  <api:field id="fileName" value="*.dat" type="string"/>
                  <api:field id="fileNameStrategy" value="WILDCARD" type="string"/>
                  <api:field id="sortBy" value="" type="string"/>
                  <api:field id="sortOrder" value="" type="string"/>
                  <api:field id="count" value="-1" type="integer"/>
                  <api:field id="actionAfterRead" value="none" type="string"/>
                  <api:field id="destination" value="" type="string"/>
                </api:GenericOperationConfig>
              </api:GenericCommunicationOptions>
            </bns:PartnerCommunication>
            <bns:PartnerArchiving>
              <bns:enableArchiving>false</bns:enableArchiving>
            </bns:PartnerArchiving>
          </object>
        </api:update>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:

    The response contains the XML representation of the updated Shared Communication Channel component.


    <?xml version='1.0' encoding='UTF-8'?>
    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <S:Body>
        <bns:updateResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
          <result xsi:type="bns:SharedCommunicationChannelComponent" componentName="New UPDATED SFTP Communication Channel" componentId="fe51f351-2554-45ae-a4c0-31210de9f19c" folderName="Samplefolder" folderId="3230906" branchName="main" branchId="QjoyNzQ0NzA">
            <bns:PartnerCommunication>
              <bns:GenericCommunicationOptions connectorType="my-custom-connector">
                <bns:GenericConnectionConfig useDefaultSettings="false">
                  <bns:field id="remoteDirectory" value="/mnt/data/qauser/B2B SFTP vX/Outbound" type="string"/>
                  <bns:field id="host" value="ftp.boomi.com" type="string"/>
                  <bns:field id="port" value="22" type="integer"/>
                  <bns:field id="username" value="qauser" type="string"/>
                  <bns:field id="password" type="password"/>
                  <bns:field id="authType" value="None" type="string"/>
                  <bns:field id="keyPath" value="" type="string"/>
                  <bns:field id="keyPswrd" type="password"/>
                  <bns:field id="prvkeyContent" type="password"/>
                  <bns:field id="keyContentPwd" type="password"/>
                  <bns:field id="pubkeyContent" type="password"/>
                  <bns:field id="keyPairName" value="" type="string"/>
                  <bns:field id="enablePooling" value="false" type="boolean"/>
                  <bns:field id="proxyEnable" value="false" type="boolean"/>
                  <bns:field id="proxyType" value="atom" type="string"/>
                  <bns:field id="proxyHost" value="" type="string"/>
                  <bns:field id="proxyPort" value="" type="integer"/>
                  <bns:field id="proxyuserName" value="" type="string"/>
                  <bns:field id="proxyPassword" type="password"/>
                  <bns:field id="hostEntry" value="" type="string"/>
                  <bns:field id="connectionTimeout" value="100000" type="integer"/>
                  <bns:field id="readTimeout" value="1000" type="integer"/>
                </bns:GenericConnectionConfig>
                <bns:GenericOperationConfig operationType="CREATE" customOperationType="TPWrite" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <bns:field id="subDirectory" value="" type="string"/>
                  <bns:field id="createDir" value="true" type="boolean"/>
                  <bns:field id="actionIfFileExists" value="FORCE_UNIQUE_NAMES" type="string"/>
                  <bns:field id="stagingDirectory" value="" type="string"/>
                  <bns:field id="tempExtension" value="" type="string"/>
                  <bns:field id="targetFileName" value="$DATE.$EXTENSION" type="string"/>
                  <bns:field id="tempFileName" value="test.dat" type="string"/>
                </bns:GenericOperationConfig>
                <bns:GenericOperationConfig operationType="QUERY" customOperationType="TPList" requestProfileType="none" responseProfileType="none" useDefaultOperationOptions="false">
                  <bns:field id="subDirectory" value="" type="string"/>
                  <bns:field id="fileName" value="*.dat" type="string"/>
                  <bns:field id="fileNameStrategy" value="WILDCARD" type="string"/>
                  <bns:field id="sortBy" value="" type="string"/>
                  <bns:field id="sortOrder" value="" type="string"/>
                  <bns:field id="count" value="-1" type="integer"/>
                  <bns:field id="actionAfterRead" value="none" type="string"/>
                  <bns:field id="destination" value="" type="string"/>
                </bns:GenericOperationConfig>
              </bns:GenericCommunicationOptions>
            </bns:PartnerCommunication>
            <bns:PartnerArchiving>
              <bns:enableArchiving>false</bns:enableArchiving>
            </bns:PartnerArchiving>
          </result>
        </bns:updateResponse>
      </S:Body>
    </S:Envelope>

  • DELETE operation

    Request:


    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:api="http://api.platform.boomi.com/">
      <soapenv:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
          <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
          </wsse:UsernameToken>
        </wsse:Security>
      </soapenv:Header>
      <soapenv:Body>
        <api:delete>
          <api:objectType>SharedCommunicationChannelComponent</api:objectType>
          <api:objectId>12345678-9abc-def0-1234-56789abcdef0</api:objectId>
        </api:delete>
      </soapenv:Body>
    </soapenv:Envelope>

    Response:


    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
      <S:Body>
        <bns:deleteResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <successful>true</successful>
        </bns:deleteResponse>
      </S:Body>
    </S:Envelope>

On this Page