Environment Map Extensions Summary object

The Environment Map Extensions Summary object refers to an extensible data map for an environment to which you attach a given process. An extensible map to which the object refers is represented by the Environment Map Extension object.

Data map extensions are overrides to field mappings or fields augmenting profile-based object definitions. Data map extensions represent the generalized mapping between two object definitions. For more information, refer to the Data map extensions topic.

Before you can request a GET or UPDATE operation on an Environment Map Extension object, you must perform a QUERY operation on the Environment Map Extensions Summary object to obtain the object IDs for extensible maps. The Environment Map Extensions Summary object also returns any connection fields required to reimport the source and destination profiles for customization.

note

You use the Environment Map Extension Summary object to configure extended maps only. Using the Environment Extensions object, you manage all other types of extensions, such as connections and process properties.

Structure

<EnvironmentMapExtensionsSummary name="" mapId="" processId="" id="" extensionGroupId="" environmentId="">
   <SourceFieldSet connectionId="">
      <BrowseField name=""/>
   </SourceFieldSet>
   <DestinationFieldSet connectionId="">
      <BrowseField name=""/>
   </DestinationFieldSet>
</EnvironmentMapExtensionsSummary>

Field	Type	Description
Filter	Filter	Filter
name	string	The name of the extensible map. This name includes the source object definition name and the destination object definition name, separated by a hyphen.
mapId	string	The ID of the extensible map.
processId	string	The ID of the process.
id	string	The ID of the object.This is a conceptual ID synthesized from the IDs of the: - Map - Process - Multi-install integration pack (extensionGroupId), if applicable - Environment After obtaining this value with a QUERY operation, you can retrieve or update the extensible map by specifying the ID in a GET or UPDATE operation on an Environment Map Extension object.
extensionGroupId	string	If applicable, the ID of the multi-install integration pack to which the extensible map applies.
environmentId	string	The ID of the environment.
DestinationFieldSet	string	Fields defining the credentials for connecting to the external service for the purpose of reimporting the destination profile to retrieve custom fields. You use these fields in the Environment Map Extension object's EXECUTE action.
SourceFieldSet	string	Fields defining the credentials for connecting to the external service for the purpose of reimporting the source profile to retrieve custom fields. You can use these fields in the EnvironmentMapExtension object's EXECUTE action.

Supported operations

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

You can use the following fields as QUERY filters for the Environment Map Extensions Summary object.

Field	Allowed values
extensionGroupId	Any string value. The intent is that this is the ID of a process in a multi-install integration pack.
environmentId	Any string value. This filter is required.

Only the EQUALS operator is allowed for the Environment Map Extensions Summary object filters.

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

SOAP implementation

The following example query returns the IDs of Environment Map Extension objects for the environment whose ID is 456789ab-cdef-0123-4567-89abcdef0123.

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>EnvironmentMapExtensionsSummary</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
                <api:expression xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" operator="EQUALS" property="environmentId" xsi:type="api:SimpleExpression">
                   <api:argument>456789ab-cdef-0123-4567-89abcdef0123</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="1">
            <bns:result xsi:type="bns:EnvironmentMapExtensionsSummary" 
              name="Account - Customer" mapId="01234567890123456789012345" processId="789abcde-f012-3456-789a-bcdef0123456" 
              id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg" 
              extensionGroupId="" environmentId="456789ab-cdef-0123-4567-89abcdef0123"> 
              <bns:SourceFieldSet connectionId="c04f56dd-0eec-4311-ab7b-1737a1309ae8">
                 <bns:BrowseField name="password"/>
              </bns:SourceFieldSet>
              <bns:DestinationFieldSet connectionId="l23e56dd-0ffd-4222-an8b-1737a1309ae8">
                 <bns:BrowseField name="password"/>
              </bns:DestinationFieldSet>
            </bns:result>
         </bns:results>
     </bns:queryResponse>
   </S:Body>
</S:Envelope>