Application Development
Boomi
API integration
Ship Application Development features without building the integration. Full Boomi API access via Proxy, normalized data through Unified APIs, and 370+ MCP-ready tools for AI agents — all extensible to your exact use case.
Talk to usUse Cases
Why integrate with Boomi
Common scenarios for SaaS companies building Boomi integrations for their customers.
Automate access reviews for compliance audits
Compliance and GRC platforms can pull Boomi's user directory and role assignments to auto-generate access review reports for SOC 2, SOX, or ISO 27001 audits — eliminating manual spreadsheet exports from the Boomi admin console.
Detect over-privileged users in SaaS security posture management
SSPM providers can continuously scan Boomi accounts to flag users with admin or production-deployment roles who shouldn't have them, helping enterprises enforce least-privilege access on their central integration hub.
Power zero-touch offboarding for IT lifecycle management
ITSM and HR platforms can read Boomi's user and role directory to verify that terminated employees have been deprovisioned, ensuring revoked access to the enterprise's most sensitive integration infrastructure.
Sync Boomi roles with centralized identity providers
Identity governance platforms can fetch all Boomi roles and map them against groups in Okta or Microsoft Entra ID, giving security teams a unified view of role assignments across every system in the stack.
Surface integration platform access in IT asset inventories
IT asset management tools can enumerate all Boomi users and their roles to maintain a real-time inventory of who has access to the enterprise iPaaS, a critical component of any hybrid-cloud environment.
What You Can Build
Ship these features with Truto + Boomi
Concrete product features your team can ship faster by leveraging Truto’s Boomi integration instead of building from scratch.
Boomi user directory sync dashboard
Display a live roster of all Boomi users and their assigned roles inside your product, updated on a scheduled cadence using list_all_boomi_users and list_all_boomi_roles.
Privileged role alerting engine
Automatically flag users who hold high-privilege Boomi roles (e.g., Admin or Deploy to Production) by resolving each role via get_single_boomi_role_by_id and comparing against your customers' security policies.
Automated access review report generator
Generate auditor-ready reports that map every Boomi user to their exact role definitions, satisfying access certification requirements without manual data collection.
Cross-platform role mapping matrix
Combine Boomi role data from Truto's Unified User Directory API with role data from other connected platforms to build a single, normalized view of entitlements across the enterprise.
Orphaned account detector
Cross-reference the Boomi user list against your customers' HR or IdP source of truth to surface accounts that belong to former employees or contractors who still have active Boomi access.
Role drift monitoring
Periodically snapshot Boomi role assignments and compare them over time to detect unauthorized changes — such as a user being quietly elevated to an admin role outside of a change management process.
SuperAI
Boomi AI agent tools
Comprehensive AI agent toolset with fine-grained control. Integrates with MCP clients like Cursor and Claude, or frameworks like LangChain.
list_all_boomi_users
Use this endpoint to list all the users available in Boomi.
list_all_boomi_roles
Use this endpoint to list all the roles available in Boomi.
get_single_boomi_role_by_id
Use this endpoint to retrieve details of a specific role in a Boomi account. Always requires the id to fetch.
create_a_boomi_role
Creates a Role object. Creates a Role object based on the supplied values. Returns: name, parentId, Privileges, id, ReasonForAction, accountId, Description.
update_a_boomi_role_by_id
Modifies or updates a Role object. Updates a role as identified by its role ID. Returns: name, parentId, Privileges, id, ReasonForAction, accountId, Description. Required: id.
delete_a_boomi_role_by_id
Deletes a Role object. Deletes a Role object based on the supplied role ID. Required: id.
boomi_roles_bulk_get
Retrieves multiple Role objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_account
Retrieve the Boomi account record for the connected account_id (GET Account/{accountId}). Returns account details such as accountId, name, status, dateCreated, expirationDate, supportLevel, widgetAccount and licensing. Takes no parameters; the account comes from the connection.
list_all_boomi_paginated_roles
Fetch the next page of Boomi roles after a Role query (POST Role/queryMore). Pass the queryToken returned by the previous roles list or queryMore response. Returns role records (id, name, description, accountId, parentId, privileges) and a new queryToken while more pages remain. Mostly used internally to page through roles.
list_all_boomi_paginated_users
Fetch the next page of Boomi user role assignments after an AccountUserRole query (POST AccountUserRole/queryMore, plain-text body). Pass the queryToken returned by the previous users list or queryMore response. Returns assignments (id, accountId, userId, roleId, firstName, lastName, notifyUser) and a new queryToken while more pages remain. Mostly used internally to page through users.
list_all_boomi_as_2_connector_records
Queries for an AS2ConnectorRecord object(s). - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the Tradacoms Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: as2ToId, atomId, filename, operationName, documentIndex, customFields, id, account, connectorName, executionId, as2FromId, ackStatus, connectorType, dateProcessed, messageId, successful, errorMessage, mimetype, mdnMessage, actionType, … Required: QueryFilter.
boomi_as_2_connector_records_query_more
Retrieves additional results for an AS2ConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_account_by_id
Retrieves an instance of an Account object. Retrieves a single Account object using the supplied account ID. This GET operation returns details only for the parent account and does not include any accounts created by the parent account. Returns: suggestionsEnabled, name, molecule, supportLevel, status, overDeployed, expirationDate, widgetAccount, dateCreated, accountId, licensing, supportAccess. Required: id.
boomi_accounts_bulk_get
Retrieves multiple Account objects by identifier. The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_accounts
Queries for an Account object(s). The Account Query API returns accounts that were created by the parent account identified in the request URL. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: suggestionsEnabled, name, molecule, supportLevel, status, overDeployed, expirationDate, widgetAccount, dateCreated, accountId, licensing, supportAccess. Required: QueryFilter.
boomi_accounts_query_more
Retrieves additional results for an Account query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
update_a_boomi_account_cloud_attachment_property_by_id
Modifies or updates an AccountCloudAttachmentProperties object. Modifies one or more Account Cloud attachment properties. - To update property values, include all property names that you want to modify including their new values in the request body you do not need to provide the full list of properties in the request. This action is equivalent to editing property values on the Attachment quotas tab (Manage > Cloud Management) in the user interface. - To ensure a successful request, you must provide valid property names and their accepted values in the request body. Returns: numberofAtomWorkers, maxRetentionExecutionHistoryPersistence, workerMaxGeneralExecutionTime, enableAtomWorkerWarmup, maxConnectorTrackDocs, queueMsgThrottleRate, as2Workload, workerMaxRunningExecutions, queueUseFilePersistence, workerMaxExecutionTime, atomOutputOverflowSize, queueMaxDocSize, enableObservability, accountDiskUsage, workerQueuedExecutionTimeout, queueCommitBatchLimit, minNumberofAtomWorkers, containerId, queueIncomingMessageRateLimit, workerMaxQueuedExecutions, … Required: id.
boomi_account_cloud_attachment_properties_async_request
Retrieves an AccountCloudAttachmentProperties object by identifier. Use the GET operation to return and view a full list of Account Cloud attachment properties and their current values. This action is equivalent to viewing the Attachment quotas tab (Manage > Cloud Management) in the user interface. >**Note:** The Cloud and attachments to which you are calling must be online. Cloud owners and users that own the Cloud attachments can use this operation. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
boomi_account_cloud_attachment_properties_async_response
Retrieves an AccountCloudAttachmentProperties object by token. Send a second GET request with the token returned in the first GET request. The object returns a list of existing property names and values for the given account and Cloud. >**Note:** The Cloud and attachments to which you are calling must be online. Cloud owners and users that own the Cloud attachments can use this operation. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
create_a_boomi_account_cloud_attachment_quota
Creates an AccountCloudAttachmentQuota object. - Use the CREATE operation to create a new Cloud quota and determine the maximum number of Runtime attachments that you can create on the account. - You can use the CREATE or UPDATE operations interchangeably to edit a Cloud quota value. Both operations can act as an update after creating the quota. - CREATE and UPDATE use the same REST endpoint, as seen in the next section of sample code REST calls. Returns: cloudId, id, accountId, maxAtomAttachment.
get_single_boomi_account_cloud_attachment_quota_by_id
Retrieves an instance of an AccountCloudAttachmentQuota object. Retrieves the Cloud quota value currently existing for a Cloud ID on a specific account. The GET operation requires an additional ID (id), and differs from the `cloudId` and `accountId`. Returns: cloudId, id, accountId, maxAtomAttachment. Required: id.
update_a_boomi_account_cloud_attachment_quota_by_id
Modifies or updates an AccountCloudAttachmentQuota object. Edit the number of Runtime attachments that you can create on the given account. Specify the IDs of both the account and the Runtime cloud that you want to update. You cannot set the Cloud quota less than the number of attachments that currently exist on the account, unless you are setting the value to -1 for unlimited. Attempting to do so returns an error. Returns: cloudId, id, accountId, maxAtomAttachment. Required: id.
delete_a_boomi_account_cloud_attachment_quota_by_id
Deletes an AccountCloudAttachmentQuota object. Deletes a Cloud quota for a given account. Required: id.
boomi_account_cloud_attachment_quotas_bulk_get
Retrieves multiple AccountCloudAttachmentQuota objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
create_a_boomi_account_group
Creates an AccountGroup object. Creates an account group based on the supplied name. Returns: name, Resources, id, autoSubscribeAlertLevel, accountId, defaultGroup. Required: Resources.
get_single_boomi_account_group_by_id
Retrieves an instance of an AccountGroup object. Returns a single Account Group object based on the supplied account group ID. >**Note:** Resources information is returned only for the Get operation, not the Query operation. Returns: name, Resources, id, autoSubscribeAlertLevel, accountId, defaultGroup. Required: id.
update_a_boomi_account_group_by_id
Modifies or updates an AccountGroup object. Updates an account group based on the supplied account group ID. Returns: name, Resources, id, autoSubscribeAlertLevel, accountId, defaultGroup. Required: id, Resources.
boomi_account_groups_bulk_get
Retrieves multiple AccountGroup objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_account_groups
Queries for an AccountGroup object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, Resources, id, autoSubscribeAlertLevel, accountId, defaultGroup. Required: QueryFilter.
boomi_account_groups_query_more
Retrieves additional results for an AccountGroup query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_account_group_account
Creates an AccountGroupAccount object. Adds an account to an account group. Returns: accountGroupId, accountId, id.
list_all_boomi_account_group_accounts
Queries for an AccountGroupAccount object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: accountGroupId, accountId, id. Required: QueryFilter.
boomi_account_group_accounts_query_more
Retrieves additional results for an AccountGroupAccount query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_account_group_account_by_id
Deletes an AccountGroupAccount object. Removes an account from an account group. Required: id.
create_a_boomi_account_group_user_role
Creates an AccountGroupUserRole object. Adds a user to an account group. Returns: accountGroupId, reasonForAction, firstName, lastName, id, notifyUser, roleId, userId.
list_all_boomi_account_group_user_roles
Queries for an AccountGroupUserRole object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: accountGroupId, reasonForAction, firstName, lastName, id, notifyUser, roleId, userId. Required: QueryFilter.
boomi_account_group_user_roles_query_more
Retrieves additional results for an AccountGroupUserRole query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_account_group_user_role_by_id
Deletes an AccountGroupUserRole object. Removes the user from an account group specified by the conceptual Account Group User Role object ID. Required: id.
get_single_boomi_account_sso_config_by_id
Retrieves an instance of an AccountSSOConfig object. Returns the Account Single Sign-on Configuration for the supplied account ID. Returns: enabled, assertionEncryption, fedIdFromNameId, caseInsensitiveFederationId, nameIdPolicy, authnContext, certInfo, certificate, accountId, idpUrl, authnContextComparison, signoutRedirectUrl. Required: id.
update_a_boomi_account_sso_config_by_id
Modifies or updates an AccountSSOConfig object. Updates the Account Single Sign-on Configuration for the supplied account ID. Returns: enabled, assertionEncryption, fedIdFromNameId, caseInsensitiveFederationId, nameIdPolicy, authnContext, certInfo, certificate, accountId, idpUrl, authnContextComparison, signoutRedirectUrl. Required: id.
delete_a_boomi_account_sso_config_by_id
Deletes an AccountSSOConfig object. Deletes the Account Single Sign-on Configuration for the supplied account ID. Required: id.
boomi_account_sso_configs_bulk_get
Retrieves multiple AccountSSOConfig objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
create_a_boomi_account_user_federation
Creates an AccountUserFederation object. Enables single sign-on for a specific user under a specific account using a specific federation ID. The user is not visible in the Setup page unless you assign one or more roles to that user. Returns: id, accountId, userId, federationId.
list_all_boomi_account_user_federations
Queries for an AccountUserFederation object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: id, accountId, userId, federationId. Required: QueryFilter.
boomi_account_user_federations_query_more
Retrieves additional results for an AccountUserFederation query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
update_a_boomi_account_user_federation_by_id
Modifies or updates an AccountUserFederation object. Updates the federation ID of a specific user in a specific account. Returns: id, accountId, userId, federationId. Required: id.
delete_a_boomi_account_user_federation_by_id
Deletes an AccountUserFederation object. Disables single sign-on for the user specified by the conceptual Account User Federation object ID. Required: id.
create_a_boomi_account_user_role
Creates an AccountUserRole object. Adds a user to an account. If you provide a user ID (email address) that does not exist, the system creates the user and adds them to the account. When creating a new user, the API request does not require the firstName and lastName fields. If you do not provide those fields, it assigns the default firstName or lastName values automatically. Returns: reasonForAction, firstName, lastName, id, accountId, notifyUser, roleId, userId.
delete_a_boomi_account_user_role_by_id
Deletes an AccountUserRole object. Removes the specified user by a specified conceptual Account User Role object ID from an account. Required: id.
list_all_boomi_api_usage_counts
Queries for an ApiUsageCount object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: errorCount, processDate, successCount, classification. Required: QueryFilter.
boomi_api_usage_counts_query_more
Retrieves additional results for an ApiUsageCount query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_atom
Creates a Runtime object. Creates and attaches a Runtime with the specified name to a specified Runtime cloud owned by the requesting account. This operation cannot be used to create a local Runtime. You must have the Runtime Management privilege to perform the POST operation. >**Note:** The `createdBy` is a system-generated or read-only field. Returns: cloudId, createdBy, hostName, cloudMoleculeId, purgeImmediate, forceRestartTime, cluster, type, capabilities, cloudName, dateInstalled, id, cloudOwnerName, isCloudAttachment, name, cloudMoleculeName, instanceId, purgeHistoryDays, status, description, …
get_single_boomi_atom_by_id
Retrieves an instance of a Runtime object. Retrieves the properties of the Runtime, Runtime cluster, or Runtime cloud having the specified ID. For Runtime clusters and Runtime clouds that are part of a multi-node runtime, the GET operation returns values for the following additional variables: - *nodeId* - *hostName* - *status* - *clusterProblem* For more information on these variables, refer to the topic Cluster Status panel. Returns: cloudId, createdBy, hostName, cloudMoleculeId, purgeImmediate, forceRestartTime, cluster, type, capabilities, cloudName, dateInstalled, id, cloudOwnerName, isCloudAttachment, name, cloudMoleculeName, instanceId, purgeHistoryDays, status, description, … Required: id.
update_a_boomi_atom_by_id
Modifies or updates a Runtime object. Updates the Runtime object having the specified ID. You can only update the name, purgeHistoryDays, purgeImmediate, forceRestartTime. You must have the Runtime Management privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update a Runtime. Returns: cloudId, createdBy, hostName, cloudMoleculeId, purgeImmediate, forceRestartTime, cluster, type, capabilities, cloudName, dateInstalled, id, cloudOwnerName, isCloudAttachment, name, cloudMoleculeName, instanceId, purgeHistoryDays, status, description, … Required: id.
delete_a_boomi_atom_by_id
Deletes a Runtime object. Deletes the Runtime object with the specified ID. You must have the Runtime Management privilege to perform the DELETE operation. If you have the Runtime Management Read Access privilege, you cannot delete a Runtime. Required: id.
boomi_atoms_bulk_get
Retrieves multiple Runtime objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_atoms
Queries for a Runtime object(s). Retrieves details of runtimes that were created by the authenticating account. Without applying query filters, the query returns all non-deleted runtimes. It is recommended to filter the results using query filters. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: cloudId, createdBy, hostName, cloudMoleculeId, purgeImmediate, forceRestartTime, cluster, type, capabilities, cloudName, dateInstalled, id, cloudOwnerName, isCloudAttachment, name, cloudMoleculeName, instanceId, purgeHistoryDays, status, description, … Required: QueryFilter.
boomi_atoms_query_more
Retrieves additional results for a Runtime query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_atom_as_2_artifact
Creates an AtomAS2Artifacts object. You can use the Download AS2 Artifacts Log operation to request and download AS2 artifacts logs. Returns: statusCode, message, url.
list_all_boomi_atom_connection_field_extension_summaries
Queries for an AtomConnectionFieldExtensionSummary object(s). 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. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, connectionId, id, processId, field, extensionGroupId. Required: QueryFilter.
boomi_atom_connection_field_extension_summaries_query_more
Retrieves additional results for an AtomConnectionFieldExtensionSummary query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_atom_connector_version_by_id
Retrieves an instance of an AtomConnectorVersions object. Retrieves the properties of connectors used by the Runtime, Runtime cluster, or Runtime cloud with specified ID. Returns: ConnectorVersion, id. Required: id.
boomi_atom_connector_versions_bulk_get
Retrieves multiple AtomConnectorVersions objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
update_a_boomi_atom_counter_by_id
Modifies or updates an AtomCounters object. The UPDATE operation updates Runtime Counter values for a specific Runtime. Using the UPDATE operation overrides all settings set on the current counter. However, calling the UPDATE operation does not delete any existing counters that are not included in the `AtomCounters` object. Returns: counter, atomId. Required: id.
boomi_atom_counters_async_response
Retrieves an AtomCounters object by identifier. For a response, use the token from the initial GET response in a new request. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
boomi_atom_counters_async_request
Retrieves an AtomCounters object by identifier. The GET operation returns the current state of the counter names and values for the specified Runtime. The initial GET operation returns a token for the specified Runtime. `accountId` is the Platform account that you are authenticating with and `id` is the Runtime ID for the counters you are attempting to GET. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
create_a_boomi_atom_log
Creates an AtomLog object. You can use the Download Atom Log operation to request and download Runtime logs. Returns: statusCode, message, url.
update_a_boomi_atom_purge_by_id
Modifies or updates an AtomPurge object. You can use the Purge Runtime cloud attachment operation to programmatically start the purge process for test and browse components, logs, processed documents, and temporary data for a Runtime Cloud attachment. Returns: atomId. Required: id.
update_a_boomi_atom_security_policy_by_id
Modifies or updates an AtomSecurityPolicies object. Updates the security policy for the specified Runtime cloud or Runtime cluster. You can add, update, or delete permissions by using the UPDATE operation. You can add custom Java runtime permissions you specify in an UPDATE operation to the appropriate High-security policy file. In addition, all High-security policy files contain custom permissions that you specify in the section. Returns: atomId, runner, listener, common, browser, worker. Required: id, atomId, common.
boomi_atom_security_policies_async_request
Retrieves an AtomSecurityPolicies object by identifier. The initial GET operation returns a security policy token for the specified Runtime cloud or Runtime cluster. Subsequent GET operations return status code 202 (while the request is in progress) or the custom contents of a security policy based on the token that was returned. The GET operation returns only custom runtime permissions that you added to the security policy, not the entire policy file. If you did not update the security policy for a given Runtime cloud or Runtime cluster, the response to a GET operation is empty. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
boomi_atom_security_policies_async_response
Retrieves AtomSecurityPolicies objects by token. Using the token from the initial GET response, send an HTTP GET where accountId is the account with which you are authenticating. Custom Java runtime permissions listed in the `` section apply to all High security policy files (procrunner-HIGH.policy, procbrowser-HIGH.policy, and procworker-HIGH.policy). Custom permissions listed in a specific section, such as ``, apply only to the associated security policy file. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
get_single_boomi_atom_startup_property_by_id
Retrieves an instance of an AtomStartupProperties object. Retrieves the startup properties for the Runtime, Runtime cluster, or Runtime cloud with the specified ID. Returns: Property, id. Required: id.
boomi_atom_startup_properties_bulk_get
Retrieves multiple AtomStartupProperties objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
create_a_boomi_atom_worker_log
Creates an AtomWorkerLog object. Allows users to programmatically retrieve a link for downloading a given Runtime workers log. Returns: statusCode, message, url.
get_single_boomi_audit_log_by_id
Retrieves an instance of an AuditLog object. Retrieve audit information for a single audit log entry, like the audit logs action message, the audit log type, action, and modifier. For example, you can use the GET operation to retrieve the environment extensions for a certain date using the document ID. Returns: source, AuditLogProperty, action, userId, type, containerId, level, message, accountId, documentId, modifier, date. Required: id.
boomi_audit_logs_bulk_get
Retrieves multiple AuditLog objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_audit_logs
Queries for an AuditLog object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. > **Note:** The `CONTAINS` and `NOT_CONTAINS` operators are not supported. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: source, AuditLogProperty, action, userId, type, containerId, level, message, accountId, documentId, modifier, date. Required: QueryFilter.
boomi_audit_logs_query_more
Retrieves additional results for an AuditLog query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_branch
Creates a Branch object. - To create a branch, you need the branch ID for the branch from which you want to create a new branch. New branches return ready as false until the creating stage has cleared. - You can also create a branch from a packaged component. To do so, use the ID of the packaged component as the packageId. Returns: name, deleted, createdBy, parentId, modifiedBy, deploymentId, createdDate, modifiedDate, id, packageId, stage, description, ready.
get_single_boomi_branch_by_id
Retrieves an instance of a Branch object. When you have the branch ID, you can query for additional information about the branch. Send an HTTP GET where {accountId} is the ID of the authenticating account and {branchId} is the ID of the branch you want to query. Returns: name, deleted, createdBy, parentId, modifiedBy, deploymentId, createdDate, modifiedDate, id, packageId, stage, description, ready. Required: id.
update_a_boomi_branch_by_id
Modifies or updates a Branch object. To update a branch, you need the branch ID. Currently, you can only update the name of the branch. Returns: name, deleted, createdBy, parentId, modifiedBy, deploymentId, createdDate, modifiedDate, id, packageId, stage, description, ready. Required: id.
delete_a_boomi_branch_by_id
Deletes a Branch object. Deletes a branch. - You can delete branches stuck in a non-ready state (such as CREATING, DELETING, FAILED_TO_CREATE, FAILED_TO_DELETE, and FAILED_TO_MERGE) after the minimum dwell time has passed. The default time is 15 minutes and can be configured via `EngineConfig.BRANCH_FORCE_DELETE_MIN_DWELL_MINUTES`. - If the minimum dwell time hasn't been exceeded, the following message is returned: `The {branchName} branch is currently processing. Required: id.
boomi_branches_bulk_get
Retrieves multiple Branch objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_branches
Queries for a Branch object(s). You must first retrieve the ID of your main branch, using the name of your current branch. If you haven't created any branches, your current branch will be `main`. When you query a branch, it might be in one of the following states: - `CREATING`: The branch is being created - `NORMAL`: The branch is ready to use - `DELETING`: The branch is being deleted. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, deleted, createdBy, parentId, modifiedBy, deploymentId, createdDate, modifiedDate, id, packageId, stage, description, ready. Required: QueryFilter.
boomi_branches_query_more
Retrieves additional results for a Branch query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_listener_status_change
Update listeners status. You can use the changeListenerStatus operation to pause, resume, or restart listeners. A successful changeListenerStatus call returns an empty changeListenerStatusResponse to indicate acceptance of the request.
boomi_clear_queues_execute
Executes an action on a ClearQueue object. - When you run the Clear queue messages action, it deletes all messages in a queue name from the queue. Note that this clears all messages in the queue; you cannot select and remove individual messages using this action. In addition, the action overrides any purge settings you might configure in the user interface. - The immediate response indicates success in passing the request to the Runtime. Returns: AtomId, DLQ, QueueName, SubscriberName. Required: clear_queue_id, AtomId, QueueName.
get_single_boomi_cloud_by_id
Retrieves an instance of a Cloud object. Retrieves the properties of the Runtime cloud having the specified ID. Returns: name, Atom, id. Required: id.
boomi_clouds_bulk_get
Retrieves multiple Cloud objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_clouds
Queries for a Cloud object(s). You can query the Cloud object using name or ID to retrieve a list of available runtime clouds in your account. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, Atom, id. Required: QueryFilter.
boomi_clouds_query_more
Retrieves additional results for a Cloud query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_component
Creates a Component object. - Cannot create components for types not eligible for your account. For example, if your account does not have the B2B/EDI feature, you will not be able to create Trading Partner components. - Request will not be processed in case if the payload has invalid attributes and tags under the section. - Include the `branchId` in the request body to specify a branch on which you want to create the component. This endpoint accepts XML only: send the component XML as the raw request body (application/xml).
get_single_boomi_component_by_id
Retrieves an instance of a Component object. - When using the GET operation by componentId, it returns the latest component if you do not provide the version. - When you provide the version in the format of `` ~ ``, it returns the specific version of the component. - The GET operation only accepts mediaType `application/xml` for the API response. - The limit is 5 requests for the BULK GET operation. The id is the Boomi component id. Returns: componentId, createdBy, version, folderName, folderId, modifiedDate, type, subType, name, folderFullPath, deleted, modifiedBy, encryptedValues, object, copiedFromComponentId, copiedFromComponentVersion, branchId, createdDate, GlobalVariableReferences, branchName, … Required: id.
update_a_boomi_component_by_id
Modifies or updates a Component object. - Full updates only. No partial updates. If part of the object's configuration is omitted, the component will be updated without that configuration. - The only exception is for encrypted fields such as passwords. The id is the Boomi component id. This endpoint accepts XML only: send the component XML as the raw request body (application/xml). Required: id.
boomi_components_bulk_get
Retrieves multiple Component objects by identifier. The limit for the BULK GET operation is 5 requests. All other API objects have a limit of 100 BULK GET requests. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode.
create_a_boomi_component_atom_attachment
Creates a ComponentAtomAttachment object. Attaches a component with a specific ID to the Runtime with a specific 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 components. Returns: componentId, atomId, id, componentType.
list_all_boomi_component_atom_attachments
Queries for a ComponentAtomAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, atomId, id, componentType. Required: QueryFilter.
boomi_component_atom_attachments_query_more
Retrieves additional results for a ComponentAtomAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_component_atom_attachment_by_id
Deletes a ComponentAtomAttachment object. Detaches a component from a Runtime where the attachment is specified by the conceptual Component Atom 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. Required: id.
create_a_boomi_component_diff_request
Creates a ComponentDiffRequest object. Contains a diff visualization option to help understand the differences between component versions. For more information, refer to the Postman article Visualize request responses using Postman Visualizer. Returns: ComponentDiffResponse. Required: componentId, sourceVersion, targetVersion.
get_single_boomi_component_diff_request_by_id
Retrieves an instance of a ComponentDiffRequest object. If you use Postman to make API calls, the GET response contains a diff visualization option to help understand the differences between component versions. For more information, refer to the Postman article Visualize request responses using Postman Visualizer. The Postman visualization feature currently supports only JSON responses. The id is the Boomi component id. Returns: componentId, sourceVersion, CompDiffConfig, targetVersion. Required: id.
boomi_component_diff_requests_bulk_get
Retrieves multiple ComponentDiffRequest objects. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
create_a_boomi_component_environment_attachment
Creates a ComponentEnvironmentAttachment object. Attaches a component with a specific ID to the environment with a specific ID. Returns: componentId, environmentId, id, componentType.
list_all_boomi_component_environment_attachments
Queries for a ComponentEnvironmentAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, environmentId, id, componentType. Required: QueryFilter.
boomi_component_environment_attachments_query_more
Retrieves additional results for a ComponentEnvironmentAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_component_environment_attachment_by_id
Deletes a ComponentEnvironmentAttachment object. Detaches a component from an environment where the attachment is specified by the conceptual Component 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. Required: id.
create_a_boomi_component_metadatum
Creates a ComponentMetadata object. The ability to create a new component is not supported at this time. Although, you can create a deleted component, but you cannot create a new component. You will receive an error if you do not specify the deleted component ID in the create request. Returns: name, componentId, createdBy, deleted, modifiedBy, version, folderName, copiedFromComponentId, copiedFromComponentVersion, branchId, createdDate, folderId, modifiedDate, branchName, type, subType, currentVersion.
get_single_boomi_component_metadatum_by_id
Retrieves an instance of a ComponentMetadata object. Returns the latest component revision if you do not provide the version. Providing the version in the format of `` ~ ``, returns the specific version of the component. Returns: name, componentId, createdBy, deleted, modifiedBy, version, folderName, copiedFromComponentId, copiedFromComponentVersion, branchId, createdDate, folderId, modifiedDate, branchName, type, subType, currentVersion. Required: id.
update_a_boomi_component_metadatum_by_id
Modifies or updates a ComponentMetadata object. Only `name` and `folderId` may be updated. They are optional and will only be modified if included in the UPDATE request. `folderId` must be a valid, non-deleted folder. If `folderId` is included in the request but with a blank value, it defaults to the root folder. Returns: name, componentId, createdBy, deleted, modifiedBy, version, folderName, copiedFromComponentId, copiedFromComponentVersion, branchId, createdDate, folderId, modifiedDate, branchName, type, subType, currentVersion. Required: id.
delete_a_boomi_component_metadatum_by_id
Deletes a ComponentMetadata object. Lets you delete required components. Note that deleting a component does NOT delete dependent components. Required: id.
boomi_component_metadata_bulk_get
Retrieves multiple ComponentMetadata objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_component_metadata
Queries for a ComponentMetadata object(s). - By default, QUERY results include previous revisions including deleted versions. Use query filters to exclude previous and deleted versions if desired. For more examples of querying components, see Component Metadata API example requests mentioned above in the API description. - The `version` field must be accompanied by the `componentId` field. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, componentId, createdBy, deleted, modifiedBy, version, folderName, copiedFromComponentId, copiedFromComponentVersion, branchId, createdDate, folderId, modifiedDate, branchName, type, subType, currentVersion. Required: QueryFilter.
boomi_component_metadata_query_more
Retrieves additional results for a ComponentMetadata query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_component_reference_by_id
Retrieves an instance of a ComponentReference object. Retrieves the component reference for a component ID. Send an HTTP GET to `https://api.boomi.com/api/rest/v1/{accountId}/ComponentReference/{componentId}` where `{accountId}` is the ID of the authenticating account for the request and `{componentId}` is the ID of the secondary component whose references you are attempting to GET. If you want to specify a branch, send an HTTP GET to `https://api.boomi.com/api/rest/v1/{accountId}/ComponentReference/{componentId}~{branchId}` where `{accountId}` is the ID of the authenticating account for the request and `{componentId}` is the ID of the secondary component whose references you are attempting to GET, and `{branchId}` is the branch on which you wa The id is the Boomi component id. Returns: references. Required: id.
boomi_component_references_bulk_get
Retrieves multiple ComponentReference objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_component_references
Queries for a ComponentReference object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. - You can use the QUERY operation to return the latest version(s) of a primary component(s) that references a given secondary component ID, or all the secondary components that the given primary component ID references. >**Note:** When querying either primary or secondary component references, the API object returns the immediate reference (one level). It does not recursively trace through nested references like the **Show Where Used** feature does in the user interface. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: references. Required: QueryFilter.
boomi_component_references_query_more
Retrieves additional results for a ComponentReference query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_connection_licensing_report
Creates a ConnectionLicensingReport object. Returns the Connection Licensing URL in the response to view or download the deployed connection details. To download connection licensing data for a given connector class: a. Send a POST and request body to `https://api.boomi.com/api/rest/v1//ConnectionLicensingReport` where accountId is the ID of the authenticating account for the request. Populate the request body with or without the available filters for the report that you want to download. Returns: url, message, statusCode. Required: QueryFilter.
get_single_boomi_connector_by_id
Retrieves an instance of a Connector object. You can only perform the GET operation by `type` and not by `name`. Send an HTTP GET where `accountId` is the ID of the authenticating account for the request and `connectorType` is the name of the connector subtype you are attempting to GET. For example, sending an HTTP GET to `https://api.boomi.com/api/rest/v1/accountId/Connector/database` returns `Database` type connectors available on the account. The id is the Boomi connector type. Returns: name, type. Required: id.
boomi_connectors_bulk_get
Retrieves multiple Connector objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_connectors
Queries for a Connector object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, type. Required: QueryFilter.
boomi_connectors_query_more
Retrieves additional results for a Connector query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_connector_document
Creates a ConnectorDocument object. The Connector Document operation allows you to download the raw, document data for a specific Generic Connector Record. This action submits the download request and the call returns a URL used to download the actual document data. Returns: url, message, statusCode.
list_all_boomi_custom_tracked_fields
Queries for a CustomTrackedField object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. >**Note:** This operation doesn't accept filters because the list is constrained to 20 fields. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: position, type, label. Required: QueryFilter.
boomi_custom_tracked_fields_query_more
Retrieves additional results for a CustomTrackedField query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_deployed_expired_certificates
Queries for a DeployedExpiredCertificate object(s). If a QUERY omits an explicit timespan filter — that is, the query does not use `expirationBoundary` in an expression — it applies a default timespan filter using the value of 30 and the LESS_THAN operator. This filter specifies expired certificates and certificates expiring within 30 days. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: certificateName, expirationDate, certificateType, containerId, environmentId, containerName, location, accountId, expirationBoundary, environmentName, certificateId. Required: QueryFilter.
boomi_deployed_expired_certificates_query_more
Retrieves additional results for a DeployedExpiredCertificate query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_deployed_package
Creates a DeployedPackage object. You can use the CREATE operation in two ways: - With `environmentId` and `packageId`, CREATE deploys the specified packaged component to the identified environment. - With `environmentId` and `componentId`, CREATE packages with the specified component and deploys the package to the specified environment. >**Note:** By default, deployment of listener processes are in a running state. To deploy a packaged listener process in a paused state, include the `listenerStatus` field with a value of `PAUSED`. Returns: componentId, componentVersion, listenerStatus, version, deploymentId, active, branchName, environmentId, packageId, message, packageVersion, deployedDate, deployedBy, componentType, notes.
get_single_boomi_deployed_package_by_id
Retrieves an instance of a DeployedPackage object. Returns a single Deployed Package object based on the deployment ID. Returns: componentId, componentVersion, listenerStatus, version, deploymentId, active, branchName, environmentId, packageId, message, packageVersion, deployedDate, deployedBy, componentType, notes. Required: id.
delete_a_boomi_deployed_package_by_id
Deletes a DeployedPackage object. Removes the packaged component from the environment each with a specific IDs. Required: id.
boomi_deployed_packages_bulk_get
Retrieves multiple DeployedPackage objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_deployed_packages
Queries for a DeployedPackage object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. >**Note:** The response includes a queryToken only when more than 100 results are available. Use the queryToken with the queryMore endpoint to retrieve additional results. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, componentVersion, listenerStatus, version, deploymentId, active, branchName, environmentId, packageId, message, packageVersion, deployedDate, deployedBy, componentType, notes. Required: QueryFilter.
boomi_deployed_packages_query_more
Retrieves additional results for a DeployedPackage query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_deployment
Creates a Deployment object. The Deployment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Packaged Component and Deployed Package objects instead. Returns: componentId, current, listenerStatus, version, deployedOn, environmentId, id, digest, message, processId, deployedBy, componentType, notes. Required: componentId, deployedOn, environmentId, id, digest, processId, deployedBy, componentType, notes.
get_single_boomi_deployment_by_id
Retrieves an instance of a Deployment object. The Deployment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the Packaged Component and Deployed Package objects instead. Returns: componentId, current, listenerStatus, version, deployedOn, environmentId, id, digest, message, processId, deployedBy, componentType, notes. Required: id.
boomi_deployments_bulk_get
Retrieves multiple Deployment objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_deployments
Queries for a Deployment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, current, listenerStatus, version, deployedOn, environmentId, id, digest, message, processId, deployedBy, componentType, notes. Required: QueryFilter.
boomi_deployments_query_more
Retrieves additional results for a Deployment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_document_count_accounts
Queries for a DocumentCountAccount object(s). The authenticating user for a QUERY operation must have the Dashboard privilege. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: value, atomId, accountId, date. Required: QueryFilter.
boomi_document_count_accounts_query_more
Retrieves additional results for a DocumentCountAccount query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_document_count_account_groups
Queries for a DocumentCountAccountGroup object(s). - You can use the EQUALS operator only with the `accountGroupId` filter parameter. - The authenticating user for a QUERY operation must have the Dashboard privilege. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: accountId, atomId, date, value. Required: QueryFilter.
boomi_document_count_account_groups_query_more
Retrieves additional results for a DocumentCountAccountGroup query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_edifact_connector_records
Queries for an EDIFACTConnectorRecord object(s). - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the EDIFACT Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: interchangeTime, atomId, version, operationName, documentIndex, customFields, id, account, release, connectorName, ackReport, executionId, outboundValidationStatus, ackStatus, receiverID, connectorType, controllingAgency, senderID, interchangeControlReference, dateProcessed, … Required: QueryFilter.
boomi_edifact_connector_records_query_more
Retrieves additional results for an EDIFACTConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_edi_custom_connector_records
Queries for an EdiCustomConnectorRecord object(s). - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the EDI Custom Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. - Sorting of the Query results are by the `dateProcessed` field value, from the oldest to the newest. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, version, customStandardName, messageID, operationName, toTradingPartner, documentIndex, customFields, id, account, messageTime, standardID, connectorName, senderIDQualifier, executionId, receiverID, connectorType, senderID, dateProcessed, fromTradingPartner, … Required: QueryFilter.
boomi_edi_custom_connector_records_query_more
Retrieves additional results for an EdiCustomConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_environment
Creates an Environment object. Creates an environment having the specified name. Environment names must be unique. Returns: name, parentEnvironment, id, parentAccount, classification.
get_single_boomi_environment_by_id
Retrieves an instance of an Environment object. Retrieves the properties of the environment with a specified ID. Returns: name, parentEnvironment, id, parentAccount, classification. Required: id.
update_a_boomi_environment_by_id
Modifies or updates an Environment object. Updates the Environment object having the specified ID. You can edit the name field only. Returns: name, parentEnvironment, id, parentAccount, classification. Required: id.
delete_a_boomi_environment_by_id
Deletes an Environment object. Deletes the Environment object with a specified ID. It is not possible to delete an environment that has attached Runtimes or integration packs. Required: id.
boomi_environments_bulk_get
Retrieves multiple Environment objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_environments
Queries for an Environment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, parentEnvironment, id, parentAccount, classification. Required: QueryFilter.
boomi_environments_query_more
Retrieves additional results for an Environment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_environment_atom_attachment
Creates an EnvironmentAtomAttachment object. Attaches a Runtime having the specified ID to the environment having the specified ID. Attaching an already attached Runtime moves the Runtime to the environment specified in the request. >**Note:** For accounts with Basic environment support, you can attach a single Runtime to each environment. For accounts with Unlimited environment support, you can attach have an unlimited number of Runtimes attached in each environment. Returns: atomId, environmentId, id.
list_all_boomi_environment_atom_attachments
Queries for an EnvironmentAtomAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, environmentId, id. Required: QueryFilter.
boomi_environment_atom_attachments_query_more
Retrieves additional results for an EnvironmentAtomAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_environment_atom_attachment_by_id
Deletes an EnvironmentAtomAttachment object. Detaches a Runtime from an environment where the attachment is specified by the conceptual Environment Atom Attachment object ID. This ID is returned by the CREATE operation that originated the attachment and can also be obtained from a QUERY operation. If you successfully detach the Runtime from the environment, the response is ``. Required: id.
list_all_boomi_env_connection_field_extension_summaries
Queries for an EnvironmentConnectionFieldExtensionSummary object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: environmentId, connectionId, id, processId, field, extensionGroupId. Required: QueryFilter.
boomi_env_connection_field_extension_summaries_query_more
Retrieves additional results for an EnvironmentConnectionFieldExtensionSummary query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_environment_extension_by_id
Retrieves an instance of an EnvironmentExtensions object. Retrieves the extension values for the environment having the specified ID (except for encrypted values). >**Note:** For all the process properties, the GET operation response returns values for the `value` field only when you perform an UPDATE operation from the API or save the extensions on the UI. Returns: tradingPartners, sharedCommunications, partial, operations, processProperties, extensionGroupId, properties, environmentId, crossReferences, id, PGPCertificates, connections. Required: id.
update_a_boomi_environment_extension_by_id
Modifies or updates an EnvironmentExtensions object. Updates the extension values for the environment having the specified ID. 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. >**Warning:** The UPDATE operation does not support running multiple map extensions requests concurrently. Returns: tradingPartners, sharedCommunications, partial, operations, processProperties, extensionGroupId, properties, environmentId, crossReferences, id, PGPCertificates, connections. Required: id, tradingPartners, sharedCommunications, operations, processProperties, properties, crossReferences, PGPCertificates, connections.
boomi_environment_extensions_bulk_get
Retrieves multiple EnvironmentExtensions objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_environment_extensions
Queries for an EnvironmentExtensions object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. **Note:** The response includes a queryToken only when more than 100 results are available. Use the queryToken with the queryMore endpoint to retrieve additional results. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: tradingPartners, sharedCommunications, partial, operations, processProperties, extensionGroupId, properties, environmentId, crossReferences, id, PGPCertificates, connections. Required: QueryFilter.
boomi_environment_extensions_query_more
Retrieves additional results for an EnvironmentExtensions query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_environment_map_extension_by_id
Retrieves an instance of an EnvironmentMapExtension object. Retrieves an extensible map by its Environment Map Extension object ID. >**Note:** Extending a source or destination profile by means of browsing an external account may require including credentials in the request. The GET operation uses the credentials from the original process for the browse connection. However, because credential reuse can be problematic when sharing processes in Integration Packs, use the EXECUTE operation instead. Returns: mapId, name, environmentId, id, Map, processId, extensionGroupId. Required: id.
update_a_boomi_environment_map_extension_by_id
Modifies or updates an EnvironmentMapExtension object. Updates the extended mapping configuration for the specified Environment Map Extension object ID. Returns: mapId, name, environmentId, id, Map, processId, extensionGroupId. Required: id.
boomi_environment_map_extensions_bulk_get
Retrieves multiple EnvironmentMapExtension objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
boomi_environment_map_extensions_execute
Executes an action on an EnvironmentMapExtension object. Use the EXECUTE operation when you want to customize XML profiles by reimporting them from endpoint applications. The EXECUTE operation returns the current Environment Map Extension configuration similar to the GET operation. It also accepts connection credentials and automatically connects to the external application to retrieve additional custom fields for that profile. You must have the Runtime Management privilege to perform the EXECUTE operation. Returns: mapId, name, environmentId, id, Map, processId, extensionGroupId. Required: environment_map_extension_id.
list_all_boomi_env_map_extension_external_components
Queries for an EnvironmentMapExtensionExternalComponent object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentName, componentId, environmentMapExtensionId, componentVersion, componentType. Required: QueryFilter.
boomi_env_map_extension_external_components_query_more
Retrieves additional results for an EnvironmentMapExtensionExternalComponent query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_env_map_extension_user_defined_function
Creates an EnvironmentMapExtensionUserDefinedFunction object. The CREATE operation creates a new extensible user-defined function. User-defined functions created using the Environment Map Extension User Defined Function object exists only at the environment extension level and are tied to a single map extension only. When creating a new user-defined function, you define individual function steps that make up the greater user-defined function. Then, in the `` section of the request, you determine how to map or link each step to and from the function's input and output. Returns: name, deleted, createdBy, modifiedBy, Outputs, createdDate, modifiedDate, environmentMapExtensionId, Mappings, id, description, Inputs, Steps. Required: Outputs, Mappings, Inputs, Steps.
get_single_boomi_env_map_extension_user_defined_function_by_id
Retrieves an instance of an EnvironmentMapExtensionUserDefinedFunction object. Retrieves an extensible user-defined function associated with a given environment map extension function ID. Returns: name, deleted, createdBy, modifiedBy, Outputs, createdDate, modifiedDate, environmentMapExtensionId, Mappings, id, description, Inputs, Steps. Required: id.
update_a_boomi_env_map_extension_user_defined_function_by_id
Modifies or updates an EnvironmentMapExtensionUserDefinedFunction object. Updates the extended configuration for a single user-defined function. >**Caution:** Updating functions require all existing input and output values in the request regardless if they are mapped or populated with a default value. Otherwise, it overrides and removes those variables from the function. Returns: name, deleted, createdBy, modifiedBy, Outputs, createdDate, modifiedDate, environmentMapExtensionId, Mappings, id, description, Inputs, Steps. Required: id, Outputs, Mappings, Inputs, Steps.
delete_a_boomi_env_map_extension_user_defined_function_by_id
Deletes an EnvironmentMapExtensionUserDefinedFunction object. Deletes the specified user-defined function. Deleted user-defined functions return a status of true and are no longer available for use in an API call or on the user interface. ### Restoring a deleted user-defined function Reinstate a deleted user-defined function by providing the function's id in a CREATE operation. You cannot make changes to a function during restoration (in other words, you cannot edit its values in a RESTORE request). Required: id.
boomi_env_map_extension_user_defined_functions_bulk_get
Retrieves multiple EnvironmentMapExtensionUserDefinedFunction objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_env_map_ext_udf_summaries
Queries for an EnvironmentMapExtensionUserDefinedFunctionSummary object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: modifiedDate, name, environmentMapExtensionId, componentId, createdBy, deleted, modifiedBy, createdDate. Required: QueryFilter.
boomi_env_map_ext_udf_summaries_query_more
Retrieves additional results for an EnvironmentMapExtensionUserDefinedFunctionSummary query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_environment_map_extensions_summaries
Queries for an EnvironmentMapExtensionsSummary object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: mapId, name, environmentId, id, DestinationFieldSet, processId, SourceFieldSet, extensionGroupId. Required: QueryFilter.
boomi_environment_map_extensions_summaries_query_more
Retrieves additional results for an EnvironmentMapExtensionsSummary query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_environment_role
Creates an EnvironmentRole object. Associates a role with an environment. You must have the Runtime Management privilege to perform the CREATE operation. Returns: roleId, environmentId, id.
get_single_boomi_environment_role_by_id
Retrieves an instance of an EnvironmentRole object. Returns a single Environment Role object based on the supplied environment role ID. Returns: roleId, environmentId, id. Required: id.
delete_a_boomi_environment_role_by_id
Deletes an EnvironmentRole object. Removes the association between a role and an environment. You must have the Runtime Management privilege to perform the DELETE operation. If you have the Runtime Management privilege, you cannot delete associations between roles and environments. Required: id.
boomi_environment_roles_bulk_get
Retrieves multiple EnvironmentRole objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_environment_roles
Queries for an EnvironmentRole object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: roleId, environmentId, id. Required: QueryFilter.
boomi_environment_roles_query_more
Retrieves additional results for an EnvironmentRole query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_events
Queries for an Event object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: topLevelProcessId, atomId, atomName, title, updateDate, erroredStepLabel, eventId, error, accountId, processId, errorType, eventType, errorDocumentCount, eventLevel, executionId, startTime, eventDate, status, outboundDocumentCount, recordDate, … Required: QueryFilter.
boomi_events_query_more
Retrieves additional results for an Event query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_execution_artifact
Creates an ExecutionArtifacts object. Allows you to retrieve a link for downloading detailed information about a given process run. - You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot download execution artifacts. - Additionally, as the Cloud owner, you must select the **Enable Download of Execution Artifacts and Worker Logs** property for your account. Returns: executionId.
list_all_boomi_execution_connectors
Queries for an ExecutionConnector object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. - The QUERY operation allows you to query the connectors involved in a process run by filtering on attributes like executionId, actionType, successCount, and so on. - Requires one or more execution IDs in the request body. - You can filter all fields except executionConnector and id. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: executionId, connectorType, errorCount, actionType, recordType, id, size, executionConnector, successCount, isStartShape. Required: QueryFilter.
boomi_execution_connectors_query_more
Retrieves additional results for an ExecutionConnector query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_execution_count_accounts
Queries for an ExecutionCountAccount object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, failures, successes, accountId, date. Required: QueryFilter.
boomi_execution_count_accounts_query_more
Retrieves additional results for an ExecutionCountAccount query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_execution_count_account_groups
Queries for an ExecutionCountAccountGroup object(s). The authenticating user for a QUERY operation must have the Dashboard privilege. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: accountId, atomId, date, failures, successes. Required: QueryFilter.
boomi_execution_count_account_groups_query_more
Retrieves additional results for an ExecutionCountAccountGroup query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
boomi_execution_records_async_response
Retrieves an instance of an ExecutionRecord object. - Use the GET operation with the Execution Request object. You use the Execution Request object to asynchronously run an integration process on a given Atom using a CREATE operation. Therefore, the `Execution Record` GET operation allows you to poll for when the run request is complete. - The **Execution Request object** POST response returns a *requestId*. Polls the result of an asynchronous execution-record request by its request id. Returns: reportKey, atomId, atomName, recordedDate, executionType, inboundErrorDocumentCount, account, nodeId, processId, topLevelExecutionId, executionId, executionTime, clusterNodeId, executionWorkerId, outboundDocumentSize, status, outboundDocumentCount, originalExecutionId, launcherID, inboundDocumentSize, … Required: request_id.
list_all_boomi_execution_records
Queries for an ExecutionRecord object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: reportKey, atomId, atomName, recordedDate, executionType, inboundErrorDocumentCount, account, nodeId, processId, topLevelExecutionId, executionId, executionTime, clusterNodeId, executionWorkerId, outboundDocumentSize, status, outboundDocumentCount, originalExecutionId, launcherID, inboundDocumentSize, … Required: QueryFilter.
boomi_execution_records_query_more
Retrieves additional results for an ExecutionRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_execution_request
Creates an ExecutionRequest object. Submits the process to run and returns results immediately. The operation does not wait for the run to complete. - The Execution Request response returns a requestID, which you use to make a subsequent call to the Execution Record object to retrieve detailed information about the process run. - This operation returns an error when the client: - Fails authentication or does not have the correct permissions - Supplies an invalid Account ID - Supplies an invalid Runtime ID - Attempts to reach a deleted Atom - Supplies an invalid Process ID - Missing privileges to run processes on the given Runtime or its associated Environment. Returns: recordUrl, atomId, DynamicProcessProperties, ProcessProperties, processId, requestId, processName. Required: atomId, DynamicProcessProperties, ProcessProperties.
list_all_boomi_execution_summary_records
Queries for an ExecutionSummaryRecord object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: elapsedVarSum, reportKey, atomName, executionCount, accountID, outboundDocCount, processID, launchElapsedTime, outboundDocSize, elapsedTime, inboundDocSize, status, maxElapsedTime, launcherID, returnDocSize, returnDocCount, atomID, inboundDocCount, timeBlock, processName. Required: QueryFilter.
boomi_execution_summary_records_query_more
Retrieves additional results for an ExecutionSummaryRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_folder
Creates a Folder object. - When using the CREATE operation, you can create a new folder within the parent folder. - When creating a new folder, a name is required but PermittedRoles are optional. Unless it includes a list of UserRoles, in which case the GUID is required for the UserRole. - `parentId` must be a valid, non-deleted folder. Returns: name, deleted, parentId, id, fullPath, parentName, PermittedRoles.
get_single_boomi_folder_by_id
Retrieves an instance of a Folder object. Retrieves the folder with the particular ID. Returns: name, deleted, parentId, id, fullPath, parentName, PermittedRoles. Required: id.
update_a_boomi_folder_by_id
Modifies or updates a Folder object. You can update by changing the name of the folder and following the same considerations for the CREATE parameters. Returns: name, deleted, parentId, id, fullPath, parentName, PermittedRoles. Required: id.
delete_a_boomi_folder_by_id
Deletes a Folder object. - Deleting a folder will delete the folder and its contents including all components and sub-folders. - The root folder cannot be deleted. - Folders containing actively deployed processes or other deployable components cannot be deleted. >**Note:** You can restore a deleted folder by requesting a CREATE operation and specifying the ID of the deleted folder. Required: id.
boomi_folders_bulk_get
Retrieves multiple Folder objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_folders
Queries for a Folder object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. - You can perform the QUERY operation for the Folder object by id, name, and deleted. - The QUERY MORE operation is also available for the Folder object. - You can perform an empty QUERY to return all folders. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, deleted, parentId, id, fullPath, parentName, PermittedRoles. Required: QueryFilter.
boomi_folders_query_more
Retrieves additional results for a Folder query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_generic_connector_record_by_id
Retrieves an instance of a GenericConnectorRecord object. Allows you to view document metadata for exactly one document based on the provided id. Returns: atomId, executionConnectorId, operationName, incrementalDocumentIndex, startShape, documentIndex, trackedFields, id, account, retryable, executionId, connectorType, connectionId, operationId, dateProcessed, status, errorMessage, actionType, size, connectorFields, … Required: id.
boomi_generic_connector_records_bulk_get
Retrieves multiple GenericConnectorRecord objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_generic_connector_records
Queries for a GenericConnectorRecord object(s). - The QUERY operation allows you to view document metadata for all documents in the run. You must query by exactly one `executionId`. - To filter by `connectorField`, use the format `connectorField/fieldName` as the filter property, where `fieldName` is the element name of the connector-tracked field. Wildcards are supported in the query argument, for example, `input*.txt`. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, executionConnectorId, operationName, incrementalDocumentIndex, startShape, documentIndex, trackedFields, id, account, retryable, executionId, connectorType, connectionId, operationId, dateProcessed, status, errorMessage, actionType, size, connectorFields, … Required: QueryFilter.
boomi_generic_connector_records_query_more
Retrieves additional results for a GenericConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_assignable_roles
Retrieve assignable roles. You can use the getAssignableRoles operation to retrieve a list of roles that are assignable under an account. Returns: Role.
list_all_boomi_hl_7_connector_records
Queries for a HL7ConnectorRecord object(s). - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the HL7 Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, version, operationName, receiverApplicationId, documentIndex, customFields, id, account, messageControlId, connectorName, ackReport, executionId, isValidMessage, outboundValidationStatus, ackStatus, connectorType, dateProcessed, successful, errorMessage, receiverFacilityId, … Required: QueryFilter.
boomi_hl_7_connector_records_query_more
Retrieves additional results for a HL7ConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_installer_token
Creates an InstallerToken object. Creates an installer token of a specific type that is valid for a specific number of minutes. Returns: cloudId, expiration, installType, accountId, token, created, durationMinutes.
get_single_boomi_integration_pack_by_id
Retrieves an instance of an IntegrationPack object. Retrieves the properties of the integration pack with a specified ID. The ordinary GET operation retrieves the properties of the integration pack with a specified ID. The bulk GET operation retrieves the properties of the integration packs having the specified IDs, to a maximum of 100. Returns: name, id, installationType, Description. Required: id.
boomi_integration_packs_bulk_get
Retrieves multiple IntegrationPack objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_integration_packs
Queries for an IntegrationPack object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, id, installationType, Description. Required: QueryFilter.
boomi_integration_packs_query_more
Retrieves additional results for an IntegrationPack query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_integration_pack_atom_attachment
Creates an IntegrationPackAtomAttachment object. Attaches an integration pack instance having the specified ID to the Runtime having the specified ID. Returns: integrationPackInstanceId, atomId, id.
list_all_boomi_integration_pack_atom_attachments
Queries for an IntegrationPackAtomAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: integrationPackInstanceId, atomId, id. Required: QueryFilter.
boomi_integration_pack_atom_attachments_query_more
Retrieves additional results for an IntegrationPackAtomAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_integration_pack_atom_attachment_by_id
Deletes an IntegrationPackAtomAttachment object. Detaches an integration pack instance from a Runtime, where the attachment is specified by the conceptual Integration Pack Atom Attachment object ID. This ID can be obtained from a QUERY operation. Required: id.
create_a_boomi_integration_pack_environment_attachment
Creates an IntegrationPackEnvironmentAttachment object. Attaches an integration pack instance having the specified ID to the environment having the specified ID. Returns: integrationPackInstanceId, environmentId, id.
list_all_boomi_integration_pack_environment_attachments
Queries for an IntegrationPackEnvironmentAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: integrationPackInstanceId, environmentId, id. Required: QueryFilter.
boomi_integration_pack_environment_attachments_query_more
Retrieves additional results for an IntegrationPackEnvironmentAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_integration_pack_environment_attachment_by_id
Deletes an IntegrationPackEnvironmentAttachment object. Detaches an integration pack instance from an environment where the conceptual Integration Pack Environment Attachment object ID specifies the attachment. If you successfully detach the integration pack instance from the environment, the response is `true`. Required: id.
create_a_boomi_integration_pack_instance
Creates an IntegrationPackInstance object. Installs an instance of the integration pack with a specific ID in the requesting account. You can set the integrationPackOverrideName field only if you configure the specified integration pack to allow multiple installs. Returns: ProcessId, integrationPackId, id, integrationPackOverrideName, createdDate.
get_single_boomi_integration_pack_instance_by_id
Retrieves an instance of an IntegrationPackInstance object. Retrieves the properties of the integration pack instance having the specified ID. The ordinary GET operation retrieves the properties of the integration pack instance having the specified ID. The bulk GET operation retrieves the properties of the integration pack instances having the specified IDs, to a maximum of 100. You can obtain integration pack instance IDs from the QUERY operation. Returns: ProcessId, integrationPackId, id, integrationPackOverrideName, createdDate. Required: id.
delete_a_boomi_integration_pack_instance_by_id
Deletes an IntegrationPackInstance object. Uninstalls the integration pack instance having a specified ID from the requesting account. You can obtain this ID from a QUERY operation. Required: id.
boomi_integration_pack_instances_bulk_get
Retrieves multiple IntegrationPackInstance objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_integration_pack_instances
Queries for an IntegrationPackInstance object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: ProcessId, integrationPackId, id, integrationPackOverrideName, createdDate. Required: QueryFilter.
boomi_integration_pack_instances_query_more
Retrieves additional results for an IntegrationPackInstance query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
boomi_java_rollbacks_execute
Executes an action on a JavaRollback object. Returns a Runtime, Runtime cluster, Runtime cloud, Authentication Broker, or Gateway to use the previous version of Java with an EXECUTE operation. - After performing the EXECUTE operation, you can determine the success of returning to an earlier version when the **Update to use .** link displays on the following pages, indicating that a more recent version is available for upgrade: - For Runtimes, Runtime clusters, and Runtime clouds — the **Runtime Information** panel (**Manage** > **Runtime Management** of the user interface). - For Brokers — the **Broker Information** panel (**Configure Server** > **Authentication** of the user interface). - For API Gateways — the **Gateway Information** Returns: atomId. Required: java_rollback_id.
create_a_boomi_java_upgrade
Creates a JavaUpgrade object. Download and run the Java upgrader script for a specified Runtime, Runtime cluster, Runtime cloud, or API Gateway. Upgrades your selected container to Boomis latest supported version of Java. - After providing the endpoint and a request body that includes the containerID, the CREATE operation immediately upgrades the given container to Boomi's latest supported version of Java. After performing a CREATE operation, you can determine a successful upgrade when the **Update to use Java 11.** link no longer appears on the following pages: - For Runtimes, Runtime clusters, and Runtime clouds - the **Runtime Information** panel (**Manage** > **Runtime Management** of the user interface). Returns: atomId, JavaUpgradeOptions.
create_a_boomi_merge_request
Creates a MergeRequest object. You can use the Merge Request object to merge a development branch into the main branch. - To create a merge request, you need the branch IDs for the source and destination branches. The source branch is the branch you want to merge into the destination branch. - There are two merge request strategies you can choose from: OVERRIDE or CONFLICT_RESOLVE. Returns: createdBy, note, lockNonce, MergeRequestDetails, destinationBranchId, strategy, modifiedDate, previousStage, id, lockedDate, sourceBranchName, sourceBranchId, modifiedBy, inactiveDate, mergeRequestAction, createdDate, priorityBranch, destinationBranchName, stage, lockedBy. Required: MergeRequestDetails.
get_single_boomi_merge_request_by_id
Retrieves an instance of a MergeRequest object. Retrieve more information about the recently performed merge. - The `resolution` parameter is generated from the original merge request and specifies either the source branch for the final content for the merge or the destination. It can have the following values: - OVERRIDE: The source branch has taken priority - KEEP_DESTINATION: The destination branch has taken priority - The `changeType` parameter is generated from a branch diff that is performed on merge and can be one of the following values: - ADDED: A component was added to the source branch - MODIFIED: A component was modified in the source branch - DELETED: A component was deleted in the source branch After performing a merge reque Returns: createdBy, note, lockNonce, MergeRequestDetails, destinationBranchId, strategy, modifiedDate, previousStage, id, lockedDate, sourceBranchName, sourceBranchId, modifiedBy, inactiveDate, mergeRequestAction, createdDate, priorityBranch, destinationBranchName, stage, lockedBy. Required: id.
update_a_boomi_merge_request_by_id
Modifies or updates a MergeRequest object. Returns: createdBy, note, lockNonce, MergeRequestDetails, destinationBranchId, strategy, modifiedDate, previousStage, id, lockedDate, sourceBranchName, sourceBranchId, modifiedBy, inactiveDate, mergeRequestAction, createdDate, priorityBranch, destinationBranchName, stage, lockedBy. Required: id, MergeRequestDetails.
delete_a_boomi_merge_request_by_id
Deletes a MergeRequest object. If you no longer need an open merge request, you can delete it using the DELETE operation. This action is permanant and the merge request cannot be restored. You can delete merge requests that are stuck in the DELETING stage if it has not completed after 15 minutes. Required: id.
boomi_merge_requests_bulk_get
Retrieves multiple MergeRequest objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
boomi_merge_requests_execute
Executes an action on a MergeRequest object. - These are the actions you can choose from when executing a merge request: - MERGE: Use to start or restart a merge request; the stage must be REVIEWING or FAILED_TO_MERGE - REVERT: Use to revert a merge request; the stage must be MERGED or DELETED and previousStage is MERGED - RETRY_DRAFTING: Use when the merge request stage is FAILED_TO_DRAFT or FAILED_TO_REDRAFT - If the merge is successful, the `stage` and/or `previousStage` might be in one of the following stages: - DRAFTING - The merge request is in the queue. - DRAFTED - The merge request is drafted for review. - REVIEWING - The merge request is being reviewed. * MERGING - The merge request is being processed. Returns: createdBy, note, lockNonce, MergeRequestDetails, destinationBranchId, strategy, modifiedDate, previousStage, id, lockedDate, sourceBranchName, sourceBranchId, modifiedBy, inactiveDate, mergeRequestAction, createdDate, priorityBranch, destinationBranchName, stage, lockedBy. Required: merge_request_id, MergeRequestDetails.
list_all_boomi_merge_requests
Queries for a MergeRequest object. - You can query a branch to retrieve a list of all active merge request IDs. - You must include the destination or source branch as a parameter. Only EQUALS is allowed for these parameters. - Optional parameters include: - `createdDate` - `createdBy` - `stage` - `modifiedDate` - `modifiedBy` - You can use the `queryMore` request to return more than 100 results. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: createdBy, note, lockNonce, MergeRequestDetails, destinationBranchId, strategy, modifiedDate, previousStage, id, lockedDate, sourceBranchName, sourceBranchId, modifiedBy, inactiveDate, mergeRequestAction, createdDate, priorityBranch, destinationBranchName, stage, lockedBy. Required: QueryFilter.
boomi_merge_requests_query_more
Retrieves additional results for a MergeRequest query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_move_queue_request
Creates a MoveQueueRequest object. Moves messages from one Runtime queue to another. - You must have the **Runtime Management** privilege to use the Move queue request operation. - You can only move messages between queues of the same type. For example, moving queue messages from a point-to-point queue to a *Publish/Subscribe* queue results in an error. Returns: DestinationQueue, AtomId, SourceQueue. Required: DestinationQueue, AtomId, SourceQueue.
create_a_boomi_node_offboard
Creates a NodeOffboard object. Employs a POST method to delete a node. After you successfully perform the POST operation, the nodes status immediately changes to `Deleting` on the Cluster Status panel of the interface. Returns: atomId, nodeId.
list_all_boomi_odette_connector_records
Queries for an ODETTEConnectorRecord object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: interchangeTime, atomId, version, operationName, documentIndex, customFields, id, account, release, connectorName, ackReport, executionId, outboundValidationStatus, ackStatus, receiverID, connectorType, controllingAgency, senderID, interchangeControlReference, dateProcessed, … Required: QueryFilter.
boomi_odette_connector_records_query_more
Retrieves additional results for an ODETTEConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_oftp_2_connector_records
Queries for an OFTP2ConnectorRecord object. - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the OFTP2 Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. - Sorting of the QUERY results are by the dateProcessed field value, from the oldest to the newest. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: sfidorig, sfidosiz, sfiddesc, atomId, nareas, sfidcomp, sfiddate, operationName, sfidtime, documentIndex, customFields, sfidenv, id, account, sfidsign, initiator_ssidcode, connectorName, executionId, objecttype, sfiddsn, … Required: QueryFilter.
boomi_oftp_2_connector_records_query_more
Retrieves additional results for an OFTP2ConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_packaged_component
Creates a PackagedComponent object. - You can use the CREATE operation to perform two different actions. For example, you can create a new packaged component from a specific component ID, or you can restore a deleted packaged component. Both actions use the same object endpoint. However, the information required in the request body differs. Returns: componentId, createdBy, deleted, componentVersion, fullyPubliclyConsumable, shareable, createdDate, branchName, packageId, packageVersion, message, componentType, notes. Required: componentId, createdBy, createdDate, branchName, packageId, packageVersion, message, componentType, notes.
get_single_boomi_packaged_component_by_id
Retrieves an instance of a PackagedComponent object. Retrieves the packaged component with the specified ID. Returns: componentId, createdBy, deleted, componentVersion, fullyPubliclyConsumable, shareable, createdDate, branchName, packageId, packageVersion, message, componentType, notes. Required: id.
delete_a_boomi_packaged_component_by_id
Deletes a PackagedComponent object. - The DELETE operation deletes a specific packaged component version. The id that you provide in the endpoint represents a Packaged Component ID. You can retrieve the Packaged Component ID (packageId) using the GET and QUERY operations, or by viewing the **Packaged Component History** dialog for a specific version in the Integration user interface. >**Note:** You can restore deleted packaged components using the CREATE operation. Required: id.
boomi_packaged_components_bulk_get
Retrieves multiple PackagedComponent objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_packaged_components
Queries for a PackagedComponent object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, createdBy, deleted, componentVersion, fullyPubliclyConsumable, shareable, createdDate, branchName, packageId, packageVersion, message, componentType, notes. Required: QueryFilter.
boomi_packaged_components_query_more
Retrieves additional results for a PackagedComponent query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_packaged_component_manifest_by_id
Retrieves an instance of a PackagedComponentManifest object. Retrieve a list of the included components and their summary metadata for a single version of a packaged component. The id is the Boomi package id. Returns: componentInfo, packageId. Required: id.
boomi_packaged_component_manifests_bulk_get
Retrieves multiple PackagedComponentManifest objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
update_a_boomi_persisted_process_property_by_id
Modifies or updates a PersistedProcessProperties object. The UPDATE operation updates Persisted Process Property values for the specified Runtime. Using the UPDATE operation overrides all current property settings. Therefore, strongly recommends that you include a complete list of all Persisted Process properties you want to keep or update. If you do not list a current persisted process property in the Persisted Process properties object, the UPDATE operation deletes those properties. Returns: Process, atomId. Required: id, atomId.
boomi_persisted_process_properties_async_response
Retrieves a PersistedProcessProperties object by identifier. For a response, use the token from the response in a new request. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
boomi_persisted_process_properties_async_request
Retrieves a PersistedProcessProperties object by identifier. The GET operation returns the current state of the Persisted Process properties names and values for the specified Runtime. The initial GET operation returns a token for the specified Runtime. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
get_single_boomi_process_by_id
Retrieves an instance of a Process object. Retrieves the properties of the process having the specified ID. The ordinary GET operation retrieves the properties of the process having the specified ID. The bulk GET operation retrieves the properties of the processes having the specified IDs, to a maximum of 100. Returns: name, id, IntegrationPack, Description. Required: id.
boomi_processes_bulk_get
Retrieves multiple Process objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_processes
Queries for a Process object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, id, IntegrationPack, Description. Required: QueryFilter.
boomi_processes_query_more
Retrieves additional results for a Process query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_process_atom_attachment
Creates a ProcessAtomAttachment object. Attaches a process having the specified ID to the Runtime having the specified ID. Returns: atomId, id, processId, componentType.
list_all_boomi_process_atom_attachments
Queries for a ProcessAtomAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, id, processId, componentType. Required: QueryFilter.
boomi_process_atom_attachments_query_more
Retrieves additional results for a ProcessAtomAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_process_atom_attachment_by_id
Deletes a ProcessAtomAttachment object. Detaches a process from a Runtime where the attachment is specified by the conceptual Process Atom Attachment object ID. Required: id.
create_a_boomi_process_environment_attachment
Creates a ProcessEnvironmentAttachment object. Attaches a process having the specified ID to the environment having the specified ID. Returns: environmentId, id, processId, componentType.
list_all_boomi_process_environment_attachments
Queries for a ProcessEnvironmentAttachment object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: environmentId, id, processId, componentType. Required: QueryFilter.
boomi_process_environment_attachments_query_more
Retrieves additional results for a ProcessEnvironmentAttachment query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
delete_a_boomi_process_environment_attachment_by_id
Deletes a ProcessEnvironmentAttachment object. Detaches a process from an environment where the attachment is specified by the conceptual Process Environment Attachment object ID. Required: id.
create_a_boomi_process_log
Creates a ProcessLog object. Download process run logs. Returns: statusCode, message, url.
get_single_boomi_process_schedule_status_by_id
Retrieves an instance of a ProcessScheduleStatus object. Retrieves the Process Schedule Status object with a specified conceptual ID. The ordinary GET operation retrieves the Process Schedules object with a specific conceptual ID. The bulk GET operation retrieves the Process Schedules objects with specific conceptual IDs to a maximum of 100. In addition, you can obtain conceptual IDs from the QUERY operation. Returns: enabled, atomId, id, processId. Required: id.
update_a_boomi_process_schedule_status_by_id
Modifies or updates a ProcessScheduleStatus object. Stops or resumes process run schedules for a deployed process. The body of the request must specify not only the conceptual Process Schedule Status object ID but also the Runtime and process IDs. You can obtain the object ID from a QUERY operation. You must have the Runtime Management privilege and the Scheduling privilege to perform the UPDATE operation. Returns: enabled, atomId, id, processId. Required: id.
boomi_process_schedule_statuses_bulk_get
Retrieves multiple ProcessScheduleStatus objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_process_schedule_statuses
Queries for a ProcessScheduleStatus object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. >**Note:** The response includes a queryToken only when more than 100 results are available. Use the queryToken with the queryMore endpoint to retrieve additional results. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: enabled, atomId, id, processId. Required: QueryFilter.
boomi_process_schedule_statuses_query_more
Retrieves additional results for a ProcessScheduleStatus query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
get_single_boomi_process_schedule_by_id
Retrieves an instance of a ProcessSchedules object. Retrieves the Process Schedules object with a specific conceptual ID. The ordinary GET operation retrieves the Process Schedules object with a specific conceptual ID. The bulk GET operation retrieves the Process Schedules objects with specific conceptual IDs to a maximum of 100. In addition, you can obtain conceptual IDs from the QUERY operation. Returns: Retry, atomId, Schedule, id, processId. Required: id.
update_a_boomi_process_schedule_by_id
Modifies or updates a ProcessSchedules object. Clears and updates the process run schedules specified in the Process Schedules object with a specific ID. The body of the request must specify not only the conceptual object ID but also the Runtime and process IDs. You can obtain the object ID from a QUERY operation. A Process Schedules object exists for every deployed process. Returns: Retry, atomId, Schedule, id, processId. Required: id.
boomi_process_schedules_bulk_get
Retrieves multiple ProcessSchedules objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_process_schedules
Queries for a ProcessSchedules object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. >**Note:** The response includes a queryToken only when more than 100 results are available. Use the queryToken with the queryMore endpoint to retrieve additional results. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: Retry, atomId, Schedule, id, processId. Required: QueryFilter.
boomi_process_schedules_query_more
Retrieves additional results for a ProcessSchedules query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_rerun_document
Creates a RerunDocument object. Allows you to reprocess one or more documents from a previous run. Returns: recordUrl, AllDocuments, SelectedDocuments, requestId, originalExecutionId. Required: AllDocuments, SelectedDocuments, originalExecutionId.
list_all_boomi_rosetta_net_connector_records
Queries for a RosettaNetConnectorRecord object(s). - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the RosettaNet Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: PIPCode, atomId, timeToAcknowledgeReceipt, fromGlobalPartnerRoleClassificationCode, toGlobalPartnerRoleClassificationCode, isSecureTransportRequired, PIPVersion, processInstanceIdentifier, operationName, fromGlobalBusinessServiceCode, inResponseToGlobalBusinessActionCode, globalUsageCode, documentIndex, timeToAcknowledgeAcceptance, ackReport, executionId, globalBusinessActionCode, frameworkVersion, successful, toGlobalBusinessServiceCode, … Required: QueryFilter.
boomi_rosetta_net_connector_records_query_more
Retrieves additional results for a RosettaNetConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_runtime_release_schedule
Creates a RuntimeReleaseSchedule object. The CREATE operation sets a schedule for receiving updates with the scheduleType, dayOfWeek, hourOfDay, and timeZone fields. Returns: atomId, dayOfWeek, hourOfDay, scheduleType, timeZone. Required: atomId, dayOfWeek, scheduleType, timeZone.
get_single_boomi_runtime_release_schedule_by_id
Retrieves an instance of a RuntimeReleaseSchedule object. The GET operation returns the current schedule for receiving updates on a specified Runtime, Runtime cluster, or Runtime cloud. Returns: atomId, dayOfWeek, hourOfDay, scheduleType, timeZone. Required: id.
update_a_boomi_runtime_release_schedule_by_id
Modifies or updates a RuntimeReleaseSchedule object. The UPDATE operation modifies a set schedule for receiving updates. Returns: atomId, dayOfWeek, hourOfDay, scheduleType, timeZone. Required: id, atomId, dayOfWeek, scheduleType, timeZone.
delete_a_boomi_runtime_release_schedule_by_id
Deletes a RuntimeReleaseSchedule object. The DELETE operation sets the scheduleType to NEVER, meaning that the Runtime, Runtime cluster, or Runtime cloud receives updates only during the . Required: id.
boomi_runtime_release_schedules_bulk_get
Retrieves multiple RuntimeReleaseSchedule objects by identifier. The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
get_single_boomi_shared_server_information_by_id
Retrieves an instance of a SharedServerInformation object. Retrieve Shared Server Information records for a specific single Runtime ID. You can retrieve Shared Server Information records only by an ordinary GET operation specifying a single Runtime ID or a bulk GET operation with a maximum of 100 Runtime IDs. This option is because the object ID for the Shared Server Information is not available currently (except by requesting the information from services). Therefore, this operation does not return the Shared Server Information object auth field. Returns: externalHttpsPort, atomId, url, checkForwardedHeaders, maxThreads, minAuth, auth, apiType, httpsPort, authToken, externalHttpPort, externalHost, sslCertificateId, internalHost, httpPort, overrideUrl. Required: id.
update_a_boomi_shared_server_information_by_id
Modifies or updates a SharedServerInformation object. Updates a Shared Server Information object based on the supplied Runtime ID. - The UPDATE operation updates a Shared Server Information object based on the supplied Runtime ID. To clear a field, set the attribute corresponding to that field to an empty string. You must have the Runtime Management privilege to perform the UPDATE operation. Returns: externalHttpsPort, atomId, url, checkForwardedHeaders, maxThreads, minAuth, auth, apiType, httpsPort, authToken, externalHttpPort, externalHost, sslCertificateId, internalHost, httpPort, overrideUrl. Required: id.
boomi_shared_server_information_bulk_get
Retrieves multiple SharedServerInformation objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
get_single_boomi_shared_web_server_by_id
Retrieves an instance of a SharedWebServer object. Retrieves the details of a Shared Web Server configuration for this atom/cloud ID by its unique ID. The response can be in either XML or JSON format based on your request. Returns: shouldRestartPlugin, atomId, corsConfiguration, generalSettings, userManagement, cloudTennantGeneral. Required: id.
update_a_boomi_shared_web_server_by_id
Modifies or updates a SharedWebServer object. Updates a Shared Web Server object based on the supplied Runtime ID. Returns: shouldRestartPlugin, atomId, corsConfiguration, generalSettings, userManagement, cloudTennantGeneral. Required: id, atomId, corsConfiguration, generalSettings, userManagement, cloudTennantGeneral.
boomi_shared_web_servers_bulk_get
Retrieves multiple SharedWebServer objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_throughput_accounts
Queries for a ThroughputAccount object(s). - You can only use the EQUALS operator with the `environmentId` filter parameter. - The authenticating user for a QUERY operation must have the Dashboard privilege. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: value, atomId, accountId, date. Required: QueryFilter.
boomi_throughput_accounts_query_more
Retrieves additional results for a ThroughputAccount query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_throughput_account_groups
Queries for a ThroughputAccountGroup object(s). - You can only use the EQUALS operator with the `environmentId` filter parameter. - The authenticating user for a QUERY operation must have the Dashboard privilege. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: accountId, atomId, date, value. Required: QueryFilter.
boomi_throughput_account_groups_query_more
Retrieves additional results for a ThroughputAccountGroup query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_tradacoms_connector_records
Queries for a TradacomsConnectorRecord object(s). - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the Tradacoms Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: receiverCode, fileGenerationNumber, atomId, applicationReference, operationName, senderCode, documentIndex, customFields, time, id, account, receiverName, senderName, senderTransmissionReference, connectorName, date, executionId, connectorType, validationStatus, transmissionPriorityCode, … Required: QueryFilter.
boomi_tradacoms_connector_records_query_more
Retrieves additional results for a TradacomsConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_trading_partner_component
Creates a TradingPartnerComponent object. - This operation creates a Trading Partner Component object with a specified component name. - The request body requires the standard, classification, and componentName fields. If you omit the folderName field, you must use the folderId field - and vice versa. If you omit the componentID field and the IDs of any certificates you want to create, their values are assigned when you create the components. Returns: componentId, deleted, ContactInfo, folderName, PartnerInfo, organizationId, PartnerDocumentTypes, branchId, folderId, branchName, componentName, identifier, PartnerCommunication, description, standard, PartnerCommunicationTypes, classification. Required: ContactInfo, PartnerInfo, PartnerDocumentTypes, PartnerCommunication.
get_single_boomi_trading_partner_component_by_id
Retrieves an instance of a TradingPartnerComponent object. The ordinary GET operation returns a single Trading Partner Component object based on the supplied ID. A GET operation specifying the ID of a deleted Trading Partner component retrieves the component. In the component, the deleted field's value is true. Returns: componentId, deleted, ContactInfo, folderName, PartnerInfo, organizationId, PartnerDocumentTypes, branchId, folderId, branchName, componentName, identifier, PartnerCommunication, description, standard, PartnerCommunicationTypes, classification. Required: id.
update_a_boomi_trading_partner_component_by_id
Modifies or updates a TradingPartnerComponent object. This operation overwrites the Trading Partner Component object with the specified component ID except as described: - If the fields are empty, an UPDATE operation specifying the organizationId field populates the ContactInformation fields with the data from the referenced Organization component. However, if those fields have values, they are not overwritten. An UPDATE operation specifying the ID of a deleted Trading Partner component restores the component to a non-deleted state, assuming the request is otherwise valid. Returns: componentId, deleted, ContactInfo, folderName, PartnerInfo, organizationId, PartnerDocumentTypes, branchId, folderId, branchName, componentName, identifier, PartnerCommunication, description, standard, PartnerCommunicationTypes, classification. Required: id, ContactInfo, PartnerInfo, PartnerDocumentTypes, PartnerCommunication.
delete_a_boomi_trading_partner_component_by_id
Deletes a TradingPartnerComponent object. The DELETE operation deletes the Trading Partner Component object with a specific component ID. A DELETE operation specifying the ID of a deleted Trading Partner component returns a false response. Required: id.
boomi_trading_partner_components_bulk_get
Retrieves multiple TradingPartnerComponent objects by identifier. The bulk GET operation returns multiple Trading Partner Component objects based on the supplied IDs, to a maximum of 100 records. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_trading_partner_components
Queries for a TradingPartnerComponent object(s). The QUERY operation returns each Trading Partner component that meets the specified filtering criteria. - The name field in a QUERY filter represents the object's componentName field. - Only the LIKE operator is allowed with a name filter. Likewise, you can only use the EQUALS operator with a classification, standard, identifier filter, or a communication method filter (as2, disk, ftp, http, mllp, sftp). Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, deleted, ContactInfo, folderName, PartnerInfo, organizationId, PartnerDocumentTypes, branchId, folderId, branchName, componentName, identifier, PartnerCommunication, description, standard, PartnerCommunicationTypes, classification. Required: QueryFilter.
boomi_trading_partner_components_query_more
Retrieves additional results for a TradingPartnerComponent query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_trading_partner_processing_group
Creates a TradingPartnerProcessingGroup object. Send an HTTP POST request where `accountId` is the ID of the authenticating account for the request. If you omit the folderName field, you must include the folderId field — and vice versa. Returns: componentId, deleted, DocumentRouting, folderName, DefaultRouting, branchId, folderId, branchName, PartnerRouting, componentName, description, TradingPartners.
get_single_boomi_trading_partner_processing_group_by_id
Retrieves an instance of a TradingPartnerProcessingGroup object. The ordinary GET operation returns a single Trading Partner Processing Group object based on the supplied ID. The bulk GET operation returns multiple Trading Partner Processing Group objects based on the supplied IDs, to a maximum of 100. A GET operation specifying the ID of a deleted processing group component retrieves the component. In the component, the deleted field’s value is true. Returns: componentId, deleted, DocumentRouting, folderName, DefaultRouting, branchId, folderId, branchName, PartnerRouting, componentName, description, TradingPartners. Required: id.
update_a_boomi_trading_partner_processing_group_by_id
Modifies or updates a TradingPartnerProcessingGroup object. An UPDATE operation specifying the ID of a deleted processing group component restores the component to a non-deleted state, assuming the request is otherwise valid. It also overwrites the entire processing group component. Returns: componentId, deleted, DocumentRouting, folderName, DefaultRouting, branchId, folderId, branchName, PartnerRouting, componentName, description, TradingPartners. Required: id.
delete_a_boomi_trading_partner_processing_group_by_id
Deletes a TradingPartnerProcessingGroup object. A DELETE operation specifying the ID of a deleted processing group component returns a false response. If you deleted the component successfully, the response is "true". Required: id.
boomi_trading_partner_processing_groups_bulk_get
Retrieves multiple TradingPartnerProcessingGroup objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_trading_partner_processing_groups
Queries for a TradingPartnerProcessingGroup object(s). The QUERY operation returns all of the authenticating account’s processing group components. The operation does not return full component representations; it returns, for each result, the component’s name, ID, and folder ID. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, deleted, DocumentRouting, folderName, DefaultRouting, branchId, folderId, branchName, PartnerRouting, componentName, description, TradingPartners. Required: QueryFilter.
boomi_trading_partner_processing_groups_query_more
Retrieves additional results for a TradingPartnerProcessingGroup query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
list_all_boomi_x_12_connector_records
Queries for a X12ConnectorRecord object. - To filter by *customFields*, use the format `customFields/fieldName` as the filter property, where `fieldName` is the element name of the custom field in the X12 Connector Record structure. To get a list of the available custom fields, refer to the CustomTrackedField. - The STARTS_WITH operator accepts values that do not include spaces. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: atomId, isaAckStatus, gsVersion, isaAckReport, operationName, testIndicator, transactionSet, documentIndex, customFields, gsTime, id, account, agencyCode, standardID, isaControl, connectorName, ackReport, senderIDQualifier, executionId, gsControl, … Required: QueryFilter.
boomi_x_12_connector_records_query_more
Retrieves additional results for a X12ConnectorRecord query. To learn about using `queryMore`, refer to the topic Query paging. **Note:** The queryMore response may include a new queryToken if additional results are available beyond the current page. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
boomi_atom_disk_spaces_async_request
Retrieves an AtomDiskSpace object by identifier. The GET operation returns the current disk usage state of the given Runtime cloud attachment. The initial GET operation returns a token for the specified Runtime cloud attachment. Subsequent GET operations return status code 202 (while the request is in progress) based on the returned token. This first request is required to retrieve the authenticating token, which is used in a subsequent GET request. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
boomi_atom_disk_spaces_async_response
Retrieves an AtomDiskSpace object by token. Send a second HTTP GET request where accountId is the ID of the authenticating account for the request, and token is the token returned in the initial response. This second request authenticates the retrieval of the Runtime cloud attachments' disk space usage. >**Note:** `accountId` must always refer to the account ID of the parent Runtime cloud and not that of the attachment. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
boomi_list_queues_async_response
Retrieves a ListQueues object by identifier. After receiving a 200 status code response, send a second GET request where {accountId} is the ID of the account authenticating the request and sessionId is the ID provided in the initial response. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
boomi_list_queues_async_request
Retrieves a ListQueues object by identifier. To retrieve a list of message queues, Send an HTTP GET where accountId is the account that you are authenticating with and containerId is the ID of the Runtime, Runtime cluster, or Runtime cloud which owns the message queue that you want to retrieve. >**Note:** You can find the Account ID for an account by navigating to Settings > Account Information and Setup in the user interface. Additionally, you can find the container ID by navigating to Manage > Runtime Management and viewing the Runtime ID value on the Runtime Information panel for a selected Runtime, Runtime cluster, or Runtime cloud. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
boomi_listener_statuses_async_query
Retrieves a ListenerStatus object by identifier. Send an HTTP POST where {accountId} is the ID of the authenticating account for the request. >**Note:** For backward compatibility, Boomi continues to support the legacy URL: https://api.boomi.com/api/rest/v1/accountId/ListenerStatus/query/async. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: QueryFilter.
boomi_listener_statuses_async_response
Retrieves a ListenerStatus object by token. The ordinary GET operation retrieves async results from the QUERY. Send an HTTP GET where {accountId} is the account that you are authenticating with and {token} is the listener status token returned by your QUERY request. >**Note:** For backward compatibility, Boomi continues to support the legacy URL: https://api.boomi.com/api/rest/v1/accountId/ListenerStatus/query/async. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
create_a_boomi_organization_component
Creates an OrganizationComponent object. The CREATE operation creates an Organization Component object with the specified component name. The request body requires the `componentName` field. If you omit the `folderName` field, it requires the `folderId` field — and vice versa. If you omit the `componentID` field, it assigns the value when you create the component. Returns: branchName, componentId, componentName, deleted, folderName, description, OrganizationContactInfo, branchId, folderId. Required: OrganizationContactInfo.
get_single_boomi_organization_component_by_id
Retrieves an instance of an OrganizationComponent object. The GET operation returns a single Organization Component object based on the supplied ID. A GET operation specifying the ID of a deleted Organization Component retrieves the component. In the component, the deleted field’s value is *true*. Returns: branchName, componentId, componentName, deleted, folderName, description, OrganizationContactInfo, branchId, folderId. Required: id.
update_a_boomi_organization_component_by_id
Modifies or updates an OrganizationComponent object. The UPDATE operation overwrites the Organization Component object with the specified component ID. An UPDATE operation specifying the ID of a deleted Organization component restores the component to a non-deleted state, assuming the request is otherwise valid. Returns: branchName, componentId, componentName, deleted, folderName, description, OrganizationContactInfo, branchId, folderId. Required: id, OrganizationContactInfo.
delete_a_boomi_organization_component_by_id
Deletes an OrganizationComponent object. The DELETE operation deletes the Organization Component object with the specified component ID. A DELETE operation specifying the ID of a deleted Organization component returns a false response. If the component is deleted successfully, the response is `true`. Required: id.
boomi_organization_components_bulk_get
Retrieves multiple OrganizationComponent objects by identifier. The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_organization_components
Queries for an OrganizationComponent object. - Only the LIKE operator is allowed with a name filter. Likewise, only the EQUALS operator is permitted with a contactName, email, or phone filter. - If the QUERY request includes multiple filters, you can connect the filters with a logical AND operator — the query does not support the logical OR operator . - The QUERY results omit the folderName field. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: branchName, componentId, componentName, deleted, folderName, description, OrganizationContactInfo, branchId, folderId. Required: QueryFilter.
boomi_organization_components_query_more
Retrieves additional results for an OrganizationComponent query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_shared_communication_channel_component
Creates a SharedCommunicationChannelComponent object. The sample request creates a Shared Communication Component named `Disk Comms Channel`. Returns: componentId, deleted, communicationType, folderName, branchId, folderId, branchName, componentName, PartnerCommunication, description, PartnerArchiving. Required: PartnerCommunication, PartnerArchiving.
get_single_boomi_shared_communication_channel_component_by_id
Retrieves an instance of a SharedCommunicationChannelComponent object. Send an HTTP GET request where `{accountId}` is the ID of the authenticating account for the request and `{componentId}` is the ID of the component being retrieved. Returns: componentId, deleted, communicationType, folderName, branchId, folderId, branchName, componentName, PartnerCommunication, description, PartnerArchiving. Required: id.
update_a_boomi_shared_communication_channel_component_by_id
Modifies or updates a SharedCommunicationChannelComponent object. The sample request updates the component named `Disk Comms Channel`. Returns: componentId, deleted, communicationType, folderName, branchId, folderId, branchName, componentName, PartnerCommunication, description, PartnerArchiving. Required: id, PartnerCommunication, PartnerArchiving.
delete_a_boomi_shared_communication_channel_component_by_id
Deletes a SharedCommunicationChannelComponent object. If the Shared Communication Channel component is deleted successfully, the response is `true`. Required: id.
boomi_shared_communication_channel_components_bulk_get
Retrieves multiple SharedCommunicationChannelComponent objects by identifier. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_shared_communication_channel_components
Queries for a SharedCommunicationChannelComponent object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. The sample request query returns the Shared Communication Channel components using the AS2 standard for the authenticating account. **Note:** - The name field in a QUERY filter represents the object's `componentName` field. - The response includes a queryToken only when more than 100 results are available. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: componentId, deleted, communicationType, folderName, branchId, folderId, branchName, componentName, PartnerCommunication, description, PartnerArchiving. Required: QueryFilter.
boomi_shared_communication_channel_components_query_more
Retrieves additional results for a SharedCommunicationChannelComponent query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_account_group_integration_pack
Creates an AccountGroupIntegrationPack object. Adds an integration pack to the requesting account group. Returns: accountGroupId, integrationPackId, id, installationType, integrationPackName.
get_single_boomi_account_group_integration_pack_by_id
Retrieves an instance of an AccountGroupIntegrationPack object. The ordinary GET operation retrieves the properties of the AccountGroupIntegrationPack with the specified ID. The bulk GET operation retrieves the properties of the AccountGroupIntegrationPack with the specified IDs to a maximum of 100. You can obtain AccountGroupIntegrationPack IDs from the QUERY operation. Returns: accountGroupId, integrationPackId, id, installationType, integrationPackName. Required: id.
delete_a_boomi_account_group_integration_pack_by_id
Deletes an AccountGroupIntegrationPack object. Removes the integration pack with a specified ID from the requesting account group. You can obtain this ID from a QUERY operation. Required: id.
boomi_account_group_integration_packs_bulk_get
Retrieves multiple AccountGroupIntegrationPack objects by identifier. The bulk GET operation returns multiple objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_account_group_integration_packs
Queries for an AccountGroupIntegrationPack object(s). Retrieves all integration packs available to the requesting account group ID. For general information about the structure of QUERY filters and how to handle paged results, refer to the Query filters and Query paging topics. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: accountGroupId, integrationPackId, id, installationType, integrationPackName. Required: QueryFilter.
boomi_account_group_integration_packs_query_more
Retrieves additional results for an AccountGroupIntegrationPack query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_publisher_integration_pack
Creates a PublisherIntegrationPack object. Creates a single attachment or multiple attachment integration pack. Returns: name, id, installationType, Description, operationType, PublisherPackagedComponents. Required: Description.
get_single_boomi_publisher_integration_pack_by_id
Retrieves an instance of a PublisherIntegrationPack object. Retrieves the details of the integration pack and packaged components. The standard GET operation retrieves the properties of the integration pack with a specified ID. The bulk GET operation retrieves the properties of the integration packs with the specified IDs to a maximum of 100. Returns: name, id, installationType, Description, operationType, PublisherPackagedComponents. Required: id.
update_a_boomi_publisher_integration_pack_by_id
Modifies or updates a PublisherIntegrationPack object. The Update operation adds or removes the packaged components from the publisher integration pack. It also updates the description field of single and multiple attachment integration packs and the name field only for a single attachment integration pack. >**Note:** When updating an integration pack, you must include all the packaged components associated with it in the request body. If a packaged component is not included, it will be deleted upon updating an integration pack. Returns: name, id, installationType, Description, operationType, PublisherPackagedComponents. Required: id, Description.
delete_a_boomi_publisher_integration_pack_by_id
Deletes a PublisherIntegrationPack object. Deletes the publisher integration pack having a specified ID from the requesting account. The deleted integration pack is automatically uninstalled from all accounts where it was installed. Any Runtimes or environments attached to the integration pack are also detached. Required: id.
boomi_publisher_integration_packs_bulk_get
Retrieves multiple PublisherIntegrationPack objects by identifier. The bulk GET operation returns multiple objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_publisher_integration_packs
Queries for a PublisherIntegrationPack object(s). For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, id, installationType, Description, operationType, PublisherPackagedComponents. Required: QueryFilter.
boomi_publisher_integration_packs_query_more
Retrieves additional results for a PublisherIntegrationPack query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
create_a_boomi_release_integration_pack
Creates a ReleaseIntegrationPack object. Creates an immediate or scheduled release for a publisher integration pack. To schedule the publisher integration pack for release, you must specify the release schedule (immediate or scheduled). The `releaseOnDate` field is required if you schedule the release for a future date. >**Note:** When scheduling an integration pack for a release using Create and Update operation, you must select your time zone in the User Information panel within the Settings page. Returns: name, id, ReleasePackagedComponents, releaseOnDate, installationType, releaseStatusUrl, requestId, releaseSchedule.
update_a_boomi_release_integration_pack_by_id
Modifies or updates a ReleaseIntegrationPack object. Modifies the scheduled release of a publisher integration pack. The Update operation is only performed when there is an existing scheduled release request for the integration pack. >**Note:** When scheduling an integration pack for a release using Create and Update operation, you must select your time zone in the User Information panel within the Settings page. Setting the time zone ensures the scheduled date is displayed correctly in the UI. Returns: name, id, ReleasePackagedComponents, releaseOnDate, installationType, releaseStatusUrl, requestId, releaseSchedule. Required: id.
get_single_boomi_release_integration_pack_status_by_id
Retrieves an instance of a ReleaseIntegrationPackStatus object. To retrieve the release status of the publisher integration pack, follow these steps: 1. Send a POST request to the ReleaseIntegrationPack object. The response will return a requestId. You can also copy the request ID from the Integration Packs page. Returns: name, integrationPackId, releaseOnDate, ReleasePackagedComponents, responseStatusCode, releaseStatus, installationType, requestId, releaseSchedule, releaseProgress. Required: id.
boomi_release_integration_pack_statuses_bulk_get
Retrieves multiple ReleaseIntegrationPackStatus objects by identifier. The bulk GET operation returns multiple objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
create_a_boomi_runtime_restart_request
Creates a RuntimeRestartRequest object. Restarts the runtime. - The client sends a runtime restart request to the platform API that specifies the runtimeId that you want to restart. - The platform returns the status code and message while the request is in progress. A successful response implies the restart request was submitted, not when the runtime restart is completed. Returns: message, runtimeId.
create_a_boomi_secrets_manager_refresh
Refreshes the secrets caching. Returns: message.
create_a_boomi_runtime_cloud
Creates a RuntimeCloud object. Creates a private runtime cloud in the specified (TEST or PROD) environment. Send an HTTP POST to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud` Where `accountId` is the ID of the authenticating account. The response returns status code 201, which indicates the cloud is successfully created and 400 Bad Request, if required fields are missing or invalid — for example, a missing classification value. Returns: name, createdBy, allowBrowsing, modifiedBy, createdDate, modifiedDate, allowDeployments, id, allowTestExecutions, classification, maxAttachmentsPerAccount. Required: name, classification.
get_single_boomi_runtime_cloud_by_id
Retrieves an instance of a RuntimeCloud object. Retrieves the properties of a private runtime cloud with a specific ID. The `createdBy`, `createdDate`, `modifiedBy`, and `modifiedDate` fields return in a successful response for private runtime clouds created after July 12, 2025. If you update any existing private runtime cloud, then only `modifiedBy` and `modifiedDate` are returned in the Get response. Send an HTTP GET to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}` Where `accountId` is the ID of the authenticating account, and `cloudId` is the ID of the cloud for which you want to get information. Returns: name, createdBy, allowBrowsing, modifiedBy, createdDate, modifiedDate, allowDeployments, id, allowTestExecutions, classification, maxAttachmentsPerAccount. Required: id.
update_a_boomi_runtime_cloud_by_id
Modifies or updates a RuntimeCloud object. Updates the private runtime clouds. - If you update the private runtime cloud created before July 12, 2025, when retrieving its details, only `modifiedBy` and `modifiedDate` fields return in the responses of Get, Query, or QueryMore operations. - The `id` is a required field for updating a private runtime cloud. If you do not specify other fields in the Update operation, the values remain unchanged. Returns: name, createdBy, allowBrowsing, modifiedBy, createdDate, modifiedDate, allowDeployments, id, allowTestExecutions, classification, maxAttachmentsPerAccount. Required: id, name, classification.
delete_a_boomi_runtime_cloud_by_id
Deletes a RuntimeCloud object. Send an HTTP DELETE to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}` Where `accountId` is the ID of the authenticating account, and `cloudId` is the ID of the cloud you want to delete. Required: id.
boomi_runtime_clouds_bulk_get
Retrieves multiple RuntimeCloud objects by identifier. The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_runtime_clouds
Queries for RuntimeCloud objects. Retrieves private runtime clouds that exist on requesting account, and you can filter the records using query filters. Send an HTTP POST to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/query` Where `accountId` is the ID of the authenticating account. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: name, createdBy, allowBrowsing, modifiedBy, createdDate, modifiedDate, allowDeployments, id, allowTestExecutions, classification, maxAttachmentsPerAccount. Required: QueryFilter.
boomi_runtime_clouds_query_more
Retrieves additional results for a RuntimeCloud query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
update_a_boomi_account_cloud_attach_properties_default_by_id
Modifies or updates an AccountCloudAttachmentPropertiesDefault object. Sets the default cloud attachment properties for runtime cloud clusters. If you have multiple runtime cloud clusters, you need to set the defaults for each runtime cloud cluster individually. You can use the AccountCloudAttachmentSummary API to see the runtime cloud cluster status. >**Note:** If a value is not included in the Update call or is explicitly set to null, the value will be reset to its original default value for the runtime cloud cluster. Returns: testModeMaxDocBytes, numberofAtomWorkers, maxRetentionExecutionHistoryPersistence, workerElasticScalingThreshold, workerMaxGeneralExecutionTime, flowControlParallelProcessTypeOverride, enableAtomWorkerWarmup, maxConnectorTrackDocs, daysToProcessExecutionHistoryPersistence, queueMsgThrottleRate, atomInputSize, testModeMaxDocs, as2Workload, cloudAccountExecutionLimit, listenerMaxConcurrentExecutions, atomWorkingOverflowSize, workerMaxRunningExecutions, queueUseFilePersistence, workerMaxExecutionTime, atomOutputOverflowSize, … Required: id.
boomi_account_cloud_attach_properties_defaults_async_request
Retrieves an AccountCloudAttachmentPropertiesDefault object by identifier. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
boomi_account_cloud_attach_properties_defaults_async_response
Retrieves an AccountCloudAttachmentPropertiesDefault object by token. Step 2 of Boomi's async pattern: poll with the sessionId token returned by async_request until the response is complete. Returns: numberOfResults, responseStatusCode, result. Required: token.
get_single_boomi_account_cloud_attachment_summary_by_id
Retrieves an instance of an AccountCloudAttachmentSummary object. Send an HTTP GET where `{accountId}` is the ID of the authenticating account for the request and `{runtimeId}` is the ID of the cloud attachment. Returns: cloudId, attachmentCreationDate, runtimeId, cloudClusterId, attachmentInstanceId, attachmentAccountId. Required: id.
boomi_account_cloud_attachment_summaries_bulk_get
Retrieves multiple AccountCloudAttachmentSummary objects by identifier. The bulk GET operation returns multiple Account objects based on the supplied account IDs, to a maximum of 100. To learn more about `bulk`, refer to the topic Bulk GET operations. Body: {"type": "GET", "request": [{"id": "..."}]} with up to 100 ids; each result carries its own statusCode. Returns: response.
list_all_boomi_account_cloud_attachment_summaries
Queries for an AccountCloudAttachmentSummary object(s). Retrieves cloud attachments across all runtime clouds that were created by the authenticating account. Without applying query filters, the query returns all non-deleted cloud attachments across all cloud clusters. It is recommended to filter the results using query filters such as by cloud ID, by account ID, or by creation date. For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging. Send a QueryConfig body (QueryFilter expression with property/operator/argument); an empty body returns all records. Returns up to 100 records plus a queryToken when more exist; pass that token to query_more. Returns: cloudId, attachmentCreationDate, runtimeId, cloudClusterId, attachmentInstanceId, attachmentAccountId. Required: QueryFilter.
boomi_account_cloud_attachment_summaries_query_more
Retrieves additional results for an AccountCloudAttachmentSummary query. To learn about using `queryMore`, refer to the topic Query paging. Send the queryToken from the previous list/query_more response as the raw text/plain request body. Returns the next page (up to 100 records) and a new queryToken while more remain. Returns: numberOfResults, queryToken, result.
boomi_runtime_observability_settings_async_request
Retrieves a RuntimeObservabilitySettings object by identifier. Initiates async operation and returns token for retrieving observability settings. Step 1 of Boomi's async pattern: returns a sessionId token to poll with async_response. Returns: asyncToken, responseStatusCode. Required: runtime_id.
Why Truto
Why use Truto’s MCP server for Boomi
Other MCP servers give you a static tool list for one app. Truto gives you a managed, multi-tenant MCP infrastructure across 1100+ integrations.
Auto-generated, always up to date
Tools are dynamically generated from curated documentation — not hand-coded. As integrations evolve, tools stay current without manual maintenance.
Fine-grained access control
Scope each MCP server to read-only, write-only, specific methods, or tagged tool groups. Expose only what your AI agent needs — nothing more.
Multi-tenant by design
Each MCP server is scoped to a single connected account with its own credentials. The URL itself is the auth token — no shared secrets, no credential leaking across tenants.
Works with every MCP client
Standard JSON-RPC 2.0 protocol. Paste the URL into Claude, ChatGPT, Cursor, or any MCP-compatible agent framework — tools are discovered automatically.
Built-in auth, rate limits, and error handling
Tool calls execute through Truto’s proxy layer with automatic OAuth refresh, rate-limit handling, and normalized error responses. No raw API plumbing in your agent.
Expiring and auditable servers
Create time-limited MCP servers for contractors or automated workflows. Optional dual-auth requires both the URL and a Truto API token for high-security environments.
For your product
Ship Boomi tools in your product
Give the AI in your product access to each customer’s own Boomi account, with one MCP server per connected account.
Rather talk it through? Book a demo
For your own team
Use Boomi in ChatGPT or Claude yourself
Connect your company’s Boomi once, then ask in the AI you already use, with exactly your own access.
From the team behind Truto · 14-day free trial
Unified APIs
Unified APIs for Boomi
Skip writing code for every integration. Use Truto’s category-specific Unified APIs out of the box or customize the mappings with AI.
How It Works
From zero to integrated
Start with Boomi in a free sandbox, usually ready within one business day. No boilerplate, no maintenance burden.
Link your customer’s Boomi account
Use Truto’s frontend SDK to connect your customer’s Boomi account. We handle all OAuth and API key flows — you don’t need to create the OAuth app.
We handle authentication
Don’t spend time refreshing access tokens or figuring out secure storage. We handle it and inject credentials into every API request.
Call our API, we call Boomi
Truto’s Proxy API is a 1-to-1 mapping of the Boomi API. You call us, we call Boomi, and pass the response back in the same cycle.
Unified response format
Every response follows a single format across all integrations. We translate Boomi’s pagination into unified cursor-based pagination. Data is always in the result attribute.
FAQs
Common questions about Boomi on Truto
Authentication, rate limits, data freshness, and everything else you need to know before you integrate.
What operations does Truto support for Boomi today?
Truto supports three read operations through the Unified User Directory API: list_all_boomi_users, list_all_boomi_roles, and get_single_boomi_role_by_id. These cover user enumeration and role inspection. Write operations (create, update, delete) are not currently available.
Which Truto Unified API does the Boomi integration map to?
Boomi maps to Truto's Unified User Directory API, which provides normalized Users and Roles resources. This means you can query Boomi user and role data using the same schema you'd use for any other platform in the User Directory category.
How does authentication work for the Boomi integration?
Your end users connect their Boomi accounts through Truto's managed auth flow. Truto handles token management and credential storage so you don't need to build or maintain Boomi-specific auth logic in your application.
Does Truto handle pagination when listing Boomi users or roles?
Yes. Truto abstracts away Boomi's API-specific pagination. When you call list_all_boomi_users or list_all_boomi_roles, Truto manages cursor or page-based pagination behind the scenes and returns a consistent response format.
Can I retrieve the specific permissions associated with a Boomi role?
You can fetch detailed information about a single role using get_single_boomi_role_by_id, which returns the role definition and its metadata as exposed by Boomi's API. The exact fields depend on what Boomi surfaces for that role.
How fresh is the data returned by the Boomi integration?
Data is fetched in real time from Boomi's API on each request — there is no intermediate cache. Freshness is limited only by how quickly Boomi's own platform reflects changes made in their admin console.
From the Blog
Boomi integration guides
Deep dives, architecture guides, and practical tutorials for building Boomi integrations.
Boomi
Get Boomi integrated into your app
Our team understands what it takes to make a Boomi integration successful. A short, crisp 30 minute call with folks who understand the problem.