API objects and object-based operations
The Boomi API Management API exposes several object types on which you can perform specific operations by issuing API calls. These operations are limited to GET (ordinary and bulk), QUERY, CREATE, UPDATE, DELETE, and EXECUTE.
note
For DELETE operations, if your tools do not support sending HTTP DELETE requests, you can use an HTTP GET request with a query string of ?method=DELETE.
For objects that require Runtime Management access, you must have the Runtime Management privilege to perform CREATE, UPDATE, EXECUTE, and DELETE operations. If you have the Runtime Management Read Access privilege, you can perform GET and QUERY operations only.
The following table lists the exposed object types and the allowable operations for each. See the specific object topics to get detailed information about the properties of each one, how to make API calls for each supported operation, and whether the Runtime Management privilege is required.
info
Integration-specific AtomSphere API and Partner REST APIs are also available from the OpenAPI 3.0 specification. Because OpenAPI 3.0 is language agnostic, it enables users to easily discover available Integration API and Partner API objects and actions, test requests and responses, and understand the API's functionality. For more information, see the topic OpenAPI 3.0.
| Object Type | GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|---|
| Account | Supported | Supported | Supported | Not supported | Not supported | Supported |
| AccountCloudAttachmentProperties | Supported | Not supported | Not supported | Supported | Not supported | Not supported |
| AccountCloudAttachmentQuota | Supported | Not supported | Supported | Supported | Not supported | Supported |
| AccountGroup object | Supported | Supported | Supported | Supported | Not supported | Not supported |
| AccountGroupAccount object | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| AccountGroupUserRole object | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| AccountSSOConfig object | Supported | Not supported | Not supported | Supported | Not supported | Supported |
| AccountUserFederation object | Not supported | Supported | Supported | Supported | Not supported | Supported |
| AccountUserRole object | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| APIUsageCount object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| AS2ConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| Atom object | Supported | Supported | Supported | Supported | Not supported | Supported |
| AtomConnectionFieldExtensionSummary (Deprecated) | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| AtomConnectorVersions object | Supported | Not supported | Not supported | Not supported | Not supported | Not supported |
| AtomCounters object | Supported | Not supported | Not supported | Supported | Not supported | Not supported |
| AtomDiskSpace object | Supported | Not supported | Not supported | Not supported | Not supported | Not supported |
| AtomExtensions object(Deprecated) | Supported | Supported | Not supported | Supported | Not supported | Not supported |
| AtomMapExtension object (Deprecated) | Supported | Not supported | Not supported | Supported | Supported | Not supported |
| AtomMapExtensionsSummary object (Deprecated) | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| AtomSecurityPolicies object | Supported | Not supported | Not supported | Supported | Not supported | Not supported |
| AtomStartupProperties | Supported | Not supported | Not supported | Not supported | Not supported | Not supported |
| AuditLog object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| Cloud object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| Component object | Supported | Not supported | Supported | Supported | Not supported | Not supported |
| ComponentAtomAttachment object (Legacy deployment, Deprecated) | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| ComponentEnvironmentAttachment object (Legacy deployment, Deprecated) | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| ComponentMetadata object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| ComponentReference object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| Connector object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| CustomTrackedField object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| DeployedExpiredCertificate object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| DeployedPackage object | Supported | Supported | Supported | Not supported | Not supported | Supported |
| Deployment object (Legacy deployment, Deprecated) | Supported | Supported | Supported | Not supported | Not supported | Not supported |
| DocumentCountAccount object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| DocumentCountAccountGroup object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| EDICustomConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| EDIFACTConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| Environment object | Supported | Supported | Supported | Supported | Not supported | Supported |
| EnvironmentAtomAttachment object | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| EnvironmentConnection FieldExtensionSummary | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| EnvironmentExtensions object | Supported | Supported | Not supported | Supported | Not supported | Not supported |
| EnvironmentMapExtension object | Supported | Not supported | Not supported | Supported | Supported | Not supported |
| EnvironmentMapExtensions ExternalComponents | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| EnvironmentMapExtensionsSummary | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| EnvironmentMapExtension UserDefinedFunction | Supported | Supported | Supported | Supported | Not supported | Supported |
| EnvironmentMapExtensionUser DefinedFunctionSummary | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| EnvironmentRole object | Supported | Supported | Supported | Not supported | Not supported | Supported |
| Event object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| ExecutionConnector object | Supported | Not supported | Supported | Not supported | Not supported | Not supported |
| ExecutionCountAccount object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| ExecutionCountAccountGroup object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| ExecutionRecord object | Supported | Supported | Supported | Supported | Not supported | Not supported |
| ExecutionRequest object | Not supported | Not supported | Supported | Not supported | Not supported | Not supported |
| ExecutionSummaryRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| Folder object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| GenericConnectorRecord object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| HL7ConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| InstallerToken object | Not supported | Not supported | Supported | Not supported | Not supported | Not supported |
| IntegrationPack object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| IntegrationPackAtomAttachment object (Deprecated) | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| IntegrationPackEnvironmentAttachment | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| IntegrationPackInstance object | Supported | Supported | Supported | Not supported | Not supported | Supported |
| ListenerStatus object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| NodeOffboard object | Not supported | Not supported | Supported | Not supported | Not supported | Not supported |
| OrganizationComponent object | Supported | Supported | Supported | Supported | Not supported | Supported |
| PackagedComponent object | Supported | Supported | Supported | Not supported | Not supported | Not supported |
| PackagedComponentManifest object | Supported | Not supported | Not supported | Not supported | Not supported | Not supported |
| PersistedProcessProperties object | Supported | Not supported | Not supported | Supported | Not supported | Not supported |
| Process object | Supported | Supported | Not supported | Not supported | Not supported | Not supported |
| ProcessAtomAttachment object (Legacy deployment, Deprecated) | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| ProcessEnvironmentAttachment (Legacy deployment, Deprecated) | Not supported | Supported | Supported | Not supported | Not supported | Supported |
| ProcessSchedules object | Supported | Supported | Not supported | Supported | Not supported | Not supported |
| ProcessScheduleStatus object | Supported | Supported | Not supported | Supported | Not supported | Not supported |
| Role object | Supported | Supported | Supported | Supported | Not supported | Supported |
| RosettaNetConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| RuntimeReleaseSchedule object | Supported | Not supported | Supported | Supported | Not supported | Supported |
| SharedServerInformation object | Supported | Not supported | Not supported | Supported | Not supported | Not supported |
| SharedWebServer object | Supported | Not supported | Not supported | Supported | Not supported | Not supported |
| ThroughputAccount object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| ThroughputAccountGroup object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| TradacomsConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
| TradingPartnerComponent object | Supported | Supported | Supported | Supported | Not supported | Supported |
| TradingPartnerProcessingGroup object | Supported | Supported | Supported | Supported | Not supported | Supported |
| X12ConnectorRecord object | Not supported | Supported | Not supported | Not supported | Not supported | Not supported |
