Environment Map Extension External Components object

Query the Environment Map Extension External Components object for a list of all available cross-reference components with a given environment map extension.

This object is helpful for process and integration pack developers that need to perform a cross-reference lookup function. After using this object to get a list of available cross-reference components, you can then use the Component API to retrieve a table's definition from the results list.

Structure

<QueryResult numberOfResults="">
   <result environmentMapExtensionId="" componentId="" componentVersion="" componentType="" componentName=""/>
</QueryResult>

Field	Type	Description
Filter	Filter	Filter
environmentMapExtensionId	string	The ID of the environment map extension. To find the environmentMapExtensionId, you can first query the Environment Map Extension object to retrieve a list of all available environment extensions for an account and copy the resultant environment map extension ID.
componentId	string	The ID of the component. The component ID is available by querying the Component Metadata object.
componentType	string	The type of component. Note: Currently, this object retrieves Cross Reference Table type-components ('crossref') only. The type of component. See the Component Types section later in this topic for a complete list of components that you can be retrieve using the Environment Map Extension External Components object.
componentName	string	The user-defined name given to the component.

Component types

Use the following table to determine the component types that are available for use within the Environment Map Extension External Component object. The following content does not define the connector subtype fields; you can retrieve subtype values using the Connector object.

Component type field	Component type description
certificate	X.509 Certificate
certificate.pgp	PGP Certificate
connector-action	Connector Operation
connector-settings	Connector Connection
crossref	Cross-Reference Table
documentcache	Document Cache
transform.map	Map
transform.function	Map Function
process	Process
processproperty	Process Property
profile.db	Database Profile
profile.edi	EDI Profile
profile.flatfile	Flat File Profile
profile.xml	XML Profile
profile.json	JSON Profile
queue	Queue
tradingpartner	Trading Partner
tpgroup	Processing Group
tporganization	Organization
tpcommoptions	Communication Channel
webservice	API Service
webservice.external	API Proxy
processroute	Process Route
customlibrary	Custom Library
flowservice	Flow Service
script.processing	Process Script
script.mapping	Map Script
xslt	XSLT Stylesheet

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not Supported.	Supported.	Not Supported.	Not Supported.	Not Supported.	Not Supported.

Using the QUERY operation

You can use the following fields as QUERY filters for the Environment Map Extension External Components object:

Field	Allowed values
environmentMapExtensionId	Any string value.

SOAP implementation

GET operation

• POST https://api.boomi.com/api/soap/v1/<accountID>

  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>{{username}}</wsse:Username>
             <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{{password}}</wsse:Password>
          </wsse:UsernameToken>
       </wsse:Security>
  </soapenv:Header>
   <soapenv:Body>
       <api:query>
          <api:objectType>EnvironmentMapExtensionExternalComponent</api:objectType>
          <api:queryConfig>
              <api:QueryFilter>
                <api:expression operator="and" xsi:type="api:GroupingExpression" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                     <api:nestedExpression operator="EQUALS" property="environmentMapExtensionId" xsi:type="api:SimpleExpression">
                         <argument>ZWNlYjg3Y2ItMW...</argument>
                  </api:nestedExpression>
                     <api:nestedExpression operator="EQUALS" property="componentId" xsi:type="api:SimpleExpression">
                         <argument>1234b56a-ea78-90f1-beec-2fe23456cb8e</argument>
                  </api:nestedExpression>
                </api:expression>
              </api:QueryFilter>
          </api:queryConfig>
       </api:query>
    </soapenv:Body>
  </soapenv:Envelope>
  

  Response:

  <?xml version='1.0' encoding='UTF-8'?>
  <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
     <S:Body>
         <bns:queryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/">
             <bns:results numberOfResults="1">
                 <bns:result xsi:type="bns:EnvironmentMapExtensionExternalComponent" environmentMapExtensionId="ZWNlYjg3Y2ItMW..." componentId="1234b56a-ea78-90f1-beec-2fe23456cb8e" componentVersion="1" componentType="crossref" componentName="component1"/>
             </bns:results>
         </bns:queryResponse>
     </S:Body>
  </S:Envelope>