Waiting for engine...
Skip to main content

Trading Partner Processing Group object

The Trading Partner Processing Group object allows users to retrieve, query, create, update, and delete Processing Group components through the Boomi Enterprise Platform API.

Structure​

You configure a given processing group component to use either document-based routing, trading partner-based routing, or default (none) routing.

  • This object structure is for a processing group component configured to use document-based routing:

    <TradingPartnerProcessingGroup componentName="" componentId="" description="" folderName="" folderId="" deleted="" branchId="" branchName="">
       <TradingPartners>
          <TradingPartner id=""/>
          .
          .
       </TradingPartners>
       <DocumentRouting processId="">
          <StandardRoute standard="" processId="">
             <DocumentTypeRoute documentType="" processId=""/>
             .
             .
          </StandardRoute>
          .
          .
       </DocumentRouting>
    </TradingPartnerProcessingGroup>

  • This object structure is for a processing group component configured to use trading partner-based routing:

    <TradingPartnerProcessingGroup componentName="" componentId="" description="" folderName="" folderId="" deleted="" branchId="" branchName="">
       <TradingPartners>
          <TradingPartner id=""/>
          .
          .
       </TradingPartners>
       <PartnerRouting processId="">
          <PartnerRoute tradingPartnerId="" processId=""/>
             <StandardRoute standard="" processId="">
                <DocumentTypeRoute documentType="" processId=""/>
                .
                .
             </StandardRoute>
             .
             .
          </PartnerRoute>
          .
          .
       </PartnerRouting>
    </TradingPartnerProcessingGroup>

  • This object structure is for a processing group component configured to use default (or none) routing:

    <TradingPartnerProcessingGroup componentName="" componentId="" description="" folderName="" folderId="" deleted="" branchId="" branchName="">
       <TradingPartners>
          <TradingPartner id=""/>
          .
          .
       </TradingPartners>
       <DefaultRouting processId=""/>
    </TradingPartnerProcessingGroup>

The deleted attribute of the root element is unique to deleted processing group components. When present, its value is true.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedSupportedNot supportedSupported

Notes:

  • The ordinary GET operation returns a single Trading Partner Processing Group object based on the supplied ID. The bulk GET operation returns multiple Trading Partner Processing Group objects based on the supplied IDs, to a maximum of 100.

  • For general information about how to handle paged QUERY results, see the Query paging topic.

  • A GET operation specifying the ID of a deleted processing group component retrieves the component. In the component, the deleted field’s value is true.

    An UPDATE operation specifying the ID of a deleted processing group component restores the component to a non-deleted state, assuming the request is otherwise valid.

    A DELETE operation specifying the ID of a deleted processing group component returns a false response.

  • An UPDATE operation overwrites the entire processing group component.

