Atom Connection Field Extension Summary object (Deprecated)
The Atom Connection Field Extension Summary objectis used to obtain the URL for OAuth 2.0 access token generation.
CAUTION:
The Atom Connection Field Extension Summary object is a deprecated API and should no longer be used. removed non-environment functionality from the , and changed all accounts to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the Environment Connection Field Extension Summary object. For more information about 's API object deprecation status, refer to the topic API deprecation and versioning policy.
You can programmatically set almost all extensible connection fields for connections used in processes attached to Runtimes through the Atom Extensions endpoint. The only current exception is the accessToken field in a connection that uses OAuth 2.0 authentication. You can obtain the URL for OAuth 2.0 access token generation using a QUERY operation on the Atom Connection Field Extension Summary object.
The URL returned by the operation is valid for up to 15 minutes from the time it is generated.
Note: In an XML response body, the returned URL requires decoding — for example, replacement of each instance of “&” with “&” — for use in the browser.
Structure
<AtomConnectionFieldExtensionSummary processId="" id="" connectionId="" extensionGroupId="" atomId="">
<field oauth2AuthorizationUrl="" componentOverride="" usesEncryption="" encryptedValueSet="" id=""/>
</AtomConnectionFieldExtensionSummary>
| Field | Type | Description |
|---|---|---|
| Filter | Filter | Filter |
| 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 - process - connection - multi-install integration pack (extensionGroupId), if applicable - Atom |
| connectionId | string | The ID of the connection. |
| extensionGroupId | string | If the process is in a multi-install integration pack, this is the ID of the multi-install integration pack, which is the same as the ID of the process. |
| atomId | string | The ID of the Runtime. |
| field | string | The extensions template for the OAuth 2.0 accessToken field is a superset of the standard connection field template. There is one additional field: oauth2AuthorizationUrl. The oauth2AuthorizationUrl value is the URL for manually generating the access token. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
| Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
Note: The API and Partner API connectors do not support operations on the Atom Connection Field Extension Summary object.
The following fields can be used as QUERY filters for the Atom Connection Field Extension Summary object:
| Field | Allowed value |
|---|---|
| Filter | Filter |
| atomId | Any string value. |
| extensionGroupId | Any string value. |
| connectionId | Any string value. |
| fieldId | Any string value. |
All filters are required except for extensionGroupId, which is required only for a multi-install integration pack. You can obtain valid values for each filter by using the QUERY operation on the Atom Extensions object.
Only the EQUALSoperator is allowed for the Atom Connection Field Extension Summary object filters. It returns one result only.
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 URL for manually generating the access token for the OAuth 2.0 connection whose ID is bcdef012-3456-789a-bcde-f0123456789a in a process attached to the Atom whose ID is 3456789a-bcde-f0123-4567-89abcdef012.
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>AtomConnectionFieldExtensionSummary</api:objectType>
<api:queryConfig>
<api:QueryFilter>
<api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
<api:nestedExpression operator="EQUALS" property="atomId" xsi:type="SimpleExpression">
<api:argument>3456789a-bcde-f0123-4567-89abcdef012</api:argument>
</api:nestedExpression>
<api:nestedExpression operator="EQUALS" property="connectionId" xsi:type="SimpleExpression">
<api:argument>bcdef012-3456-789a-bcde-f0123456789a</api:argument>
</api:nestedExpression>
<api:nestedExpression operator="EQUALS" property="fieldId" xsi:type="SimpleExpression">
<api:argument>oauthOptions/OAuth2Config/credentials/@accessToken</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:AtomConnectionFieldExtensionSummary"
atomId="3456789a-bcde-f0123-4567-89abcdef012" processId="789abcde-f012-3456-789a-bcdef0123456"
extensionGroupId="" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
connectionId="bcdef012-3456-789a-bcde-f0123456789a">
<bns:field oauth2AuthorizationUrl="https://accounts.google.com/o/oauth2/auth?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fcalendar+...&client_id=315699396546-pbq8qpjbnf80vb5gmgv3o210tq9v8bhi.apps.googleusercontent.com" componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="oauthOptions/OAuth2Config/credentials/@accessToken"/>
</bns:result>
</bns:results>
</bns:queryResponse>
</S:Body>
</S:Envelope>
