Process Environment Attachment object (Legacy deployment, Deprecated)
The Process Environment Attachment object enables the attachment or detachment of a process to or from a particular environment.
The Process Environment Attachment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Deployed Package object instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about 's API object deprecation status, refer to the topic API deprecation and versioning policy.
Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new deployment workflow and how to upgrade Legacy accounts to use the new deployment workflow. In the meantime, do not use the replacement API without first converting your Legacy account.
You can use the Process Environment Attachment object only for processes. For other components, use the Component Environment Attachment object.
Structure
<ProcessEnvironmentAttachment environmentId="" processId="" id=""/>
| Field | Type | Description |
|---|---|---|
| environmentId | string | The ID of the environment. |
| processId | string | The ID of the process. |
| id | string | The object’s conceptual ID, which is synthesized from the environment and process IDs. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Not Supported | Supported | Supported | Not Supported | Not Supported | Supported |
Notes:
-
The following fields can be used as QUERY filters for the Process Environment Attachment object:
Field Allowed values environmentId Any string value. processId Any string value. The operators allowed for the Process Environment Attachment object filters are:
-
BETWEEN
-
EQUALS
-
IS_NULL
-
IS_NOT_NULL
-
GREATER_THAN
-
GREATER_THAN_OR_EQUAL
-
LESS_THAN
-
LESS_THAN_OR_EQUAL
-
LIKE
-
NOT_EQUALS
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.
-
-
The CREATE operation attaches a process having the specified ID to the environment having the specified ID.
You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot attach processes.
-
The DELETE operation detaches a process from an environment where the attachment is specified by the conceptual Process Environment Attachment object ID. This ID is returned by the CREATE operation that originated the attachment and can also be obtained from a QUERY operation.
You must have the Runtime Management privilege to perform the DELETE operation. If you have the Runtime Management Read Access privilege, you cannot delete process attachments.
SOAP implementation
-
QUERY operation
The following example query returns the processes attached to 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>ProcessEnvironmentAttachment</api:objectType>
<api:queryConfig>
<api:QueryFilter>
<api:expression operator="EQUALS" property="environmentId"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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="2">
<bns:result xsi:type="bns:ProcessEnvironmentAttachment" environmentId="456789ab-cdef-0123-4567-89abcdef0123"
processId="56789abc-def0-1234-5678-9abcdef01234"
componentType="process"
id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"/>
<bns:result xsi:type="bns:ProcessEnvironmentAttachment" environmentId="456789ab-cdef-0123-4567-89abcdef0123"
processId="6789abcd-ef01-2345-6789-abcdef012345"
id="b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA"/>
</bns:results>
</bns:queryResponse>
</S:Body>
</S:Envelope> -
CREATE 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:create>
<object xsi:type="api:ProcessEnvironmentAttachment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
environmentId="456789ab-cdef-0123-4567-89abcdef0123" processId="56789abc-def0-1234-5678-9abcdef01234">
</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:ProcessEnvironmentAttachment" environmentId="456789ab-cdef-0123-4567-89abcdef0123"
processId="56789abc-def0-1234-5678-9abcdef01234"
componentType="process"
id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"/>
</bns:createResponse>
</S:Body>
</S:Envelope> -
DELETE 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:delete>
<objectType>ProcessEnvironmentAttachment</objectType>
<objectId>Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg</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">
<bns:successful>true</bns:successful>
</bns:deleteResponse>
</S:Body>
</S:Envelope>
