Waiting for engine...
Skip to main content

Environment Extensions object

The Environment Extensions object represents the extension (process override) values for an environment.

The Environment Extensions object supports the ability to retrieve and update environment extension values. The functionality provided in the Environment Extensions object mimics the actions you can perform from the Runtime Management > Environment Management > Environment Extensions dialog in.

This topic covers the basics for using the Environment Extensions object. To learn more intricate details of using this object, such as working with encrypted fields, overriding extension values, working with multi-install integration pack extensions, and working with custom properties fields, refer to the topic Working with the Environment Extensions object.

Structure​

<EnvironmentExtensions id="" extensionGroupId="" environmentId="" partial="">
  <connections> {Optional}
	... 0 to n connection elements
	<connection name="" id="">
  	... 0 to n field elements
  	<field componentOverride="" usesEncryption="" encryptedValueSet="" id="" useDefault="">
 	      <customProperties>
        	     <properties key="" value="" encrypted="true"/>
        	     <properties key="" value="" encrypted="false"/>
   	    </customProperties>
        <CloudManagedSecretConfig usesRemoteSecretsManager="" secretsManagerType="" secretReference="">       
	</connection>
  </connections>
  <operations> {Optional}
    ... 0 to n operation elements
    <operation  name="" id=""> 
       ... 0 to n field elements
       <field componentOverride="" usesEncryption="" encryptedValueSet="" id="" value="" useDefault=""/>
    </operation>
  </operations>
  <tradingPartners> {Optional}
    ... 0 to n partnerOverride elements
    <tradingPartner name="" id="">
      ... 0 to n category elements
      <category name="" id="">
        ... 0 to n field elements
        <field componentOverride="" usesEncryption="" encryptedValueSet="" id="" useDefault=""/>
      </category>
    </tradingPartner>
  </tradingPartners>
  <sharedCommunications> {Optional}
    ... 0 to n sharedCommunication elements
    <sharedCommunication id="" name="" type="">
      ... 0 to n field elements
      <field componentOverride="" usesEncryption="" encryptedValueSet="" value="" id="" useDefault=""/>
    </sharedCommunication>
  </sharedCommunications>
  <crossReferences> {Optional}
    ... 0 to n crossReference elements
    <crossReference overrideValues="" id="">
        <CrossReferenceRows>
          ... 0 to n row elements, each with attributes named for cross-reference table columns
          <row/>
        </CrossReferenceRows>
    </crossReference>
  </crossReferences>
  <processProperties> {Optional}
    ... 0 to n ProcessProperty elements, each specifying a component-based process property
    <ProcessProperty>
       ... 0 to n ProcessPropertyValue elements, each specifying a component-based process property value; @encryptedValueSet is not meaningful
       <ProcessPropertyValue encryptedValueSet="" value="" key="" label="" useDefault=""/>
    </ProcessProperty>
  </processProperties>
  <properties> {Optional}
    ... 0 to n property elements, each specifying a dynamic process property
    <property name="" value=""/>
  </properties>
  <PGPCertificates> {Optional}
    ... 0 to n PGP Certificate elements
    <PGPCertificate id="" value="" useDefault=""/>
  </PGPCertificates>
</EnvironmentExtensions>
FieldTypeDescription
idstringThe ID of the object. This can be either of the following:
1. The value of environmentId.
2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId).
extensionGroupIdstringThe synthesized ID of the process belonging to a multi-install integration pack to which the extension values apply, if applicable. For more information, see the section in the Working with Environment Extensions subtopic about multi-install integration packs.
environmentIdstringThe ID of the environment.
componentOverridestringIndicates the extension value is a component GUID reference. Informational only. Changing this value in an UPDATE operation has no effect.
partialstringSupplied only in an UPDATE operation.
- If set to true, indicates that the request includes only a subset of environment extension values to update.
- If set to false, indicates that the request includes the full set of environment extension values to update. Values not included in the request are reset to use their default values.
useDefaultstringWhen set to true in either full or partial UPDATE requests, you can use useDefault to override extension values. Setting this attribute to true is the equivalent of turning on the Use Default option in the extensions UI. This setting designates that the provided extension value be overridden at runtime by the field value originally specified in the component. Setting the attribute to false indicates that useDefault is turned off.
Additionally, useDefault indicates whether a field is overridden in a GET response. When this attribute's value is true, it indicates that the extension value was overridden at runtime by the field value originally specified in the component.
For more information about how extension overrides work, see the Working with Environment Extensions subtopic.
encryptedValueSetstringFor encrypted fields such as passwords, indicates whether an override value is set without returning the actual value for security purposes.
If an encrypted field was overridden, encryptedValueSet is set to true. If an encrypted field was not overridden, encryptedValueSet is set to false.
valuestringThe override value of the environment extension. Encrypted values are not returned in a response.
usesEncryptionstringSpecifies whether the returned field is encrypted.
validatestring/numberSupplied only in an UPDATE operation at the process property label level for number or string data types.
- If set to true, or not used in the payload, and the input value is not an allowed value, an enhanced error message is returned with the process property label name and key details to correct the payload.
- If set to false, any value (integer/string) can be sent irrespective of the allowed values.

