Waiting for engine...
Skip to main content

Organization Component object

The Organization Component object represents an Organization component in the service. You can reuse organization components across multiple Trading Partners, API Services, and API Proxies.

Structure​

<OrganizationComponent componentName="" componentId="" description="" folderName="" folderId="" deleted="" branchId="" branchName="">
   <OrganizationContactInfo>
      <contactName/>
      <address1/>
      <address2/>
      <city/>
      <state/>
      <postalcode>
      <country/>
      <email/>
      <phone/>
      <contactUrl/>
      <fax/>
   </OrgniazationContactInfo>
</OrganizationComponent>

FieldTypeDescription
FilterFilterFilter
componentNamestringA user-defined name for the component.
componentIdstringA unique ID assigned by the system to the component.
descriptionstringDescription of the component.Note: Although this field is in the object, operations do not support the field. For example, the system ignores the field if it is present in a QUERY, CREATE, or UPDATE request.
folderNamestringThe folder location of the component within Component Explorer.
folderIdlongThe ID of the folder in which the component currently resides.
deletedBooleanIndicates if the component is deleted. A value of true indicates a deleted status, whereas false indicates an active status.
branchIdstringThe ID of the current working branch.
branchNamestringThe name of the current working branch.
contactNamestringName of the contact for the organization.
address1stringFirst line of the street address of the organization.
address2stringSecond line of the street address of the organization.
citystringLocation of the city for the organization.
statestringLocation of the state or province for the organization.
postalcodestringPostal code, such as a Zip Code.
countrystringLocation of the country of for the organization.
emailstringEmail address for the organization.
phonestringPhone number for the organization.
contactUrlstringContact URL for the organization.
faxstringFax number for the organization.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
SupportedSupportedSupportedSupportedNot SupportedSupported

Using the GET operation​

  • The ordinary GET operation returns a single Organization Component object based on the supplied ID.

  • The bulk GET operation retrieves the properties of the Organization Component objects having the specified IDs, to a maximum of 100.

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

Using the QUERY operation​

  • You can use the following fields as QUERY filters for the Organization Component object.

    FieldAllowed values
    FilterFilter
    nameAny string value.
    Note: The name field in a QUERY filter represents the object’s componentName field.
    contactNameAny string value.
    emailAny string value.
    phoneAny string value.

  • Only the LIKE operator is allowed with a name filter. Likewise, only the EQUALS operator is permitted with a contactName, email, or phone filter.

  • If the QUERY request includes multiple filters, you can connect the filters with a logical AND operator — the query does not support the logical OR operator .

  • The QUERY results omit the folderName field.

For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

Using the CREATE operation​

  • The CREATE operation creates an Organization Component object with the specified component name.

  • The request body requires the componentName field. If you omit the folderName field, it requires the folderId field — and vice versa. If you omit the componentID field, it assigns the value when you create the component. If you omit the folderID field, it assigns the value when you create the component.

Using the UPDATE operation​

  • The UPDATE operation overwrites the Organization Component object with the specified component ID.

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

Using the DELETE operation​

  • The DELETE operation deletes the Organization Component object with the specified component ID.

  • A DELETE operation specifying the ID of a deleted Trading Partner component returns a false response.

