Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - SharedCommunicationChannelComponent

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

SharedCommunicationChannelComponent

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

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

Creates a SharedCommunicationChannelComponent object

The sample request creates a Shared Communication Component named Disk Comms Channel.

Authorizations:
basicAuth
Request Body schema:
optional
required
object (SharedCommunicationChannelComponent_PartnerArchiving)
required
object (SharedCommunicationChannelComponent_PartnerCommunication)
componentId
string
deleted
boolean
communicationType
string
folderName
string
branchId
string
folderId
integer <int64>
branchName
string
componentName
string
description
string

Responses

Response Schema:
required
object (SharedCommunicationChannelComponent_PartnerArchiving)
required
object (SharedCommunicationChannelComponent_PartnerCommunication)
componentId
string
deleted
boolean
communicationType
string
folderName
string
branchId
string
folderId
integer <int64>
branchName
string
componentName
string
description
string

Request samples

Content type
{
  • "@type": "SharedCommunicationChannelComponent",
  • "PartnerCommunication": {
    • "@type": "PartnerCommunication",
    • "DiskCommunicationOptions": {
      },
    • "AS2CommunicationOptions": {
      },
    • "GenericCommunicationOptions": [
      ]
    },
  • "PartnerArchiving": {
    • "@type": "PartnerArchiving",
    • "enableArchiving": false
    },
  • "componentName": "NEWWW API SFTP Communication Channel",
  • "folderName": "Samplefolder",
  • "folderId": 3230906,
  • "branchId": "QjoyNzQ0NzA",
  • "branchName": "main",
  • "componentId": "24ffe7cb-0bde-4fa7-ad49-5516b504ba6f"
}

Response samples

Content type
{
  • "@type": "SharedCommunicationChannelComponent",
  • "componentName": "NEWWW API SFTP Communication Channel",
  • "componentId": "24ffe7cb-0bde-4fa7-ad49-5516b504ba6f",
  • "folderName": "Samplefolder",
  • "folderId": 3230906,
  • "branchName": "main",
  • "branchId": "QjoyNzQ0NzA",
  • "PartnerCommunication": {
    • "@type": "PartnerCommunication",
    • "GenericCommunicationOptions": [
      ]
    },
  • "PartnerArchiving": {
    • "@type": "PartnerArchiving",
    • "enableArchiving": false
    }
}

Retrieves an instance of a SharedCommunicationChannelComponent object

Send an HTTP GET request where {accountId} is the ID of the authenticating account for the request and {componentId} is the ID of the component being retrieved.

Authorizations:
basicAuth
path Parameters
id
required
string

Unique identifier componentId for the Shared Communication Channel Component in UUID format. System-generated when created.

Responses

Response Schema:
required
object (SharedCommunicationChannelComponent_PartnerArchiving)
required
object (SharedCommunicationChannelComponent_PartnerCommunication)
componentId
string
deleted
boolean
communicationType
string
folderName
string
branchId
string
folderId
integer <int64>
branchName
string
componentName
string
description
string

Response samples

Content type
{
  • "SharedCommunicationChannelComponent": {
    • "PartnerCommunication": {
      },
    • "PartnerArchiving": {
      },
    • "@type": "SharedCommunicationChannelComponent",
    • "componentName": "New API SFTP Communication Channel",
    • "componentId": "fe51f351-2554-45ae-a4c0-31210de9f19c",
    • "folderName": "Samplefolder",
    • "folderId": "3230906",
    • "branchName": "main",
    • "branchId": "QjoyNzQ0NzA",
    • "deleted": true
    }
}

Modifies or updates a SharedCommunicationChannelComponent object

The sample request updates the component named Disk Comms Channel.

Authorizations:
basicAuth
path Parameters
id
required
string

Unique identifier componentId for the Shared Communication Channel Component in UUID format. System-generated when created.

Request Body schema:
optional
required
object (SharedCommunicationChannelComponent_PartnerArchiving)
required
object (SharedCommunicationChannelComponent_PartnerCommunication)
componentId
string
deleted
boolean
communicationType
string
folderName
string
branchId
string
folderId
integer <int64>
branchName
string
componentName
string
description
string

Responses

Response Schema:
required
object (SharedCommunicationChannelComponent_PartnerArchiving)
required
object (SharedCommunicationChannelComponent_PartnerCommunication)
componentId
string
deleted
boolean
communicationType
string
folderName
string
branchId
string
folderId
integer <int64>
branchName
string
componentName
string
description
string

Request samples

Content type
{
  • "@type": "SharedCommunicationChannelComponent",
  • "PartnerCommunication": {
    • "@type": "PartnerCommunication",
    • "DiskCommunicationOptions": {
      },
    • "AS2CommunicationOptions": {
      },
    • "GenericCommunicationOptions": [
      ]
    },
  • "PartnerArchiving": {
    • "@type": "PartnerArchiving",
    • "enableArchiving": false
    },
  • "componentName": "New API SFTP Communication Channel",
  • "componentId": "fe51f351-2554-45ae-a4c0-31210de9f19c",
  • "folderName": "Samplefolder",
  • "folderId": 3230906,
  • "branchId": "QjoyNzQ0NzA",
  • "branchName": "main",
  • "deleted": true
}

Response samples

Content type
{
  • "@type": "SharedCommunicationChannelComponent",
  • "componentName": "New API SFTP Communication Channel",
  • "componentId": "fe51f351-2554-45ae-a4c0-31210de9f19c",
  • "folderName": "Samplefolder",
  • "folderId": 3230906,
  • "branchName": "main",
  • "branchId": "QjoyNzQ0NzA",
  • "deleted": true,
  • "PartnerCommunication": {
    • "@type": "PartnerCommunication",
    • "GenericCommunicationOptions": [
      ]
    },
  • "PartnerArchiving": {
    • "@type": "PartnerArchiving",
    • "enableArchiving": false
    }
}

Deletes a SharedCommunicationChannelComponent object

If the Shared Communication Channel component is deleted successfully, the response is true.

Authorizations:
basicAuth
path Parameters
id
required
string

Unique identifier componentId for the Shared Communication Channel Component in UUID format. System-generated when created.

Responses

Response samples

Content type
{
  • "message": "Access denied due to insufficient permissions."
}

Retrieves multiple SharedCommunicationChannelComponent objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (SharedCommunicationChannelComponent)
errorMessage
string
id
string
index
integer <int32>
statusCode
integer <int32>

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for a SharedCommunicationChannelComponent object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

The sample request query returns the Shared Communication Channel components using the AS2 standard for the authenticating account.

Note:

  • The name field in a QUERY filter represents the object's componentName field.
  • The response includes a queryToken only when more than 100 results are available. Use the queryToken with the queryMore endpoint to retrieve additional results.
Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: name, communicationType

required
object
object

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (SharedCommunicationChannelComponent)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 3,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Retrieves additional results for a SharedCommunicationChannelComponent query.

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Query token from the previous query response used to retrieve the next page of results.

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (SharedCommunicationChannelComponent)

Request samples

Content type
text/plain
/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a....

Response samples

Content type
{
  • "numberOfResults": 3,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      },
    • {
      }
    ]
}