Environment Map Extension User Defined Function Summary object

Use the Environment Map Extension User Defined Function Summary object to query for a list of all available user-defined functions associated with a given environment map extension.

You can use this object in combination with other Environment Map Extension objects. For example, you can query this object to retrieve a list of user-defined functions and then employ the Environment Map Extension User Defined object to modify the properties of a function returned in the list of results.

Structure

<bns:QueryResult>
   <bns:result xsi:type="" environmentMapExtensionId="" componentId="" name="" createdDate="" createdBy="" modifiedDate="" modifiedBy="" deleted=""/>
</bns:QueryResult>

Field	Type	Description
Filter	Filter	Filter
environmentMapExtensionId	string	The system-generated ID of a environment map extension within a specific environment.
componentId	string	The ID of the component.
name	string	The user-defined name given to the component.
createdDate	string — yyyy-MM-dd (for example, 2020-01-31)	The creation date of the component.
createdBy	string — (for example, user@boomi.com)	The email address of the user who created the component.
modifiedDate	string — yyyy-MM-dd (for example, 2020-01-31)	The modification date of the component.
modifiedBy	string — (for example, user@boomi.com)	The email address of the user who modified the component.
deleted	string	Indicates the deletion of a component. A true value indicates a deleted status, whereas a false value indicates an active status.

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 us the following fields as QUERY filters for the Account object:

Field	Allowed values
Filter	Filter
environmentMapExtensionID	Required. Any string value.
deleted	true or false.
guid	Any string value.
name	Any string value.
createdDate	Date using the format: yyyy-MM-dd'T'HH:mm:ss'Z', for example, 2011-01-31T15:32:00Z.
createdBy	User in an email address format (for example, user@boomi.com).
modifiedDate	Date using the format: yyyy-MM-dd'T'HH:mm:ss'Z' (for example, 2011-01-31T15:32:00Z).
modifiedBy	User in an email address format (for example, user@boomi.com).

SOAP implementation

GET operation

Make a request to:

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

• GB: https://api.platform.gb.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>user@boomi.com</wsse:Username>
           <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password123</wsse:Password>
        </wsse:UsernameToken>
     </wsse:Security>
</soapenv:Header>
 <soapenv:Body>
     <api:query>
        <api:objectType>EnvironmentMapExtensionUserDefinedFunctionSummary</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="LIKE" property="name" xsi:type="api:SimpleExpression">
                       <argument>%UDF%</argument>
                </api:nestedExpression>
               <api:nestedExpression operator="EQUALS" property="deleted" xsi:type="api:SimpleExpression">
                       <argument>false</argument>
                </api:nestedExpression>
               <api:nestedExpression operator="IS_NOT_NULL" property="componentId" xsi:type="api:SimpleExpression">
                </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:EnvironmentMapExtensionUserDefinedFunctionSummary" environmentMapExtensionId="ZWNlYjg3Y2ItMW..." componentId="1234b56a-ea78-90f1-beec-2fe23456cb8e" name="My User Defined Functions" createdDate="2022-01-21T02:40:01Z" createdBy="user@boomi.com" modifiedDate="2022-01-21T02:40:01Z" modifiedBy="user@boomi.com" deleted="false"/>
           </bns:results>
       </bns:queryResponse>
   </S:Body>
</S:Envelope>