SOAP implementation​

  • GET operation

    In this example, it retrieves the processing group component with the ID 3456789a-bcde-f012-34-56789abcdef012. This processing group uses document-based routing.

    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>TradingPartnerProcessingGroup</api:objectType>
             <api:objectId>3456789a-bcde-f012-34-56789abcdef012</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:TradingPartnerProcessingGroup" componentName="East Coast partners" componentId="3456789a-bcde-f012-34-56789abcdef012" folderName="Home:TPs:PGs:Domestic" folderId="11669">
                <bns:TradingPartners>
                   <bns:TradingPartner id="12345678-9abc-def0-1234-56789abcdef0"/>
                   <bns:TradingPartner id="0fedcba9-8765-4321-0fed-cba987654321"/>
                </bns:TradingPartners>
                <bns:DocumentRouting processId="543210fe-dcba-9876-5432-10fedcba9876">
                   <bns:StandardRoute standard="edifact" processId="456789ab-cdef-0123-4567-89abcdef0123">
                      <bns:DocumentTypeRoute documentType="AUTHOR" processId="56789abc-def0-1234-5678-9abcdef01234"/>
                   </bns:StandardRoute>
                   <bns:StandardRoute standard="x12" processId="3210fedc-ba98-7654-3210-fedcba987654">
                      <bns:DocumentTypeRoute documentType="107" processId="43210fed-cba9-8765-4321-0fedcba98765"/>
                   </bns:StandardRoute>
                </bns:DocumentRouting>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The QUERY operation returns all of the authenticating account’s processing group components. The operation does not return full component representations; it returns, for each result, the component’s name, ID, and folder ID.

    Following is a sample request and response. It requires an empty query filter in a request.

    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>TradingPartnerProcessingGroup</api:objectType>
             <api:queryConfig>
                 <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="102">
                <bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
                <bns:result xsi:type="bns:TradingPartnerProcessingGroup" folderId="11669" componentId="3456789a-bcde-f012-34-56789abcdef012" componentName="East Coast partners" branchId="QjoyMDI1OTk" branchName="branch-1"/>
                .
                .
                .
               <bns:result xsi:type="bns:TradingPartnerProcessingGroup" folderId="11670" componentId="210fedcb-a987-6543-210f-edcba9876543" componentName="European partners" branchId="QjoyMDI1OTk" branchName="branch-1"/>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    If you omit the folderName field, it requires the folderId field — and vice versa.

    The following example adds a processing group component that uses document-based routing. Note the omission of the folderID and componentID. The processing group component assigns IDs when you create the component.

    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="api:TradingPartnerProcessingGroup"  componentName="East Coast partners" folderName="Home:TPs:PGs:Domestic" branchId="QjoyMDI1OTk" branchName="branch-1">
                <api:TradingPartners>
                   <api:TradingPartner id="12345678-9abc-def0-1234-56789abcdef0"/>
                   <api:TradingPartner id="0fedcba9-8765-4321-0fed-cba987654321"/>
                </api:TradingPartners>
                <api:DocumentRouting processId="543210fe-dcba-9876-5432-10fedcba9876">
                   <api:StandardRoute standard="edifact" processId="456789ab-cdef-0123-4567-89abcdef0123">
                      <api:DocumentTypeRoute documentType="AUTHOR" processId="56789abc-def0-1234-5678-9abcdef01234"/>
                   </api:StandardRoute>
                   <api:StandardRoute standard="x12" processId="3210fedc-ba98-7654-3210-fedcba987654">
                      <api:DocumentTypeRoute documentType="107" processId="43210fed-cba9-8765-4321-0fedcba98765"/>
                   </api:StandardRoute>
                </api:DocumentRouting>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    The response contains the XML representation of the created processing group component, including the assigned folder ID and component ID.

  • UPDATE operation

    You must include the componentId field.

    The following example overwrites the processing group component shown in the previous GET and CREATE examples. As a result, it updates the component name.

    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="api:TradingPartnerProcessingGroup" componentName="Atlantic Seaboard partners" componentId="3456789a-bcde-f012-34-56789abcdef012" folderName="Home:TPs:PGs:Domestic" folderId="11669" branchId="QjoyMDI1OTk" branchName="branch-1">
                <api:TradingPartners>
                   <api:TradingPartner id="12345678-9abc-def0-1234-56789abcdef0"/>
                   <api:TradingPartner id="0fedcba9-8765-4321-0fed-cba987654321"/>
                </api:TradingPartners>
                <api:DocumentRouting processId=543210fe-dcba-9876-5432-10fedcba9876"">
                   <api:StandardRoute standard="edifact" processId="456789ab-cdef-0123-4567-89abcdef0123">
                      <api:DocumentTypeRoute documentType="AUTHOR" processId="56789abc-def0-1234-5678-9abcdef01234"/>
                   </api:StandardRoute>
                   <api:StandardRoute standard="x12" processId="3210fedc-ba98-7654-3210-fedcba987654">
                      <api:DocumentTypeRoute documentType="107" processId="43210fed-cba9-8765-4321-0fedcba98765"/>
                   </api:StandardRoute>
                </api:DocumentRouting>
             </object>
          </api:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    The response contains the XML representation of the updated processing group component.

  • DELETE operation

    This example is a request to delete the processing group component with the ID 3456789a-bcde-f012-34-56789abcdef012.

    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>
             <objectType>TradingPartnerProcessingGroup</objectType>
             <objectId>3456789a-bcde-f012-34-56789abcdef012</objectId>
          </api:delete>
       </soapenv:Body>
    </soapenv:Envelope>

    This response indicates successful deletion of the processing group component specified in the request:

    <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