Environment Extension options​

The following table details the components that you can retrieve or update extension values for.

XML ElementIntegration ComponentNotes for considerationPartial update behavior
connectionsConnection componentAvailable fields vary by the individual connector.You can perform a partial update per individual field within a connection component.
operationsWeb Services Server operationThis property is only applicable to Web Services Server (WSS) listeners used in a multi-install integration pack. It allows you to override the WSS operation’s object name so you can have a unique URL per each installed instance of the integration pack.You can perform a partial update per individual field within an operation component.
tradingPartnerTrading Partner componentTrading partner component communication method fields, EDI document standard fields, or both. Available fields vary by individual communication method and standard.You can perform a partial update per individual field within a Trading Partner component.
sharedCommunicationCommunication Channel componentAvailable fields vary by the individual communication method.You can perform a partial update per individual field within a Shared Communication component.
crossReferencesCross Reference table componentAvailable columns vary by individual cross reference table configurations.You can perform a partial update per individual Cross Reference Table component, but you must provide the values for all rows in the component.
propertiesDynamic Process PropertyYou can use the dynamic process property’s name as the extension field ID.You can perform a partial update per individual Dynamic Process Property component.
PGPCertificatePGP certificate componentUse an existing PGP certificate’s component ID in your requests. It is not possible to use the Environment Extensions object to upload a new certificate directly.You can perform a partial update per individual PGP Certificate component.
processPropertyProcess Property componentAvailable fields vary based on the properties defined within a given process property component. The property’s key is used as the extension field ID.You can perform a partial update per individual property within a Process Property component.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Supported Supported Not Supported Supported Not Supported Not Supported 

Using the GET operation​

  • The ordinary GET operation retrieves the extension values for the environment having the specified ID (except for encrypted values). The bulk GET operation retrieves the extension values for the environments having the specified IDs (except for encrypted values) to a maximum of 100.

Using the QUERY operation​

FieldAllowed values
environmentIdAny string value. This filter is required.
extensionGroupIdAny string value. The intent is that this be the ID of a process in a multi-install integration pack.

Only the EQUALS operator is allowed for the Environment Extensions object filters. It returns one result only.

  • For general information about the structure of QUERY filters, see the Query filters topic.

Using the UPDATE operation​

  • The UPDATE operation updates the extension values for the environment having the specified ID.

    You must have the Runtime Management privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update environment extensions.

  • When updating extension values, you must perform either a partial update to update only those extension values requiring modification in the request, or a full update to update the full set of environment extensions in a single request. A partial update is typically recommended because it results in smaller payloads and more targeted updates. The procedures for using partial and full updates are described in the following section.

For GCP secret manager, the secret reference must be in the following format: projects/${project-id}/secrets/${secret-id}/versions/${version-id}. If the passed secret reference is valid, a success message is displayed. For an invalid secret reference, an error message “Invalid Secret Reference Value” is displayed.

note

The user must have ADC set up on the system where the Atom runtime is installed and running. For more information on GCP, refer to Set up ADC for a local development environment topic.

Performing a partial update

To perform a partial update, set partial to true and then provide only the extension fields and values that you wish to update in the request.

note

