📄️ API objects and object-based operations
Reference for Boomi Platform API objects and the supported operations — GET, QUERY, CREATE, UPDATE, EXECUTE, and DELETE — that can be performed on them.
📄️ Account Cloud Attachment Properties Default object
The AccountCloudAttachmentPropertiesDefault object lets the runtime cloud owner retrieve and update the default cloud attachment properties for each runtime cloud cluster.
📄️ API Usage Count object
You can use the API Usage Count object to query the number of APIs used in a specific time frame.
📄️ AS2 Connector Record object
AS2 Connector Records correspond to the document and trading partner details of the Process Reporting page. Processes send AS2 messages using the AS2 Client connector and receive AS2 messages using the AS2 Shared Server connector. The AS2 Connector Record object contains AS2-specific document information and user-defined tracked field information along with other fields.
📄️ Account Cloud Attachment Quota object
Use the Account Cloud Attachment Quota object to programmatically get, create, update, and delete Cloud attachment quotas.
📄️ Account Cloud Attachment Summary object
The AccountCloudAttachmentSummary object lets cloud owners retrieve a list of cloud attachments for their runtime clouds. This includes attachments from the owner’s account as well as from child accounts with which the cloud is shared.
📄️ Account Cloud Attachment Properties object
Programmatically get or edit the properties of a {conKeyRefs.UCAtomCloudRuntimeCloud}'s attachments, such as {conKeyRefs.UCAtomCloudRuntimeCloud} and the Atom that the owner or accounts attached to the Cloud.
📄️ Account Group Account object
The Account Group Account object represents the linkage between a account and a account group. You can query, add, and remove accounts in an account group.
📄️ Account Group Integration Pack object
The AccountGroupIntegrationPack object represents an integration pack resource for existing account groups. You can retrieve, add, query, or remove the publisher integration packs from the account groups.
📄️ Account Group User Role object
The Account Group User Role object represents the linkage between an user, an account group, and a defined role for the
📄️ Account Group object
The Account Group object represents an account group.
📄️ Account Single Sign-on Configuration object
The Account Single Sign-on Configuration object represents the single sign-on options for an account.
📄️ Account User Federation object
The Account User Federation object represents the linkage between an user enabled for single sign-on, an account used by that user, and the user's federation ID. The implementation of single sign-on with SAML uses unique federation IDs to identify users.
📄️ Account User Role object
The Account User Role object represents the linkage between an user, the user's account, and a defined role for the account.
📄️ Account object
The Account object provides information about a account, including the associated users, connector licensing
📄️ Atom Connection Field Extension Summary object (Deprecated)
The Atom Connection Field Extension Summary objectis used to obtain the URL for OAuth 2.0 access token generation.
📄️ Atom Connector Versions object
The Atom Connector Versions object represents the properties of connectors that are used by a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloud_RuntimeCloud} .
📄️ Atom Disk Space object
As a Cloud owner, you can use the Atom Disk Space object to retrieve information about the current disk space usage for a given {conKeyRefs.UCAtomCloudRuntimeCloud} attachment.
📄️ Atom Extensions object (Deprecated)
The Atom Extensions object represents the extension \(process override\) values for a {conKeyRefs.UCAtomRuntime}.
📄️ Atom Map Extension functions (Deprecated)
You can use the Atom Map Extension object, now deprecated, to retrieve or update map functions. Map functions allow transformation logic to be applied to individual field values as they are being mapped.
📄️ Atom Map Extension object (Deprecated)
The Atom Map Extensions object represents an extensible data map for a {conKeyRefs.UCAtomRuntime} to which a given process is attached.
📄️ Atom Map Extensions Summary object (Deprecated)
The Atom Map Extensions Summary object refers to an extensible data map for a {conKeyRefs.UCAtomRuntime} to which a given process is attached. An extensible map to which the object refers is represented by the Atom Map Extension object.
📄️ Atom Security Policies object
The Atom Security Policies object represents custom updates to the current Java Virtual Machine \(JVM\) HIGH security policy for a {conKeyRefs.UCAtomCloudRuntimeCloud} or a {conKeyRefs.UCMoleculeRuntimeCluster} with forked execution enabled.
📄️ Atom Startup Properties object
The Atom Startup Properties object represents the start-up properties for a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloudRuntimeCloud}. These properties come from the Java virtual machine \(JVM\) to which you deploy the {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloudRuntimeCloud}.
📄️ Atom Counters object
The Atom Counters object represents the counters and their values associated with a particular {conKeyRefs.UCAtomRuntime}.
📄️ Atom object
The Atom object represents a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloudRuntimeCloud} ({conKeyRefs.PLCloudMolecule_RuntimeCloudCluster} and Cloud Attachment).
📄️ Audit Log object
The Audit Log object represents an entry in the audit log. Retention of audit log entries is indefinite — no purge schedule exists.
📄️ Audit log entries
The Audit Log object creates entries for account management actions.
📄️ Audit log query construction
You construct audit log queries for specific types of account management actions by combining the type, action, and modifier filter parameters.
📄️ Branch object
You can use the Branch object to create, update, and delete development branches on your account.
📄️ CloudAttachmentProperties object
The CloudAttachmentProperties API lets you manage and configure cloud attachment properties for runtimes, including runtime configuration settings, purge schedules, and account-level properties.
📄️ Cloud object
The Cloud object represents a {conKeyRefs.UCAtomCloudRuntimeCloud} that is available to the requesting account. You can retrieve a {conKeyRefs.UCAtomCloudRuntimeCloud}'s properties and query for {conKeyRefs.PLUCAtomCloud_RuntimeCloud} by name or ID.
📄️ Component Atom Attachment object (Legacy deployment, Deprecated)
The Component Atom Attachment object enables the attachment or detachment of a component to or from a particular {conKeyRefs.UCAtomRuntime}.
📄️ Component Diff object
You can use the Component Diff object to programmatically compare two different versions of Boomi Integration components, such as processes and maps. A comparative diff can provide:
📄️ Component Environment Attachment object (Legacy deployment, Deprecated)
The Component Environment Attachment object enables the attachment or detachment of a component to or from a particular environment.
📄️ Component Metadata API example requests
Use a list of API call examples for quick insight into the various requests you can make using the Component Metadata object.
📄️ Component Reference object
Use the Component Reference object to programmatically retrieve and query all the components which use or are used by a specific component.
📄️ Component Metadata object
The Component Metadata object represents the summary information for a component in the service. You can use the object to retrieve metadata information for a given component, such as name, component type, folder location, and more. The Component Metadata object also supports the ability to update the metadata information; as well as, delete and restore deleted components. This lets you rename or move components programmatically. The ability to create a new component is not supported at this time. You can also retrieve the full configuration details for a component, using the Component object.
📄️ Component object
Use the Component object to retrieve, create, and update the component configuration XML for a single component ID and version number. It is similar to opening and viewing a component's XML from the Revision History panel on the user interface's Build tab.
📄️ Connector object
Use the Connector object to retrieve information about the type of a connector that exists on the account, equivalent to the list of connector types available in a process connector’s Start shape.
📄️ Custom Tracked Field object
Use the Custom Tracked Field object to describe the custom tracked fields configured for a specific account.
📄️ Deployed Expired Certificate object
The Deployed Expired Certificate object provides access to the deployed X.509 certificate information used to populate the Certificates panel on the Runtime Management page. In addition, querying the Deployed Expired Certificate object enables programmatic generation of alerts of expiring certificates so you can manage certificates easier.
📄️ Deployed Package object
The Deployed Package object represents a packaged component deployed to an environment.
📄️ Deployment object (Legacy deployment, Deprecated)
The Deployment object represents a component deployment.
📄️ Document Count Account Group object
The Document Count Account Group object represents accessible data that corresponds to the data through the Document Count gadget in the Account Dashboard.
📄️ Document Count Account object
The Document Count Account object represents data corresponding to the data that is accessible through the Document Count gadget in the Account Dashboard.
📄️ EDIFACT Connector Record object
EDIFACT Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The EDIFACT Connector Record object contains EDIFACT-specific document information and user-defined tracked field information along with other fields.
📄️ EDI Custom Connector Record object
EDI Custom Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The EDI Custom Connector Record object contains the component names of the sending and receiving custom trading partners and user-defined tracked field information along with other fields.
📄️ Environment Atom Attachment object
The Environment Atom Attachment object enables the attachment or detachment of a {conKeyRefs.UCAtomRuntime} to or from a particular environment.
📄️ Environment Connection Field Extension Summary object
You can use the Environment Connection Field Extension Summary object to obtain the URL for OAuth 2.0 access token generation.
📄️ Environment Map Extension External Components object
Query the Environment Map Extension External Components object for a list of all available cross-reference components with a given environment map extension.
📄️ Environment Map Extension User Defined Function Summary object
Use the Environment Map Extension User Defined Function Summary object to query for a list of all available user-defined functions associated with a given environment map extension.
📄️ Environment Map Extension User Defined Function object
Use the Environment Map Extension User Defined Function object to create, modify, delete, and restore user-defined map functions within environment data maps.
📄️ Environment Map Extension functions
Map functions allow you to apply transformation logic to individual field values during mapping. You can use functions to augment base field mappings when configuring processes deployed as part of an integration pack. You can use the Environment Map Extension object to retrieve or update map functions.
📄️ Environment Map Extension object
The Environment Map Extensions object represents the extensible data map configuration for a deployed process.
📄️ Environment Map Extensions Summary object
The Environment Map Extensions Summary object refers to an extensible data map for an environment to which you attach a given process. An extensible map to which the object refers is represented by the Environment Map Extension object.
📄️ Environment Role object
The Environment Role object represents the linkage between an environment, an account where there is a defined environment, and a defined role for the environment.
📄️ Environment Extensions object
The Environment Extensions object represents the extension \(process override\) values for an environment.
📄️ Environment object
The Environment object represents an environment.
📄️ Event object
Event records correspond to the notifications that are available in the RSS feeds and sent in email notifications. The Event object returns information about the different types of events, including process run events, user notifications, and Atom monitoring events. The Event object returns process details information via the user.notification record, such as topLevelProcessId, processId, and processName.
📄️ Execution Count Account Group object
The Execution Count Account Group object represents data corresponding to the data accessible through the Execution Count gadget in the Account Dashboard.
📄️ Execution Count Account object
The Execution Count Account object represents data corresponding to the data that is accessible through the Execution Count gadget in the Account Dashboard.
📄️ Execution Record object
Execution records correspond to the Executions search on the Process Reporting page in the user interface. The Execution Record object contains information about a process run, including the run date, status, process information, {conKeyRefs.UCAtomRuntime} information, and error messages along with other fields.
📄️ Execution Request object
Use the Execution Request object to asynchronously run an integration process on a given Atom using a CREATE operation.
📄️ Execution Summary Record object
The Execution Summary Record object enables the retrieval of run information for processes that use the Low Latency option.
📄️ Execution Connector object
Use the Execution Connector object to programmatically retrieve information about the connectors included in a process run.
📄️ Folder object
Use the Folder object to programmatically return metadata for a specific folder in an account's Component Explorer hierarchy on the interface, such as the full folder path, the folder name, and if it is deleted. The Folder object supports the ability to create, update, delete, and restore deleted folders. Additionally, you can view and set the user role restrictions on the folder.
📄️ ForkedExecutionProperties object
The ForkedExecutionProperties API lets you manage and configure forked execution properties of runtime cluster and runtime cloud cluster. You can configure heap settings for runners, workers, and browsers.
📄️ Generic Connector Record object
Use the Generic Connector Record object to programmatically retrieve document metadata for a given process execution by means of a GET and QUERY operation.
📄️ GlobalVariableUpdateTransaction object
The GlobalVariableUpdateTransaction object manages the creation and retrieval of update transactions for Global Variable value assignments. Each transaction records a batch of variable value changes for a specific environment, including what values were set, what they replaced, and who made the change.
📄️ GlobalVariableValue object
The GlobalVariableValue object provides read-only access to the current value of a Global Variable for a specific environment. It allows retrieval and querying of per-environment variable values as they exist at the time of the request.
📄️ GlobalVariable object
The GlobalVariable API allows creation, retrieval, update, and querying of Global Variable definitions within a Boomi account. Global Variables are named, account-scoped variables that can hold different values per environment, and support optional encryption for sensitive data.
📄️ HL7 Connector Record object
HL7 Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The HL7 Connector Record object contains HL7-specific document information and user-defined tracked field information along with other fields.
📄️ Installer Token object
The Installer Token object represents a unique token generated by that you can use to install a {conKeyRefs.UCAtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster} node, {conKeyRefs.PLCloudMoleculeRuntimeCloudCluster}, Authentication Broker, or API Gateway.
📄️ Integration Pack Atom Attachment object (Deprecated)
The Integration Pack Atom Attachment object enables the attachment or detachment of an integration pack instance to or from a particular {conKeyRefs.UCAtomRuntime}.
📄️ Integration Pack Environment Attachment object
The Integration Pack Environment Attachment object enables the attachment or detachment of an integration pack instance to or from a particular environment.
📄️ Integration Pack Instance object
The Integration Pack Instance object represents an installed instance of an integration pack. You can query this object to find an account's installed integration pack instances and details of processes associated with instances.
📄️ Integration Pack object
The Integration Pack object represents an integration pack. You can query the Integration Pack object to determine the integration packs available to a secondary account
📄️ Java Upgrade Schedule object
The Java Upgrade Schedule object creates and manages a schedule to upgrade a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, {conKeyRefs.UCAtomCloud_RuntimeCloud}, or API Gateway to the latest version of Java, provides information about an existing schedule, and deletes an existing schedule.
📄️ Listener Status object
The Listener Status object represents the status of a listener process deployed to a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloud_RuntimeCloud}. For example, you can retrieve a listener's status to ensure that requests for pause, resume, or restart take effect before performing other actions.
📄️ Merge Request object
You can use the Merge Request object to create and manage merge requests to merge changes in a development branch to another branch.
📄️ Node Offboard object
As a Cloud or {conKeyRefs.UCMoleculeRuntimeCluster} owner, use the Node Offboard object to programatically delete nodes from a Cloud or {conKeyRefs.UCMoleculeRuntimeCluster} cluster.
📄️ OFTP2 Connector Record object
OFTP2 Connector Records correspond to the document and trading partner details of the Process Reporting page. Processes send OFTP2 messages using the OFTP2 Client connector and receive OFTP2 messages using the OFTP2 Server connector. The OFTP2 Connector Record object contains OFTP2-specific document information and user-defined tracked field informtaion along with other fields.
📄️ ODETTE Connector Record object
ODETTE Connector Records correspond to the document and trading partner details of the Process Reporting page. The ODETTE Connector Record object contains ODETTE-specific document information and user-defined tracked field information along with other fields.
📄️ Organization Component object
The Organization Component object represents an Organization component in the service. You can reuse organization components across multiple Trading Partners, API Services, and API Proxies.
📄️ Packaged Component Manifest object
Use the Packaged Component Manifest object to retrieve a list of the included components and their summary metadata for a single version of a packaged component.
📄️ Packaged Component object
The Packaged Component object represents a component packaged for deployment to an environment. You can use the Packaged Component object to create, query, or restore deleted packaged components.
📄️ Persisted Process Properties object
The Persisted Process Properties object represents the collection of properties that a {conKeyRefs.UCAtomRuntime} persists across subsequent
📄️ Process Atom Attachment object (Legacy deployment, Deprecated)
The Process Atom Attachment object enables the attachment or detachment of a process to or from a particular {conKeyRefs.UCAtomRuntime}.
📄️ Process Environment Attachment object (Legacy deployment, Deprecated)
The Process Environment Attachment object enables the attachment or detachment of a process to or from a particular environment.
📄️ Process Schedules object
The Process Schedules object represents the run schedules for a deployed process.
📄️ Process object
The Process object represents a process that is available to the requesting account.
📄️ Process Schedule Status object
The Process Schedule Status object represents the status of run schedules for a deployed process.
📄️ Publisher Integration Pack object
The PublisherIntegrationPack object represents the integration packs created in a parent or publisher account. Using
📄️ Reference Accounts by GroupId object
Use the Reference Accounts by GroupId object to return all of the accessible accounts in the provided account group. You can also search for a specific account that matches a string input.
📄️ Release Integration Pack Status object
Retrieves the status of the publisher integration pack scheduled for the release.
📄️ Release Integration Pack object
The Release Integration Pack object represents the release object of the publisher integration pack.
📄️ Role object
The Role object represents a role assignable to users to control access to functionality. The Role object is exposed to enable interaction with an account’s custom roles.
📄️ RosettaNet Connector Record object
RosettaNet Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The RosettaNet Connector Record object contains RosettaNet-specific document information and user-defined tracked field information along with other fields.
📄️ RuntimeProperties object
The RuntimeProperties object lets you manage and configure runtime and system properties, including custom runtime and system properties, across runtimes (basic runtime, runtime cloud, and local cluster).
📄️ RuntimeCloud object
The RuntimeCloud object lets you create, query, update, and delete {conKeyRefs.PLPrivateAtomCloudPrivateRuntimeCloud}.
📄️ Runtime Release Schedule object
The Runtime Release Schedule object allows you to configure a schedule for automatically receiving updates on a {conKeyRefs.AtomRuntime}, {conKeyRefs.UCMoleculeRuntimeCluster}, or {conKeyRefs.UCAtomCloud_RuntimeCloud}.
📄️ Runtime Restart Request object
The Runtime Restart Request object allows you to restart the runtime when performing runtime maintenance or configuration. Restarting runtime is captured in the audit log entries.
📄️ Shared Communication Channel Component object
The Shared Communication Channel Component object allows users to retrieve, query, update, and delete Shared Communication Channel components through the Boomi Enterprise Platform API.
📄️ Shared Server Information object
The Shared Server Information object provides information about the configuration of a {conKeyRefs.UCAtomRuntime}’s shared web server.
📄️ Shared Web Server Object
The Shared Web Server object details the configuration settings for a {conKeyRefs.UCAtomRuntime}'s Shared Web Server. It includes various fields to specify security, performance, and connectivity attributes. The configuration can be managed using GET and UPDATE operations, and the data can be represented in XML or JSON formats.
📄️ Throughput Account Group object
The Throughput Account Group object represents data corresponding to accessible data from the Throughput gadget in the Account Dashboard.
📄️ Throughput Account object
The Throughput Account object represents data corresponding to the data accessible from the Throughput gadget in the Account Dashboard.
📄️ Tradacoms Connector Record object
Tradacoms Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The Tradacoms Connector Record object contains Tradacoms-specific document information and user-defined tracked field information along with other fields.
📄️ Trading Partner Processing Group object
The Trading Partner Processing Group object allows users to retrieve, query, create, update, and delete Processing Group components through the Boomi Enterprise Platform API.
📄️ Trading Partner Component object
The Trading Partner Component object allows users to retrieve, query, create, update, and delete Trading Partner components through the Boomi Enterprise Platform API.
📄️ Worker object
You can use the Worker object to get information about and stop a specific {conKeyRefs.UIAtomWorkerExecutionWorker} attached to a {conKeyRefs.UCAtomCloudRuntimeCloud}.
📄️ Working with the Environment Extensions object
Read about the intricacies of using the Environment Extensions object and learn how to perform such actions as overriding extension values, how the object interprets and returns encrypted fields, and working with extensions for multi-install integration packs.
📄️ X12 Connector Record object
X12 Connector Records correspond to the trading partner details of the Process Reporting page in the user interface. The X12 Connector Record object contains X12-specific document information and user-defined tracked field information along with other fields.
