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, and OFTP2.

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>
          <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>

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​


    <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" folderId="120088" componentId="12345678-9abc-def0-1234-56789abcdef0"
    componentName="Disk Comms Channel" folderName="Boomi" folderId="894" branchId="QjoyMDI1OTk" branchName="branch-1">
            <bns:PartnerCommunication>
              <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: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: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: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)

  • 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: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: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.

  • 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