SOAP implementation​

  • GET operation

    The following example shows the response to a GET request specifying the Organization component with ID 89abcdef-0123-4567-89ab-cdef01234567.

    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>OrganizationComponent</api:objectType>
             <api:objectId>89abcdef-0123-4567-89ab-cdef01234567</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:OrganizationComponent" componentName="Best Wholesaling" componentId="89abcdef-0123-4567-89ab-cdef01234567" folderName="Commercial" folderId="11356" branchId="QjoyMDI1OTk" branchName="branch-1">
                <bns:OrganizationContactInfo>
                   <bns:contactName>Tom Miller</bns:contactName>
                   <bns:address1>127 Comstock Ave.</bns:address1>
                   <bns:address2></bns:address2>
                   <bns:city>Philadelphia</bns:city>
                   <bns:state>PA</bns:state>
                   <bns:postalcode>19100</bns:postalcode>
                   <bns:country>US</bns:country>
                   <bns:email>tom@bestwholesaling.biz</bns:email>
                   <bns:phone>311 555-3579</bns:phone>
                   <bns:contactUrl>https://www.bestwholesaling.biz</bns:contactUrl>
                   <bns:fax>311 555-9753</bns:fax>
                </bns:OrganizationContactInfo>/>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns the Organization components in which the contactName field value is Tom Miller and the phone field value is 311 555-3579.

    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>OrganizationComponent</api:objectType>
             <api:queryConfig>
                 <api:QueryFilter>
                    <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression" >
                       <api:nestedExpression operator="EQUALS" property="contactName" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
                          <api:argument>Tom Miller</api:argument>
                       </api:nestedExpression>
                       <api:nestedExpression operator="EQUALS" property="phone" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimpleExpression">
                          <api:argument>311 555-3579</api:argument>
                       </api:nestedExpression>
                    </api:expression>
                 </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="1">
                <bns:result xsi:type="bns:OrganizationComponent" componentName="Best Wholesaling" componentId="89abcdef-0123-4567-89ab-cdef01234567" folderName="Commercial" folderId="11356" branchId="QjoyMDI1OTk" branchName="branch-1">
                   <bns:OrganizationContactInfo>
                      <bns:contactName>Tom Miller</bns:contactName>
                      <bns:address1>127 Comstock Ave.</bns:address1>
                      <bns:address2></bns:address2>
                      <bns:city>Philadelphia</bns:city>
                      <bns:state>PA</bns:state>
                      <bns:postalcode>19100</bns:postalcode>
                      <bns:country>US</bns:country>
                      <bns:email>tom@bestwholesaling.biz</bns:email>
                      <bns:phone>311 555-3579</bns:phone>
                      <bns:contactUrl>https://www.bestwholesaling.biz</bns:contactUrl>
                      <bns:fax>311 555-9753</bns:fax>
                   </bns:OrganizationContactInfo>/>
                </bns:result>
             </bns:results>
          </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • CREATE operation

    The following example shows a CREATE operation resulting in the creation of an Organization component named Best Wholesaling with the ID 89abcdef-0123-4567-89ab-cdef01234567.

    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:create>
             <object xsi:type="api:OrganizationComponent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    						 componentName="Best Wholesaling" folderName="Commercial" branchId="QjoyMDI1OTk" branchName="branch-1">
                <api:OrganizationContactInfo>
                   <api:contactName>Tom Miller</api:contactName>
                   <api:address1>127 Comstock Ave.</api:address1>
                   <api:address2></api:address2>
                   <api:city>Philadelphia</api:city>
                   <api:state>PA</api:state>
                   <api:postalcode>19100</api:postalcode>
                   <api:country>US</api:country>
                   <api:email>tom@bestwholesaling.biz</api:email>
                   <api:phone>311 555-3579</api:phone>
                   <api:contactUrl>https://www.bestwholesaling.biz</api:contactUrl>
                   <api:fax>311 555-9753</api:fax>
                </api:OrganizationContactInfo>/>
             </object>
          </api:create>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:OrganizationComponent" componentName="Best Wholesaling" componentId="89abcdef-0123-4567-89ab-cdef01234567" folderName="Commercial" folderId="11356" branchId="QjoyMDI1OTk" branchName="branch-1">
                <bns:OrganizationContactInfo>
                   <bns:contactName>Tom Miller</bns:contactName>
                   <bns:address1>127 Comstock Ave.</bns:address1>
                   <bns:address2></bns:address2>
                   <bns:city>Philadelphia</bns:city>
                   <bns:state>PA</bns:state>
                   <bns:postalcode>19100</bns:postalcode>
                   <bns:country>US</bns:country>
                   <bns:email>tom@bestwholesaling.biz</bns:email>
                   <bns:phone>311 555-3579</bns:phone>
                   <bns:contactUrl>https://www.bestwholesaling.biz</bns:contactUrl>
                   <bns:fax>311 555-9753</bns:fax>
                </bns:OrganizationContactInfo>/>
             </bns:result>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • UPDATE operation

    This example updates the phone field value in the Organization component with ID 89abcdef-0123-4567-89ab-cdef01234567 from 311 555-3579, as shown in the sample CREATE operation, to 311 555-3597.

    .

    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:update>
             <object xsi:type="api:OrganizationComponent" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    						 componentName="Best Wholesaling" componentId="89abcdef-0123-4567-89ab-cdef01234567" folderName="Commercial" folderId="11356" branchId="QjoyMDI1OTk" branchName="branch-1">
                <api:OrganizationContactInfo>
                   <api:contactName>Tom Miller</api:contactName>
                   <api:address1>127 Comstock Ave.</api:address1>
                   <api:address2></api:address2>
                   <api:city>Philadelphia</api:city>
                   <api:state>PA</api:state>
                   <api:postalcode>19100</api:postalcode>
                   <api:country>US</api:country>
                   <api:email>tom@bestwholesaling.biz</api:email>
                   <api:phone>311 555-3597</api:phone>
                   <api:contactUrl>https://www.bestwholesaling.biz</api:contactUrl>
                   <api:fax>311 555-9753</api:fax>
                </api:OrganizationContactInfo>/>
             </object>
          </api:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:OrganizationComponent" componentName="Best Wholesaling" componentId="89abcdef-0123-4567-89ab-cdef01234567" folderName="Commercial" folderId="11356" branchId="QjoyMDI1OTk" branchName="branch-1">
                <bns:OrganizationContactInfo>
                   <bns:contactName>Tom Miller</bns:contactName>
                   <bns:address1>127 Comstock Ave.</bns:address1>
                   <bns:address2></bns:address2>
                   <bns:city>Philadelphia</bns:city>
                   <bns:state>PA</bns:state>
                   <bns:postalcode>19100</bns:postalcode>
                   <bns:country>US</bns:country>
                   <bns:email>tom@bestwholesaling.biz</bns:email>
                   <bns:phone>311 555-3597</bns:phone>
                   <bns:contactUrl>https://www.bestwholesaling.biz</bns:contactUrl>
                   <bns:fax>311 555-9753</bns:fax>
                </bns:OrganizationContactInfo>/>
             </bns:result>
          </bns:updateResponse>
       </S:Body>
    </S:Envelope>

  • DELETE operation

    The following example shows a DELETE operation resulting in the removal of an Organization component with the ID 89abcdef-0123-4567-89ab-cdef01234567.

    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>OrganizationComponent</objectType>
             <objectId>89abcdef-0123-4567-89ab-cdef01234567</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