For cross reference tables, you can update a single cross reference table. However, you must provide all values for the entire table. You cannot update individual rows within a table.

  • For process property components, you can update a single process property component but you must provide the values for all properties in the component.

Example: Partial UPDATE request

The following is an example of a partial UPDATE request that aims to edit only the user name field for a connection component, though other extension values are set in the environment.

<bns:EnvironmentExtensions
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:bns="http://api.platform.boomi.com/" environmentId="46... partial="true">
	<bns:connections>
		<bns:connection id="c80bd1f5-5710-4b05-95a8-436ed746d7bd">
			<bns:field id="username" value="new_admin@mycompany.com" useDefault="false"/>
		</bns:connection
	<bns:connections>
</bns:EnvironmentExtensions>

Performing a full update

To perform a full update, set partial to false and then provide all the environment extension fields and values in the request, regardless if you wish to change only some values but not all.

caution

Values not included in the request are reset to use their default values. If you omit the partial attribute, the behavior defaults to a full update.

SOAP implementation​

  • GET operation

    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>EnvironmentExtensions</api:objectType>
             <api:objectId>456789ab-cdef-0123-4567-89abcdef0123</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:EnvironmentExtensions" id="456789ab-cdef-0123-4567-89abcdef0123" 
               extensionGroupId="" environmentId="456789ab-cdef-0123-4567-89abcdef0123">
                <bns:connections>
                   <bns:connection name="Local MySql" id="9ba5dfab-8781-4e6a-b908-0c7a7797d17a">
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="exhaustedAction" useDefault="true"/>
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="driverId" useDefault="true"/>
                   </bns:connection>
                   <bns:connection name="AndLinux - Datadump" id="e3aeadb7-ee49-4596-9e8f-22c04724c88d">
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="directory" value="mydirectory" useDefault="true"/>
                   </bns:connection>
                   <bns:connection name="New QuickBooks Connection" id="c9f59f09-e592-4dae-98b9-ddf1e3512f53">
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="appName" useDefault="true"/>
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="companyFileName" useDefault="true"/>
                      <bns:field componentOverride="false" usesEncryption="true" encryptedValueSet="false" id="toBeEncrypted" useDefault="true"/>
                           <bns:CloudManagedSecretConfig usesRemoteSecretsManager="true" secretsManagerType="GCP" secretReference="projects/634801617861/secrets/testQA/versions/6"/>                       
                   </bns:connection>                  
                </bns:connections>
                <bns:operations>
                    <bns:operation id="2b9a80d2-103d-4eba-8b61-b7401ab76cf8" name="WebService Operation">
                        <bns:field componentOverride="false"
                            encryptedValueSet="false" id="ObjectName"
                            usesEncryption="false" value="Updated" useDefault="true"/>
                    </bns:operation>
                </bns:operations>
                <bns:tradingPartners>
                   <bns:tradingPartner name="My Company" id="19b261d1-70d3-45a7-bd48-ae7c7df5ea7e">
                      <bns:category name="AS2" id="as2">
                         <bns:field componentOverride="true" usesEncryption="false" encryptedValueSet="false" 
                           value="85166fdd-946e-42c7-9264-2b6db77d2d35" id="as2identity-encryptAlias" useDefault="true"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           value="" id="as2identity-as2Id" useDefault="true"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="as2identity-mdnAlias" useDefault="true"/>
                      </bns:category>
                      <bns:category name="X12 Information" id="x12">
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-interchangeid" useDefault="true"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-securityinfo" useDefault="true"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-version" useDefault="true"/>
                      </bns:category>
                   </bns:tradingPartner>
                </bns:tradingPartners>
                <bns:sharedCommunications>
                   <bns:sharedCommunication id="54748ce7-fd92-434c-8db3-2717b44b2692" name="Best Enterprises MyCo" type="http">
                      <bns:field id="http-trustedcertalias" encryptedValueSet="false" 
                        usesEncryption="false" componentOverride="false" value="usercred" useDefault="true"/>
                      <bns:field id="http-password" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="passwd" useDefault="true"/>
                      <bns:field id="http-clientId" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="id123" useDefault="true"/>
                      <bns:field id="http-user" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="admin" useDefault="true"/>
                      <bns:field id="http-password" encryptedValueSet="false" usesEncryption="true" 
                       componentOverride="false" value="toBeEncrypted" useDefault="true"/>
                   </bns:sharedCommunication>
                </bns:sharedCommunications>
                <bns:crossReferences>
                   <bns:crossReference name="My Cross Reference" overrideValues="true" id="a6759305-9ed9-47d4-a76f-2ba227454d18">
                      <bns:CrossReferenceRows>
                         <bns:row ref3="3" ref2="2" ref1="1"/>
                         <bns:row ref3="1" ref2="34" ref1="12"/>
                         <bns:row ref3="2" ref2="1" ref1="3"/>
                      </bns:CrossReferenceRows>
                   </bns:crossReference>
                </bns:crossReferences>
                <bns:processProperties>
                   <bns:ProcessProperty name="Test Process Property" id="5399215e-3cc8-4006-bfe7-c3ae71df6c26">
                      <bns:ProcessPropertyValue encryptedValueSet="false" value="300" key="new-1355426770730" 
                        label="First" useDefault="true"/>
                      <bns:ProcessPropertyValue encryptedValueSet="false" value="400" key="new-1355426788553" 
                        label="Second" useDefault="true"/>
                   </bns:ProcessProperty>
                </bns:processProperties>
                <bns:properties>
                   <bns:property name="reference" value="myreference"/>
                   <bns:property name="baseURL" value="myurl"/>
                   <bns:property name="datetime" value="20110111"/>
                </bns:properties>
                <bns:PGPCertificates>
                   <bns:PGPCertificate id="6a9cb126-57ef-44e1-b30b-7770f4b803b6" value="Production Certificate"/>
                </bns:PGPCertificates>
             </bns:result>
          </bns:getResponse>
       </S:Body>
    </S:Envelope>

  • QUERY operation

    The following example query returns extension values for the specified environment and extensionGroupId (the ID of a process in a multi-install integration pack).

    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>EnvironmentExtensions</api:objectType>
             <api:queryConfig>
                 <api:QueryFilter>
                    <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                        <api:nestedExpression operator="EQUALS" property="environmentId"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>d806057a-9a6e-4b10-85df-c648dcc16abe</api:argument>
                        </api:nestedExpression>
                        <api:nestedExpression operator="EQUALS" property="extensionGroupId"
                          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                           <api:argument>2545e8cb-3162-4729-8dff-3a8ccfc48933</api:argument>
                        </api:nestedExpression>
                    </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:EnvironmentExtensions" id="d806057a-9a6e-4b10-85df-c648dcc16abe" 
                  extensionGroupId="2545e8cb-3162-4729-8dff-3a8ccfc48933" environmentId="d806057a-9a6e-4b10-85df-c648dcc16abe"> 
                   <bns:connections>
                      <bns:connection name="Local MySql" id="9ba5dfab-8781-4e6a-b908-0c7a7797d17a">
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="exhaustedAction" useDefault="true"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="driverId"/>
                      </bns:connection>
                      <bns:connection name="AndLinux - Datadump" id="e3aeadb7-ee49-4596-9e8f-22c04724c88d">
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="directory" value="mydirectory"/>
                      </bns:connection>
                      <bns:connection name="New QuickBooks Connection" id="c9f59f09-e592-4dae-98b9-ddf1e3512f53">
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="appName"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="companyFileName"/>
                         <bns:field componentOverride="false" usesEncryption="true" encryptedValueSet="false" id="toBeEncrypted"/>
                             <bns:CloudManagedSecretConfig usesRemoteSecretsManager="true" secretsManagerType="GCP" secretReference="projects/634801617861/secrets/testQA/versions/6"/>                       
                      </bns:connection>
                   </bns:connections>
                   <bns:operations>
                       <bns:operation id="2b9a80d2-103d-4eba-8b61-b7401ab76cf8" name="WebService Operation">
                           <bns:field componentOverride="false"
                               encryptedValueSet="false" id="ObjectName"
                               usesEncryption="false" value="Updated"/>
                       </bns:operation>
                   </bns:operations>
                   <bns:tradingPartners>
                      <bns:tradingPartner name="My Company" id="19b261d1-70d3-45a7-bd48-ae7c7df5ea7e">
                         <bns:category name="AS2" id="as2">
                            <bns:field componentOverride="true" usesEncryption="false" encryptedValueSet="false" 
                              value="85166fdd-946e-42c7-9264-2b6db77d2d35" id="as2identity-encryptAlias"/>
                            <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                              value="" id="as2identity-as2Id"/>
                            <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                              id="as2identity-mdnAlias"/>
                         </bns:category>
                         <bns:category name="X12 Information" id="x12">
                            <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                              id="x12envelope-interchangeid"/>
                            <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                              id="x12envelope-securityinfo"/>
                            <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                              id="x12envelope-version"/>
                         </bns:category>
                      </bns:tradingPartner>
                   </bns:tradingPartners>
                   <bns:sharedCommunications>
                      <bns:sharedCommunication id="54748ce7-fd92-434c-8db3-2717b44b2692" name="Best Enterprises MyCo" type="http">
                         <bns:field id="http-trustedcertalias" encryptedValueSet="false" 
                           usesEncryption="false" componentOverride="false" value="usercred"/>
                         <bns:field id="http-password" encryptedValueSet="false" usesEncryption="false" 
                           componentOverride="false" value="passwd"/>
                         <bns:field id="http-clientId" encryptedValueSet="false" usesEncryption="false" 
                           componentOverride="false" value="id123"/>
                         <bns:field id="http-user" encryptedValueSet="false" usesEncryption="false" 
                           componentOverride="false" value="admin"/>
                         <bns:field id="http-password" encryptedValueSet="false" usesEncryption="true" 
                          componentOverride="false" value="toBeEncrypted"/>
                      </bns:sharedCommunication>
                   </bns:sharedCommunications>
                   <bns:crossReferences>
                      <bns:crossReference name="My Cross Reference" overrideValues="true" id="a6759305-9ed9-47d4-a76f-2ba227454d18">
                         <bns:CrossReferenceRows>
                            <bns:row ref3="3" ref2="2" ref1="1"/>
                            <bns:row ref3="1" ref2="34" ref1="12"/>
                            <bns:row ref3="2" ref2="1" ref1="3"/>
                         </bns:CrossReferenceRows>
                      </bns:crossReference>
                   </bns:crossReferences>
                   <bns:processProperties>
                      <bns:ProcessProperty name="Test Process Property" id="5399215e-3cc8-4006-bfe7-c3ae71df6c26">
                         <bns:ProcessPropertyValue encryptedValueSet="false" value="300" key="new-1355426770730" 
                           label="First"/>
                         <bns:ProcessPropertyValue encryptedValueSet="false" value="400" key="new-1355426788553" 
                           label="Second"/>
                      </bns:ProcessProperty>
                   </bns:processProperties>
                   <bns:properties>
                      <bns:property name="reference" value="myreference"/>
                      <bns:property name="baseURL" value="myurl"/>
                      <bns:property name="datetime" value="20110111"/>
                   </bns:properties>
                   <bns:PGPCertificates>
                      <bns:PGPCertificate id="6a9cb126-57ef-44e1-b30b-7770f4b803b6" value="Production Certificate"/>
                   </bns:PGPCertificates>
                </bns:result>
             </bns:results>
         </bns:queryResponse>
       </S:Body>
    </S:Envelope>

  • UPDATE operation

    The following example updates the extension value of the dynamic process property named reference, from myreference to myNewreference, 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:update>
             <object xsi:type="api:EnvironmentExtensions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               id="456789ab-cdef-0123-4567-89abcdef0123" extensionGroupId="2545e8cb-3162-4729-8dff-3a8ccfc48933" environmentId="456789ab-cdef-0123-4567-89abcdef0123">
                <api:connections>
                   <api:connection name="Local MySql" id="9ba5dfab-8781-4e6a-b908-0c7a7797d17a" partial="false">
                      <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="exhaustedAction"/>
                      <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="driverId"/>
                   </api:connection>
                   <api:connection name="AndLinux - Datadump" id="e3aeadb7-ee49-4596-9e8f-22c04724c88d">
                      <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="directory" value="mydirectory"/>
                   </api:connection>
                   <api:connection name="New QuickBooks Connection" id="c9f59f09-e592-4dae-98b9-ddf1e3512f53">
                      <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="appName"/>
                      <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="companyFileName"/>
                      <api:field componentOverride="false" usesEncryption="true" encryptedValueSet="false" id="toBeEncrypted"/>
                           <api:CloudManagedSecretConfig usesRemoteSecretsManager="true" secretsManagerType="GCP" secretReference="projects/634801617861/secrets/testQA/versions/6"/>                      
                   </api:connection>
                </api:connections>
                <api:operations>
                    <api:operation id="2b9a80d2-103d-4eba-8b61-b7401ab76cf8" name="WebService Operation">
                        <api:field componentOverride="false"
                            encryptedValueSet="false" id="ObjectName"
                            usesEncryption="false" value="Updated"/>
                    </api:operation>
                </api:operations>
                <api:tradingPartners>
                   <api:tradingPartner name="My Company" id="19b261d1-70d3-45a7-bd48-ae7c7df5ea7e">
                      <api:category name="AS2" id="as2">
                         <api:field componentOverride="true" usesEncryption="false" encryptedValueSet="false" 
                           value="85166fdd-946e-42c7-9264-2b6db77d2d35" id="as2identity-encryptAlias"/>
                         <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           value="" id="as2identity-as2Id"/>
                         <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="as2identity-mdnAlias"/>
                      </api:category>
                      <api:category name="X12 Information" id="x12">
                         <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-interchangeid"/>
                         <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-securityinfo"/>
                         <api:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-version"/>
                      </api:category>
                   </api:tradingPartner>
                </api:tradingPartners>
                <api:sharedCommunications>
                   <api:sharedCommunication id="54748ce7-fd92-434c-8db3-2717b44b2692" name="Best Enterprises MyCo" type="http">
                      <api:field id="http-trustedcertalias" encryptedValueSet="false" 
                        usesEncryption="false" componentOverride="false" value="usercred"/>
                      <api:field id="http-password" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="passwd"/>
                      <api:field id="http-clientId" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="id123"/>
                      <api:field id="http-user" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="admin"/>
                      <api:field id="http-password" encryptedValueSet="false" usesEncryption="true" 
                        componentOverride="false" value="toBeEncrypted"/>
                   </api:sharedCommunication>
                </api:sharedCommunications>
                <api:crossReferences>
                   <api:crossReference name="My Cross Reference" overrideValues="true" id="a6759305-9ed9-47d4-a76f-2ba227454d18">
                      <api:CrossReferenceRows>
                         <api:row ref3="3" ref2="2" ref1="1"/>
                         <api:row ref3="1" ref2="34" ref1="12"/>
                         <api:row ref3="2" ref2="1" ref1="3"/>
                      </api:CrossReferenceRows>
                   </api:crossReference>
                </api:crossReferences>
                <api:processProperties>
                   <api:ProcessProperty name="Test Process Property" id="5399215e-3cc8-4006-bfe7-c3ae71df6c26">
                      <api:ProcessPropertyValue encryptedValueSet="false" value="300" key="new-1355426770730" 
                        label="First"/>
                      <api:ProcessPropertyValue encryptedValueSet="false" value="400" key="new-1355426788553" 
                        label="Second"/>
                   </api:ProcessProperty>
                </api:processProperties>
                <api:properties>
                   <api:property name="reference" value="myNewreference"/>
                   <api:property name="baseURL" value="myurl"/>
                   <api:property name="datetime" value="20110111"/>
                </api:properties>
                <api:PGPCertificates>
                   <api:PGPCertificate id="6a9cb126-57ef-44e1-b30b-7770f4b803b6" value="Production Certificate"/>
                </api:PGPCertificates>
             </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:EnvironmentExtensions" id="456789ab-cdef-0123-4567-89abcdef0123" 
               extensionGroupId="2545e8cb-3162-4729-8dff-3a8ccfc48933" environmentId="456789ab-cdef-0123-4567-89abcdef0123" partial="false">
                <bns:connections>
                   <bns:connection name="Local MySql" id="9ba5dfab-8781-4e6a-b908-0c7a7797d17a">
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="exhaustedAction"/>
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="driverId"/>
                   </bns:connection>
                   <bns:connection name="AndLinux - Datadump" id="e3aeadb7-ee49-4596-9e8f-22c04724c88d">
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="directory" value="mydirectory"/>
                   </bns:connection>
                   <bns:connection name="New QuickBooks Connection" id="c9f59f09-e592-4dae-98b9-ddf1e3512f53">
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="appName"/>
                      <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="companyFileName"/>
                      <bns:field componentOverride="false" usesEncryption="true" encryptedValueSet="false" id="toBeEncrypted"/>
                            <bns:CloudManagedSecretConfig usesRemoteSecretsManager="true" secretsManagerType="GCP" secretReference="projects/634801617861/secrets/testQA/versions/6"/>
                   </bns:connection>
                </bns:connections>
                <bns:operations>
                    <bns:operation id="2b9a80d2-103d-4eba-8b61-b7401ab76cf8" name="WebService Operation">
                        <bns:field componentOverride="false"
                            encryptedValueSet="false" id="ObjectName"
                            usesEncryption="false" value="Updated"/>
                    </bns:operation>
                </bns:operations>
                <bns:tradingPartners>
                   <bns:tradingPartner name="My Company" id="19b261d1-70d3-45a7-bd48-ae7c7df5ea7e">
                      <bns:category name="AS2" id="as2">
                         <bns:field componentOverride="true" usesEncryption="false" encryptedValueSet="false" 
                           value="85166fdd-946e-42c7-9264-2b6db77d2d35" id="as2identity-encryptAlias"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           value="" id="as2identity-as2Id"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="as2identity-mdnAlias"/>
                      </bns:category>
                      <bns:category name="X12 Information" id="x12">
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-interchangeid"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-securityinfo"/>
                         <bns:field componentOverride="false" usesEncryption="false" encryptedValueSet="false" 
                           id="x12envelope-version"/>
                      </bns:category>
                   </bns:tradingPartner>
                </bns:tradingPartners>
                <bns:sharedCommunications>
                   <bns:sharedCommunication id="54748ce7-fd92-434c-8db3-2717b44b2692" name="Best Enterprises MyCo" type="http">
                      <bns:field id="http-trustedcertalias" encryptedValueSet="false" 
                        usesEncryption="false" componentOverride="false" value="usercred"/>
                      <bns:field id="http-password" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="passwd"/>
                      <bns:field id="http-clientId" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="id123"/>
                      <bns:field id="http-user" encryptedValueSet="false" usesEncryption="false" 
                        componentOverride="false" value="admin"/>
                      <bns:field id="http-password" encryptedValueSet="false" usesEncryption="true" 
                        componentOverride="false" value="toBeEncrypted"/>
                   </bns:sharedCommunication>
                </bns:sharedCommunications>
                <bns:crossReferences>
                   <bns:crossReference name="My Cross Reference" overrideValues="true" id="a6759305-9ed9-47d4-a76f-2ba227454d18">
                      <bns:CrossReferenceRows>
                         <bns:row ref3="3" ref2="2" ref1="1"/>
                         <bns:row ref3="1" ref2="34" ref1="12"/>
                         <bns:row ref3="2" ref2="1" ref1="3"/>
                      </bns:CrossReferenceRows>
                   </bns:crossReference>
                </bns:crossReferences>
                <bns:processProperties>
                   <bns:ProcessProperty name="Test Process Property" id="5399215e-3cc8-4006-bfe7-c3ae71df6c26">
                      <bns:ProcessPropertyValue encryptedValueSet="false" value="300" key="new-1355426770730" 
                        label="First"/>
                      <bns:ProcessPropertyValue encryptedValueSet="false" value="400" key="new-1355426788553" 
                        label="Second"/>
                   </bns:ProcessProperty>
                </bns:processProperties>
                <bns:properties>
                   <bns:property name="reference" value="myNewreference"/>
                   <bns:property name="baseURL" value="myurl"/>
                   <bns:property name="datetime" value="20110111"/>
                </bns:properties>
                <bns:PGPCertificates>
                   <bns:PGPCertificate id="6a9cb126-57ef-44e1-b30b-7770f4b803b6" value="Production Certificate"/>
                </bns:PGPCertificates>
             </bns:result>
          </bns:updateResponse>
       </S:Body>
    </S:Envelope>
On this Page