{
"openapi": "3.0.1",
"info": {
"title": "Boomi Enterprise Platform REST API Reference",
"description": "Download OpenAPI Specification: Download \n\n # Introduction \n The Boomi Platform API provides programmatic access to the Boomi Enterprise Platform functionality. These APIs allow for control of many objects associated with your account. \n\n ## Platform API \n The Boomi Platform API provides programmatic access to the Boomi Enterprise Platform functionality.\n The API is built around an object/verb hierarchy. This hierarchy parallels the basic object-oriented programming paradigm as well as the web service implementation behind [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer).\n\n- Objects represent structures and relationships within the Enterprise platform, such as Account, Account User Role, Atom Startup Properties, and Environment.\n\n- Verbs are the operations performed for each object, such as GET, QUERY, and UPDATE. These verbs are object-based operations. Verbs that do not fall into the object/verb hierarchy, such as executeProcess, are action-based operations.\n\nAll Platform API calls use an API token or user name for authentication and an account ID associated with an active account. For any API call, the account ID is the general context. For example, suppose you make an API call to run a QUERY of the Account Groups object without applying query filters. In that case, the query returns all account groups owned by the authenticated account. If you are using single sign-on, you need to use an [API token](https://help.boomi.com/docs/Atomsphere/Platform/int-AtomSphere_API_Tokens_page_6a75a1f6-709c-4b08-b3bd-85fe2ac02e18) to authenticate.\n\nBoomi developed the API RESTish and SOAP implementations.\n\n>**Note:** Integration also provides: \n >- The Platform Partner API, which supports additional partner-specific operations. \n >- The Platform API and Platform Partner API connectors, which enable you to perform API object-based operations and actions within your integration processes.\n\n### Implementation\n\n All RESTish API endpoint URLs begin with the prefix: \n\n For North American Platform accounts:\n\n ```shell\nhttps://api.boomi.com/api/rest/v1/{accountID}\n```\n\nFor European Platform accounts, the base URL is:\n\n```shell\nhttps://api.platform.gb.boomi.com/api/rest/v1/{accountID}\n```\n\nwhere `accountID` is your account ID. The complete endpoint URL depends on the operation you are trying to perform. The description of each associated API object-based operation provides complete URLs in addition to action topics within this Help guide.\n\n>**Note:** Integration-specific Boomi Platform 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. \n\n HTTP Basic Authentication protects RESTish requests, requiring either your [Platform API token](https://help.boomi.com/docs/Atomsphere/Platform/int-AtomSphere_API_Tokens_page_6a75a1f6-709c-4b08-b3bd-85fe2ac02e18) or user name and password credentials.\n\nRequest and response bodies for RESTish requests are XML by default. The XML schema, which is the same for both the RESTish API and the SOAP API, is located at:\n\nFor North American Platform accounts:\n\n```shell\nhttps://api.boomi.com/api/soap/v1/{accountID}?xsd=1\n```\n\nFor European Platform accounts:\n\n```shell\nhttps://api.platform.gb.boomi.com/api/soap/v1/{accountID}?xsd=1\n```\n\nYou can use JSON-formatted request bodies in RESTish calls by sending the request with the HTTP header `Content-Type: application/json`. To receive JSON-formatted responses, send the request with the HTTP header `Accept: application/json`.\n\nYou can configure CORS \\(Cross-Origin Resource Sharing\\) request matching rules for your account to enable cross-server, JavaScript-powered RESTish requests.\n\n## Partner API \n\nThe Boomi Platform Partner API provides partners with programmatic access to the secondary accounts that they manage.\n\nThe Partner API shares many of the same implementation details as the standard Boomi Enterprise Platform API. The main differences between the two APIs are:\n\n- In addition to the standard Platform API operations, the Partner API supports certain operations that are not available in the standard API:\n\n - Account CREATE and DELETE operations\n\n - Cancel Execution and Account Provision operations\n\n- Most Boomi Partner API requests take an optional account override parameter that you can use to override the authenticated account. For a RESTish, implementation the parameter is `overrideAccount`. For SOAP, the parameter is called `accountId`.\n\n The account override parameter enables you to perform a request against the specified account; the override value becomes the effective account that runs the call. For example, if the authenticated account is primary, a request can override the account ID with Sub01 to perform the request on Sub01 rather than primary. Of course, the primary account must be in the hierarchy of the Sub01 account for the request to pass authorization and authentication logic.\n\n >**Note:** The Account CREATE and DELETE operations and the Account Provision operation do not support the account override parameter.\n\nThe Boomi Platform Partner API connector enables partner accounts to perform API object-based operations and actions within their integration processes. You can override the account to which a request applies by defining a process property called `boomiPartnerApi-overrideAccountId` in the Boomi Platform Partner API connector operation.\n\n An optional account property `overrideAccountRateLimit` allows the rate limit to be determined based on the specific account requested, whether it\u2019s a primary or an override account. The application of this rate limit depends on the setting of the `overrideAccountRateLimit` property in the primary account. If this property is enabled, the rate limit defined for the override account will apply. If it is disabled, the rate limit of the primary account will apply. \n\n When you make an API request without specifying the override account, the rate limit of the primary account will apply if the `overrideAccountRateLimit` property is enabled. \n\n >**Note:** Contact your Boomi representative to enable the `overrideAccountRateLimit` feature for your account. \n\n>**Note:** You must explicitly enable access to the Boomi Partner API. Contact your representative to allow the Partner API for your account.\n\n>**Note:** The RESTish implementation of the Partner API uses the standard Boomi Platform API namespace for both structure and objects.\n\n### Partner API implementation \n\n#### REST\n\nMost Partner API RESTish requests take an optional account ID parameter that you can use to set the effective account. In addition, it adds the account override parameter to each request as a query string parameter called `overrideAccount`.\n\nThe following two code samples illustrate the difference between the Boomi Platform API GET request and the Partner API GET request for a Deployment object.\n\n**Platform API GET**\n\nFor North American Platform accounts:\n\n```powershell\nhttps://api.boomi.com/api/rest/v1/{YOUR_ACCOUNT_ID}/Deployment/XXXXX\n```\n\nFor European Platform accounts:\n\n```powershell\nhttps://api.platform.gb.boomi.com/api/rest/v1/{YOUR_ACCOUNT_ID}/Deployment/XXXXX\n```\n\n**Partner API GET**\n\nFor North American Platform accounts:\n\n```powershell\nhttps://api.boomi.com/partner/api/rest/v1/{YOUR_ACCOUNT_ID}/Deployment/XXXXX?overrideAccount=OVERRIDE_ACCOUNT_ID\n```\n\nFor European Platform accounts:\n\n```powershell\nhttps://api.platform.gb.boomi.com/partner/api/rest/v1/{YOUR_ACCOUNT_ID}/Deployment/XXXXX?overrideAccount=OVERRIDE_ACCOUNT_ID\n```\n>**Note:** For all requests, the structure of responses from the Boomi Platform API and the Partner API are the same.\n\n>**Note:** Integration-specific Boomi Platform 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. \n\n To checkout the partner specific APIs, refer to the topic [Platform Partner API Reference](https://developer.boomi.com/docs/APIs/PlatformPartnerAPI/APIReference/Platform_Partner_APIs_Overview).\n\n\n## Platform API and Partner API authentication\n\nReview the different authentication methods that users can employ to successfully make calls to the Boomi Platform API and Boomi Platform Partner API.\n\n### User name and password credentials\n\nSingle sign-on \\(SSO\\) Administration users and regular users \\(non-SSO\\) can authenticate calls to the Boomi Platform and Partner APIs using their user name and password credentials in a Basic Auth type authorization.\n\n### Platform API tokens\n\nIf single sign-on \\(SSO\\) users do not have Administrator privileges, they must use API tokens to authenticate any Boomi Platform or Partner API calls. Similarly, users that enable two-factor authentication \\(2FA\\) on their accounts can authenticate their API calls using a single API token rather than manually entering individual authentication codes per API call.\n\n>**Note:** Regular non-SSO users and administrators who use SSO can also use API tokens to authenticate their APIs. They must follow the same instructions for using the token's value in the request header described below. For instance, use the API token feature if the user wants to limit API calls to a specific account.\n\n\n\nUsers generate API tokens for their account from the **Settings** > **Account Information and Setup** > **Platform API Tokens** page and use the token's value in place of a password:\n\n- When making manual calls to the Boomi Platform or Partner APIs, users must enter the API token value within the password field of a Basic Auth type authorization. In addition, the user name value must be the Boomi Platform user name authenticating the request and be in the form of `BOOMI_TOKEN.`.\n\n- When making automatic calls to the Boomi Platform or Partner APIs, users must replace the `` value in the Basic Auth header with `BOOMI_TOKEN.:`.\n\n For example, the following shows a user using an API token to authenticate a GET request made to the Audit Log object:\n\n For North American Platform accounts:\n\n ```powershell\n curl --user \"BOOMI_TOKEN.user@boomi.com:123aab45-67b8-9012-3a45-67c8e9e01e23\" --request GET 'https://api.boomi.com/api/rest/v1/account123/AuditLog/documentId-321' \n ```\n\n For European Platform accounts:\n\n ```powershell\n curl --user \"BOOMI_TOKEN.user@boomi.com:123aab45-67b8-9012-3a45-67c8e9e01e23\" --request GET 'https://api.platform.gb.boomi.com/api/rest/v1/account123/AuditLog/documentId-321' \n ```\n \nFor North American Platform accounts:\n\n```powershell\nhttps://api.boomi.com/api/rest/v1/{YOUR_ACCOUNT_ID}/Deployment/XXXXX\n```\n\nFor European Platform accounts:\n\n```powershell\nhttps://api.platform.gb.boomi.com/api/rest/v1/{YOUR_ACCOUNT_ID}/Deployment/XXXXX\n```\n\nFor more information about API tokens and how to add them to your account, refer to the topic [API Tokens](https://help.boomi.com/docs/Atomsphere/Platform/int-AtomSphere_API_Tokens_page_6a75a1f6-709c-4b08-b3bd-85fe2ac02e18).\n\n### Two-factor authentication\n\nAs described in the previous section, you can generate and use an API token to make calls from accounts enabled with 2FA. For any calls that you wish to automate, encourages you to use API tokens.\n\nIn some cases, however, you may be making less frequent, ad-hoc calls and do not require the automation benefits that a token provides. For such calls, simply include X-Boomi-OTP as an HTTP header and set the time-based one-time password \\(TOTP\\) authentication code as its value. For more information about 2FA, refer to the topic [Two-factor authentication](https://help.boomi.com/docs/Atomsphere/Platform/c-atm-Two-factor_authentication_b539d687-2384-4d0c-8f17-75e066e9269a) and all related subtopics.\n\n### JWT authentication tokens\n\nYou can generate a JWT token to use JWT to authenticate calls to certain Boomi Platform APIs, the Boomi Data Hub Repository API, and GraphQL APIs.\n\nTo generate a JWT token, you must use HTTP Basic authentication and provide your Boomi Enterprise Platform account username and password in a GET request to the Boomi Platform API.\n\nSend a GET request to `https://api.boomi.com/auth/jwt/generate/{accountId}` for North American Platform accounts (or `https://api.platform.gb.boomi.com/auth/jwt/generate/{accountId}` for European Platform accounts), where `{accountId}` is the ID of the authenticating accout for the request. You can obtain your Enterprise Platform account information in **Settings \\> User Information \\> Account Information**.\n\n>**Note:** JWT tokens expire after 5 minutes. If you make a request with an expired token, you will receive a 401 error.\n\n## OpenAPI 3.0\n\nOpenAPI 3.0 \\(formerly Swagger Specification\\) is an API specification available for Boomi Enterprise Platform and Partner REST APIs within the service.\n\nThe [OpenAPI 3.0 Specification](https://swagger.io/specification/) \\(OAS\\) enables clients to more easily use and understand Boomi's REST APIs. Because of its language-agnostic interface, clients can use the OpenAPI specification \\(OAS\\) with common API tools to programmatically discover available Boomi Platform API and Partner API endpoints. Users can also generate sample requests and responses based on a refined schema and more easily explore and test APIs using common tooling without needing to reference complex code or additional help documentation. The ease and accuracy of OAS documentation also allows you to detect defects early in your development cycle and alleviates strain on your continuous integration pipeline.\n\n### Using OAS with common API tools\n\nYou can easily access OpenAPI 3.0 documentation for Integration's platform and Partner APIs using any tool of your choosing, such as Postman. Use the following general instructions to import the available Boomi Platform API and Partner API collection to your specific tool:\n\n1. Open an API tool, such as Postman.\n2. Click **File** \\> **Import**.\n3. Click the **Link** tab.\n4. From your API tool, do one of the following:\n\n a. To make calls to an Boomi Enterprise Platform API, copy and paste `https://api.boomi.com/api/rest/v1//openapi.json` for North American Platform accounts (or `https://api.platform.gb.boomi.com/api/rest/v1//openapi.json` for European Platform accounts) into the URL field.\n\n b. To make calls to a Partner API, copy and paste `https://api.boomi.com/partner/api/rest/v1//openapi.json` for North American Platform accounts (or `https://api.platform.gb.boomi.com/partner/api/rest/v1//openapi.json` for European Platform accounts) into the URL field where `` is the account ID.\n\n5. Replace `` in the URL with the ID of the authenticating account from which you want to make requests.\n6. Click **Continue**.\n7. Under **Show Advanced Settings**, optionally change the **Folder Organization** selection to **Tags**.\n8. Click **Import**. This actions adds Boomi Platform APIs or Partner APIs to your collection.\n9. Open the **Collections** tab of your tool and select your new collection, titled either Boomi Platform API or Partner API. From here, you can enter your credentials to globally apply authentication to all requests within that collection.\n\n a. Under the **Authorization** tab, select **Basic Auth** as the authentication type and enter your sign-in credentials.\n\n b. If you are using a Boomi Enterprise Platform API token instead, enter `BOOMI_TOKEN.` in the **Username** field and the API token in the **Password** field.\n\n c. If you want to grant different account permission to the collection, change the values of the **Username** and **Password** fields in the **Authorization** tab. Then, under the **Variables** tab, modify the **CURRENT VALUE** field with the new account ID. \n\n >**Note:** You must use an API token if you enable your account with two-factor authentication \\(2FA\\) or single sign-on \\(SSO\\). \n\n 10. In your new collection, you can refer to the list of available APIs and expand them to view their available operations.\n11. Test out an API object and configure URL and request parameters as appropriate. Click **Send** and view the results.\n\n\n## API errors \n\nThe Platform API and the Partner API return standard HTTP status codes or SOAP fault codes to indicate the success or failure of an API request.\n\nprovides standard HTTP status codes and clear messaging to help you identify and correct potential errors with your API call. Boomi Platform API and Partner APIs return the following potential error statuses.\n\n### 2xx Success \n\nThe Platform API or Partner API returns 200-type statuses when the call is successful. However, some success statuses can also indicate additional complications that you must address:\n\n- **200**\u2014The request is successful.\n- **202**\u2014 The request did not finish processing and requires more wait time. Clients typically encounter this status in the context of asynchronous APIs.\n- **204**\u2014 There is a successful exchange between client and server, but there is no content or data at the requested URL. For example, the client encounters a 204 code in the second half of an asynchronous API after retrieving the content successfully or deleting the content automatically after 30 minutes. \n\n ### 3xx Redirection \n\n The Platform API or Partner API returns 300-type statuses when a retired API object is no longer available for use and there exists a replacement URL pointing to the newer functionality: \n\n - **301**\u2014 This and all future requests should be directed to the given URI. The request method can change, such as from a GET to a POST request.\n - **308**\u2015 Similar to 301, all future requests should be redirected to the given URL. However, 308 doesn't allow the HTTP method to change. The user must repeat the exact same request method as the original request. \n\n### 4xx Client request issues \n\nThe Platform API or Partner API returns 400-type statuses when the client does not correct authentication or permissions to complete the call. The following list describes the various 400-type statuses one may receive.\n\n- **400**\u2014 The server was unable to proceed with the request, most likely due to bad syntax in the request URL or body. To fix these errors, ensure that the request or endpoint URL is properly formed. Refer to the documentation for your particular API object or operation for specific call examples. \n - **401**\u2014 You cannot be authenticated due to bad credentials for the target resource. Ensure that you're using valid user ID and password. \n- **403**\u2014 You're authenticated but not authorized or doesn\u2019t have permissions to perform the requested action. If you encounter a 403 error, check that you have correct permissions and authorized access to the account specified in the API endpoint.\n- **404**\u2014 Made a call to an API endpoint that does not exist. Ensure that the endpoint URL points to a valid API or that there is a properly formed request body.\n- **410**\u2014 The API is retired or the specified Runtime is currently offline.\n\n### 5xx Service Unavailable \n\nThe Platform API or Boomi Partner API returns 500-type statuses when the API cannot complete the call due to a service interruption. The following list describes the various 500-type statuses one may receive.\n\n- **503**\u2014 The server is too busy or the client exceeded the allotted rate limit. Have the client try again later.\n- **504**\u2014 The client cannot reach the Runtime or the server at this time. Have the client try again later.\n\n### Sample response\n\nFor errors encountered during a REST request, an error message is returned along with the appropriate HTTP status code. The following is an example error message for which the HTTP status code is either 400 \\(indicating an error with the clients request\\) or 500 \\(indicating a server error\\).\n\n\nXML response: \n\n ```xml\n\n ERROR_MESSAGE \n \n``` \n \n\n \nJSON response: \n\n ```JSON \n {\n \"error\": {\n \"message\": \"ERROR_MESSAGE\"\n }\n}\n``` \n\n \n\n## API connectors\n\nThe Platform API connector and Platform Partner API connector enable you to perform API object-based operations and actions within your integration processes.\n\nThe design of the API connectors connect seamlessly with the Platform. Integrating with the platform consists of web service calls utilizing a SOAP request and response setup over an HTTPS connection. The technical details of this connection, such as request headers, error handling, and HTTPS connection, are all abstracted to simplify your implementation.\n\nThe object-based operations and actions available in the Boomi Platform API connector and Boomi Platform Partner API connector are the same as those in the equivalent API.\n\nUsing an API connector in an integration process can make working with the underlying API easier. The API connectors:\n\n- Allow you to select from a list of available objects and actions.\n\n- Provide an expression builder for creating query filters.\n\n- Handle query paging for you by using the `queryMore` token automatically. As a result, the API connectors do not limit the number of records returned by a Query request.\n\n- Detect API response errors automatically, and either fail a document or set the Application Status Code document property accordingly.\n\n- Handle HTTP 503 Service Unavailable errors automatically by retrying a request up to five times. HTTP 503 errors can result from an account exceeding its API usage limit, such as five requests per second. Retrying the request at a different time might resolve the issue.\n\n>**Note:** Deploying a Platform API connector or Platform Partner API connector does not affect your license count. You can deploy these API connectors unlimited times across different Runtimes and environments.\n\n\nThe Platform Partner API connector, like the Partner API itself, provides Boomi Platform partners with programmatic access to the subaccounts that they manage. As a partner, you can override the account to which a request applies by defining a process property called `boomiPartnerApi-overrideAccountId` in the connector operation.\n\nFor the following API operations, use the Boomi Platform Partner API connector rather than the Platform API connector:\n\n- Account Group operations\n- Account Group Account operations\n- Account Group User Role operations\n- Cancel execution operation\n- Provision Partner Customer Account operation\n\n\n## Bulk GET operations \n\nThe bulk GET operation returns a maximum of 100 multiple API objects based on the supplied object IDs.\n\nMost Boomi Platform API objects that support the ordinary GET operation also support a bulk GET operation. With a bulk GET operation, you specify the object type and up to 100 object IDs. The operation returns all objects having the specified IDs.\n\nThe following example bulk GET requests are for the Process object.\n\n### Implementation \n\nSend an HTTP POST to:\n\nFor North American Platform accounts:\n\n```powershell\nhttps://api.boomi.com/api/rest/v1/{accountId}/Process/bulk\n```\n\nFor European Platform accounts:\n\n```powershell\nhttps://api.platform.gb.boomi.com/api/rest/v1/{accountId}/Process/bulk\n```\n\nwhere `accountId` is the ID of the authenticating account for the request.\n\nNote that a specific process ID is replaced with the word `bulk` in the endpoint URL.\n\n\n XML request \n \n \n \n \n \n\n\n XML response \n \n \n \n \n \n \n \n\nFor a JSON request, send the request with the following HTTP header:\n\n`Content-Type: application/json`\n\n\n JSON request \n\nFor a JSON response, send the request with the following HTTP header:\n\n`Accept: application/json`\n\n\n JSON response \n\n\n\n## Bulk UPDATE operations\n\nThe Bulk UPDATE operation updates multiple API objects based on the supplied object IDs.\n\nWith a Bulk UPDATE operation, you specify the object type and up to a specific number of object IDs. The operation updates all objects having the specified IDs.\n\n\n>**Note:** Typically, the Bulk UPDATE operation can apply updates up to 100 object IDs. However, only the Process Schedules object currently supports the Bulk UPDATE operation and is limited to 15 objects.\n\nThe following example Bulk UPDATE requests are for the Process Schedules object.\n\n### Implementation\n\n**UPDATE operation**\n\nSend an HTTP POST to:\n\nFor North American Platform accounts:\n\n```powershell\nhttps://api.boomi.com/api/rest/v1/{accountId}/ProcessSchedules/bulk\n```\n\nFor European Platform accounts:\n\n```powershell\nhttps://api.platform.gb.boomi.com/api/rest/v1/{accountId}/ProcessSchedules/bulk\n```\n\nwhere `accountId` is the ID of the authenticating account for the request.\n\nFor a JSON request, send the request with the following HTTP header:\n\n```json\nContent-Type: application/json\n```\n\n\n JSON request \n\nFor a JSON response, send the request with the following HTTP header:\n\n```json\nAccept: application/json\n```\n\n\n JSON response \n\n\n XML request \n \n \n \n \n \n \n \n \n \n \n \n\n\n XML response \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n## Query filters \n\nQUERY filters let you use API object fields and a range of operators to customize the results of a request.\n\nThe flexible structure of QUERY filters allows you to perform complex queries. You can compose a query filter with simple expressions and by grouping expressions.\n\n### Simple expressions in query filters \n\nA simple expression consists of:\n\n- A property, or field, whose value is to be tested\n\n- An operator, which describes the type of comparison to perform\n\n- Zero or more arguments\n\n\nThe following table lists all available operators and the acceptable number of arguments. Refer to the specific API object topics for information about what fields you can use as query filters and the allowed operators for that object.\n\n|Operator|Description|Number of Arguments|\n|--------|-----------|-------------------|\n|EQUALS|Equal To|1|\n|LIKE|Like|1|\n|NOT\\_EQUALS|Not Equal To|1|\n|IS\\_NULL|Is Null|0|\n|IS\\_NOT\\_NULL|Is Not Null|0|\n|STARTS\\_WITH|Starts With|1|\n|BETWEEN|Between|2|\n|GREATER\\_THAN|Greater Than|1|\n|GREATER\\_THAN\\_OR\\_EQUAL|Greater Than Or Equal|1|\n|LESS\\_THAN|Less Than|1|\n|LESS\\_THAN\\_OR\\_EQUAL|Less Than Or Equal|1|\n\n #### JSON sample paylod requests \n\n \nEQUALS/NOT_EQUALS \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"argument\": [\n \"000b7e59-8dd6-4219-9be6-8d31512f0b66\"\n ],\n \"operator\": \"EQUALS/NOT_EQUALS\",\n \"property\": \"componentId\"\n }\n }\n}\n```\n\n \n\nIS_NULL/IS_NOT_NULL \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"nestedExpression\": [\n {\n \"operator\": \"IS_NULL\",\n \"property\": \"componentId\"\n }\n ]\n }\n }\n}\n```\n\n \n\nCONTAINS/NOT_CONTAINS \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"argument\": [\n \"main\"\n ],\n \"operator\": \"CONTAINS/NOT_CONTAINS\",\n \"property\": \"branchName\"\n }\n }\n}\n```\n\n \n\nBETWEEN \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"operator\": \"and\",\n \"nestedExpression\": [\n {\n \"argument\": [\n \"1\", \"10\"\n ],\n \"operator\": \"BETWEEN\",\n \"property\": \"copiedFromComponentVersion\"\n },\n {\n \"argument\": [\n \"000b7e59-8dd6-4219-9be6-8d31512f0b66\"\n ],\n \"operator\": \"EQUALS\",\n \"property\": \"copiedFromComponentId\"\n }\n ]\n }\n }\n}\n```\n\n \n\nLIKE/NOT_LIKE \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"argument\": [\n \"Dum%\"\n ],\n \"operator\": \"LIKE/NOT_LIKE\",\n \"property\": \"branchName\"\n }\n }\n}\n```\n\n \n\nGREATER_THAN/LESS_THAN \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"operator\": \"and\",\n \"nestedExpression\": [\n {\n \"argument\": [\n \"1\"\n ],\n \"operator\": \"GREATER_THAN/LESS_THAN\",\n \"property\": \"copiedFromComponentVersion\"\n },\n {\n \"argument\": [\n \"000b7e59-8dd6-4219-9be6-8d31512f0b66\"\n ],\n \"operator\": \"EQUALS\",\n \"property\": \"copiedFromComponentId\"\n }\n ]\n }\n }\n}\n```\n\n \n\nGREATER_THAN_OR_EQUAL/LESS_THAN_OR_EQUAL \n\n```JSON\n{\n \"QueryFilter\": {\n \"expression\": {\n \"operator\": \"and\",\n \"nestedExpression\": [\n {\n \"argument\": [\n \"1\"\n ],\n \"operator\": \"GREATER_THAN_OR_EQUAL/LESS_THAN_OR_EQUAL\",\n \"property\": \"copiedFromComponentVersion\"\n },\n {\n \"argument\": [\n \"000b7e59-8dd6-4219-9be6-8d31512f0b66\"\n ],\n \"operator\": \"EQUALS\",\n \"property\": \"copiedFromComponentId\"\n }\n ]\n }\n }\n}\n``` \n \n \n\n\nEQUALS/NOT_EQUALS \n\n```xml\n\n\n \n \n 5fc2d133-0e07-4f6a-b4e3-c350b3b3fdaf \n \n \n \n```\n \n\n\nIS_NULL/IS_NOT_NULL \n\n```xml\n\n\n \n \n \n \n \n```\n \n\n\nCONTAINS/NOT_CONTAINS \n\n```xml\n\n\n \n \n 5fc2d133-0e07-4f6a-b4e3-c350b3b3fdaf \n \n \n \n```\n \n\n\nBETWEEN \n\n```xml\n\n\n \n \n \n 123 \n \n \n 456 \n 789 \n \n \n 123 \n \n \n \n \n```\n \n\n\nLIKE/NOT_LIKE \n\n```xml\n\n\n \n \n main% \n \n \n \n```\n \n\n\nGREATER_THAN/LESS_THAN \n\n```xml\n\n\n \n \n 5fc2d133-0e07-4f6a-b4e3-c350b3b3fdaf \n \n \n \n```\n \n\n\nGREATER_THAN_OR_EQUAL/LESS_THAN_OR_EQUAL \n\n```xml\n\n\n \n \n 5fc2d133-0e07-4f6a-b4e3-c350b3b3fdaf \n \n \n \n```\n\n \n\n\n JSON \n\n \n {\n \"QueryFilter\": {\n \"expression\": {\n \"operator\": \"and\",\n \"nestedExpression\": [\n {\n \"argument\" : [\"123\"],\n \"operator\":\"EQUALS\",\n \"property\":\"ABC\"\n },\n {\n \"argument\" : [\"456\", \"789\"],\n \"operator\":\"BETWEEN\",\n \"property\":\"DEF\"\n },\n {\n \"operator\":\"and\",\n \"nestedExpression\": [\n {\n \"argument\" : [\"123\"],\n \"operator\":\"GREATER_THAN\",\n \"property\":\"GHI\"\n },\n {\n \"argument\" : [\"0\"],\n \"operator\":\"EQUALS\",\n \"property\":\"JKL\"\n }\n ]\n }\n ]\n }\n }\n }\n \n \n\n\n XML \n \n \n \n \n 123 \n \n \n 456 \n 789 \n \n \n \n 123 \n \n \n 0 \n \n \n \n \n \n\n ## Query paging \n\nQuery paging helps you manage the number of results returned by an Boomi Platform API request.\n\nThe results from QUERY requests are paged to keep the size of responses at acceptable levels. The maximum number of results returned per QUERY response is 100. When there are more than 100 results, the response contains a `queryToken`. You can retrieve additional results by specifying the `queryToken` in a `queryMore` request.\n\n>**Note:** The Platform API connector and Platform Partner API connector handle query paging for you. When you use an API connector in a process, there is no limit to the number of results returned by a Query request.\n\n### REST\n\nThe following is an example of an XML response that contains a `queryToken`:\n\n\n XML \n EXAMPLE_QUERY_TOKEN \n \n \n ...\n \n \n \n ```\n \n\nTo perform the `queryMore` request, send an HTTP POST to:\n\nFor North American Platform accounts:\n\n```powershell\nhttps://api.boomi.com/api/rest/v1/{accountId}/objectType/queryMore\n```\n\nFor European Platform accounts:\n\n```powershell\nhttps://api.platform.gb.boomi.com/api/rest/v1/{accountId}/objectType/queryMore\n```\n\nwhere `accountId` is the ID of the authenticating account for the request and `objectType` is the type of object you are querying \\(such as Account\\).\n\nTo make a `queryMore` request, you need to provide *only the token value as free text* in the body of an XML or JSON request to obtain the next page of results, for example:\n\n\n Request sample \n\n\n \n JSON Response sample \n\n\n\n## Valid time zones\n\nWhen using the Platform API, the following time zones are valid for objects that require a time zone field:\n\n- Pacific/Pago\\_Pago\n- Pacific/Niue\n- Pacific/Honolulu\n- America/Anchorage\n- America/Tijuana\n- America/Los\\_Angeles\n- America/Phoenix\n- America/Denver\n- America/Mexico\\_City\n- America/El\\_Salvador\n- America/Chicago\n- America/Panama\n- America/New\\_York\n- America/Lima\n- America/Indianapolis\n- America/Bogota\n- America/Caracas\n- Atlantic/Bermuda\n- America/Santiago\n- America/Puerto\\_Rico\n- America/Halifax\n- America/St\\_Johns\n- America/Sao\\_Paulo\n- America/Buenos\\_Aires\n- Atlantic/South\\_Georgia\n- Atlantic/Cape\\_Verde\n- GMT\n- Europe/London\n- Europe/Lisbon\n- Europe/Dublin\n- Europe/Rome\n- Europe/Prague\n- Europe/Paris\n- Europe/Brussels\n- Europe/Berlin\n- Europe/Amsterdam\n- Europe/Minsk\n- Europe/Istanbul\n- Europe/Helsinki\n- Europe/Bucharest\n- Europe/Athens\n- Asia/Jerusalem\n- Africa/Johannesburg\n- Africa/Cairo\n- Europe/Moscow\n- Asia/Riyadh\n- Asia/Kuwait\n- Asia/Baghdad\n- Africa/Nairobi\n- Asia/Tehran\n- Asia/Tbilisi\n- Asia/Dubai\n- Asia/Kabul\n- Asia/Yekaterinburg\n- Asia/Tashkent\n- Asia/Karachi\n- Asia/Colombo\n- Asia/Calcutta\n- Asia/Katmandu\n- Asia/Dacca\n- Asia/Rangoon\n- Asia/Saigon\n- Asia/Jakarta\n- Asia/Bangkok\n- Australia/West\n- Asia/Taipei\n- Asia/Singapore\n- Asia/Shanghai\n- Asia/Manila\n- Asia/Kuala\\_Lumpur\n- Asia/Hong\\_Kong\n- Asia/Tokyo\n- Asia/Seoul\n- Australia/North\n- Australia/South\n- Australia/NSW\n- Australia/Queensland\n- Australia/Lord\\_Howe\n- Pacific/Guadalcanal\n- Pacific/Norfolk\n- Pacific/Fiji\n- Pacific/Auckland\n- Asia/Kamchatka\n- Pacific/Chatham\n- Pacific/Tongatapu\n- Pacific/Enderbury\n- Pacific/Kiritimati\n\n\n## CORS rules for RESTish requests \n\nThe Platform API and Partner API support the W3C Cross-Origin Resource Sharing \\(CORS\\) protocol.\n\nSupport for the [CORS](http://www.w3.org/TR/cors/) protocol enables the Platform APIs to circumvent a browser\u2019s same-origin policy, thereby enabling you to implement cross-server, JavaScript-powered API requests.\n\nBy using `Access-Control-...` HTTP headers, CORS essentially allows JavaScript from one origin \\(server\\) to request permission from another origin \\(server\\) to make RESTish API requests.\n\nTo enable CORS requests under a account, you must configure CORS request matching rules for the account on the CORS page \\(**Settings** \\> **Account Information and Setup** \\> **Boomi Platform API** \\> **CORS**\\). Each rule specifies:\n\n- An origin for matching cross-server RESTish API requests under the account. The matching criteria specified for an origin are protocol \\(HTTP or HTTPS\\), originating domain, and originating port. A matching request is one that matches on all criteria.\n\n- The allowed HTTP methods \u2014 GET, POST, DELETE \u2014 for matched requests.\n\n\n### CORS request types \n\nThere are two types of CORS requests:\n\n\n Preflight \n\n >**Note:** Preflight requests are not required for cross-origin requests that can be made from a browser without using CORS, such as an HTML form POST.\n\n\nNormal \n\n## CORS tutorial \n\nFor information about using CORS to implement cross-server, JavaScript-powered user interaction, refer to the topic [CORS tutorial at HTML5Rocks](http://www.html5rocks.com/en/tutorials/cors/).\n\n\n## Account security for CORS \n\nUse the CORS page \\(**Settings** \\> **Account Information and Setup** \\> **Boomi Platform API** \\> **CORS**\\) to configure CORS rules for RESTish requests in the and Partner APIs. \u00a0\n\n### CORS \n\nCORS rules govern the handling of cross-server, JavaScript-powered, RESTish API requests under an account.\n\n\n\n\n\n**Add Origin** \nProvides controls for adding a CORS rule to the list. Each rule specifies:\n\n - An origin for matching cross-server RESTish API requests under the account. The matching criteria specified for an origin are protocol \\(HTTP or HTTPS\\), originating domain, and originating port. A matching request is one that matches on all criteria.\n\n - The allowed HTTP methods \u2014 GET, POST, DELETE \u2014 for matched requests.\n\n **Origin** \nSpecifies the origin in URL syntax:\n\n - Type :// as the delimiter between protocol and domain.\n\n - If you are specifying a port explicitly, type : as the delimiter between domain and port.\n\n\nFor example: https://mydomain.com:8081.\n\nThe default ports are 80 for HTTP and 443 for HTTPS.\n\n The wildcard character \\* is permitted in the domain \u2014 for example, \\*.mydomain.com. However, specifying only \\* \\(to represent any domain\\) is not permitted.\n\n **Allowed Methods** \n Sets the allowable HTTP methods for requests from the specified origin.\n\n **GET** - \nIf selected, GET requests are allowed.\n\n **POST** - \nIf selected, POST requests are allowed.\n \n**DELETE** - \n If selected, DELETE requests are allowed.\n\n Highlighting a rule and clicking the Delete icon **** deletes that rule.\n\n## API versioning and deprecation policy\n\nReview information about the Platform API objects' versioning and statuses, and Boomi's current policy for deprecating API objects.\n\n### API Version status\n\nAn Boomi Platform API object can have one of three statuses indicating its functional state.\n\n- **Generally Available** - A Generally Available API object is active and fully supported.\n\n- **Deprecated** - A deprecated API object is positioned for retirement at a future date. Though the object remains fully supported until its retirement date, Boomi recommends that users take advantage of newer API functionality meant to replace deprecated APIs at their earliest convenience. Operations for deprecated objects provide information in the response headers informing clients of the object\u2019s status as well as deprecation and retirement dates.\n\n- **Retired** - A retired API object is no longer available for use. A feature retires after it is in a deprecated state for some time. Boomi recommends that users take advantage of newer API functionality to replace retired objects before their retirement date. Retired objects return a 410 error code if there is no replacement, or if available, return a 301 or 308 with a replacement URL pointing to the newer functionality.\n\nBoomi communicates deprecation and retirement plans early and often to users. For deprecation time frames, refer to the topic [Boomi feature deprecation process and policy](/docs/GettingStarted/Boomi_feature_deprecation_process_policy).\n\n### Support level per status\n\nReview the levels of account availability and support that are available for each status type.\n\n|\u00a0 | Generally Available | Deprecated | Retired |\n| --- | --- | --- | --- |\n| Account availability | Active and available to all accounts. | Active and available for existing accounts only. New accounts do not have access. | Not available for all accounts. |\n| Service-level agreement \\(SLA\\) and Support | Yes | Yes | No |\n| Available for use in production | Yes | Yes | No |\n| Documentation is supported and available | Yes | Yes | No |\n\n### Deprecation policy\n\nAlthough Boomi works to make new updates to its APIs both non-breaking and backwards compatible, there are times when an API becomes outdated and we must deprecate the API to provide improved functionality to its users. Boomi guarantees full support for deprecated APIs until their retirement date. However, Boomi encourages users to use the new replacement API functionality as soon as possible.\n\nUsers and clients receive deprecation and retirement announcements through a variety of communication channels including but not limited to:\n\n- Monthly release notes\n- API documentation\n- Direct emails\n- Developer blogs\n- API responses \n\n When interacting with deprecated API objects, the response headers may contain the following fields:\n - **Sunset**: The approximate date the API object will be removed.\n - **Warning**: A string describing any warnings related to the API call.\n - **Deprecation**: A string indicating that the API is deprecated, along with the deprecation date.\n - **Link**: A hyperlink providing more details about the deprecation of this object.\n\n Visit the deprecated object's documentation to identify newer object functionality to use instead.\n\nFor more information about Boomi's deprecation policy, refer to the topic [Boomi feature deprecation process and policy](/docs/GettingStarted/Boomi_feature_deprecation_process_policy).\n\n### API versioning\n\nBoomi does not use incremental versioning to indicate updates made to existing Platform API objects. When updating existing Platform API objects, Boomi ensures backward compatibility for clients and does not:\n\n- Rename, remove, or change data types for existing fields\n- Change field validation rules such as adding new, required fields\n- Modify expected response codes\n\nBoomi can modify existing API objects to add new, optional fields without advance notice. In some cases, might make changes to the logic implementation of a deprecated API to work with newer application features, however the API interface remains the same for clients. Boomi documents all changes made to Generally Available and deprecated APIs publicly, and communicates with you in release notes.\n\n### Example API response\n\nThe following example shows the return HTTP response header upon accessing the deprecated endpoint for the Runtime Extensions object. Notice that the response returns headers with the object's original deprecation date, a warning message detailing the object's deprecated status, the link to the object's current documentation, and the object's future retirement \\(sunset\\) date of Saturday, February 13, 2021.\n\n```json\nDeprecation: version =\"1.0\"; date=\"Sat, 12 Oct 2019 04:00:00 GMT\"\nWarning: 299 - \"You are using a deprecated API endpoint. It will remain available until Sat, 13 Feb 2021 05:00:00 GMT. For more information, refer https://developer.boomi.com/docs/APIs/PlatformAPI/DeprecatedAPIs/Atom_Extensions_object .\"\nLink: rel=\"deprecation\" type=\"text/html\"\nSunset: Sat, 13 Feb 2021 05:00:00 GMT\n```\n\nWhen retiring an endpoint and no newer API functionality replaces the object, the retired object returns a 410 error code in the response. When retiring an endpoint and new API functionality is available, the retired object returns a 301 or 308 error code and a link to Documentation detailing the replacement object.\n\n\n## Enabling CORS support for Platform and Partner APIs \n\nEnable CORS support on the CORS page \\(**Settings** \\> **Account Information and Setup** \\> **Boomi Platform API** \\> **CORS**\\).\n\n### Procedure\n\n1. Select **Settings** \\> **Account Information and Setup** and click **CORS** under **Boomi Platform API**.\n\n The CORS page is displayed.\n\n2. Click **Add Origin**.\n\n Controls for specifying a CORS rule appear in the rules list below.\n\n3. In the **Origin** field for the new rule, specify an origin using URL syntax.\n\n Origins are used for matching cross-server RESTish API requests under the account by protocol \\(HTTP or HTTPS\\), originating domain, and originating port.\n\n4. Turn on the check box for each HTTP method \\(GET, POST, DELETE\\) that you want to allow for requests under the account from the specified origin.\n\n5. For each additional CORS rule that you want to specify, repeat steps 2\u20134. \u00a0\n\n6. Click **Save**. \n\n ## Deprecated APIs \n\n Refer to the list of deprecated APIs that are not available in this OpenAPI specification: \n\n [Deprecated Platform APIs](/docs/category/deprecated-apis)",
"contact": {
"name": "Customer Support",
"url": "https://community.boomi.com/s/support",
"email": "support@boomi.com"
},
"license": {
"name": "Boomi API License and Rate Limits",
"url": "/docs/GettingStarted/API_licensing"
},
"version": "1.0.0"
},
"servers": [
{
"url": "https://api.boomi.com/api/rest/v1/{accountId}",
"description": "US - Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.",
"variables": {
"accountId": {
"description": "The Account id to make this request as.",
"default": "platform_account_ID"
}
}
},
{
"url": "https://api.platform.gb.boomi.com/api/rest/v1/{accountId}",
"description": "GB - Boomi Platform API Endpoint URL.",
"variables": {
"accountId": {
"description": "The Account id to make this request as.",
"default": "platform_account_ID"
}
}
}
],
"tags": [
{
"name": "AS2ConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "Account",
"description": "The Account object provides information about an account, including the associated users, connector licensing \n information, and general information. \n >**Note:** The ability to create and delete accounts is available only through the Platform Partner API.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountCloudAttachmentProperties",
"description": "Programmatically get or edit the properties of a Runtime cloud's attachments, such as Runtime cloud and the Runtime that the owner or accounts attached to the Cloud. \n These actions are equivalent to those you can perform from the [Attachment quotas tab](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/r-atm-Attachment_Quotas_tab_4fbc3fff-7aaf-4bbd-a2dc-25d0edb5189c) \\(**Manage** \\> **Cloud Management**\\) in the user interface. \n Retrieving **Account Cloud Attachment Properties** is an asynchronous process: \n 1. Send a GET request that specifies both the account ID and container ID to the Boomi Enterprise Platform. \n 2. The platform returns a token for the specified Runtime cloud. \n 3. Send one or more GET requests that include the token. Retrieving property values does not require a request body. \n 4. The platform returns list of existing property names and values for the given account and Cloud. \n\n Updating Account Cloud Attachment Properties does not require a request token. Therefore, you only need to make one request when updating one or more properties. When modifying properties, send a POST request including only those property names and values in the request body that you wish to modify. \n\n >**Note:** All properties that are eligible for viewing or updating as part of the Account Cloud Attachment Properties object are representative of those described in the topic [Attachment quotas tab](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/r-atm-Attachment_Quotas_tab_4fbc3fff-7aaf-4bbd-a2dc-25d0edb5189c)."
},
{
"name": "AccountCloudAttachmentPropertiesDefault",
"description": "The `AccountCloudAttachmentPropertiesDefault` object lets the runtime cloud owner retrieve and update the default cloud attachment properties for each runtime cloud cluster. \n Retrieving the default cloud attachment properties is an asynchronous process:\n1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform, where {accountId} is the ID of the authenticating account for the request and {runtimeId} is the ID of the runtime cloud cluster.\n2. The platform returns a token.\n3. Send one or more GET requests that include the token.\n4. The platform returns a list of the cloud attachments associated with the runtime cloud cluster.\n\n>**Note:** The runtime cloud cluster and cloud attachments to which you are calling must be online."
},
{
"name": "AccountCloudAttachmentSummary",
"description": "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.\nThe runtime cloud created by the authenticating account must have Cloud Management privileges to access the summary of cloud attachments.\nThe following metadata can be retrieved using the `AccountCloudAttachmentSummary` object:\n- Runtime ID\n- Attachment Instance ID\n- Attachment Account ID\n- Attachment Creation Date\n- Cloud Cluster ID\n- Cloud ID\n"
},
{
"name": "AccountCloudAttachmentQuota",
"description": "Use the Account Cloud Attachment Quota object to programmatically get, create, update, and delete Cloud attachment quotas. \n\n As a Cloud owner, you can designate the number of Runtime attachments you can create in a Cloud for an account, edit a Cloud quota's value to raise or lower the limit, or delete the quota. In addition, you can also retrieve a Cloud's existing attachment quota for a given account. The actions supported in the Account Cloud Attachment Quota object represent those you can perform from the service's **Cloud Properties** tab \\(**Manage** \\> **Cloud Management** page\\) to create, edit, and delete Cloud attachment quotas for a given account."
},
{
"name": "AccountGroup",
"description": "The Account Group object represents an account group. \n For each account group, you can: \n - Retrieve the properties and resources \n - Query by name \n - Create new account groups \n - Update the properties of existing account groups \n\n >**Note:** - To facilitate the operations on this object in an integration process, use the Boomi Enterprise Platform Partner API connector instead of the Boomi Enterprise Platform API connector. \n - Resources information is returned only for the Get operation, not the Query operation.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountGroupAccount",
"description": "The Account Group Account object represents the linkage between an account and an account group. You can query, add, and remove accounts in an account group. \n\n >**Note:** To facilitate these operations on this object in an integration process, use the Platform Partner API connector instead of the Platform API connector.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountGroupUserRole",
"description": "The Account Group User Role object represents the linkage between an user, an account group, and a defined role for the \n primary account. \n\n >**Note:** To facilitate these operations on this object in an integration process, use the Platform Partner API connector instead of the Platform API connector.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountSSOConfig",
"description": "The Account Single Sign-on Configuration object represents the single sign-on options for an account. \n >**Note:** The fields in this object correspond to the controls on the **SSO Options** tab of the **Setup** page.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountUserFederation",
"description": "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.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountUserRole",
"description": "The Account User Role object represents the linkage between an user, the user's account, and a defined role for the account.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "AccountGroupIntegrationPack",
"description": "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.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API Publisher Integration Pack\n- Integration Pack\n- Account Group Management"
},
{
"name": "ApiUsageCount",
"description": "You can use the API Usage Count object to query the number of APIs used in a specific time frame.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "Atom",
"description": "The Atom object represents a Runtime, Runtime cluster, or Runtime cloud (Runtime cloud cluster and Cloud Attachment). \n >**Note:** \n > - Many of the fields in the Atom object correspond to controls in the **Runtime Information** panel of the **Runtime Management** page. \n > - As of April 13, 2024, the `createdBy` field returns in the successful responses of the CREATE, GET, and QUERY operations. It will not be returned for the Runtimes that were created prior to this date.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- OR ATOM_MANAGEMENT_READ_ONLY"
},
{
"name": "AtomAS2Artifacts",
"description": "You can use the Download AS2 Artifacts Log operation to request and download AS2 artifacts logs. \n Because large AS2 artifacts logs can take time to download, the Platform API provides an asynchronous technique for downloading them: \n 1. The client sends an Atom AS2 Artifacts request to the Boomi Enterprise Platform API that specifies the Runtime ID and the date of the logged events. \n 2. The Enterprise platform returns a Log Download object that contains a URL with a unique AS2 artifacts log ID. \n 3. The client opens the URL to download the log. \n \n >**Note:** Purging of the AS2 artifacts logs occurs 30 days after creation. \n You must have the Runtime Management privilege to download AS2 artifacts logs. If you have the Runtime Management Read Access privilege, you cannot perform this action.",
"x-displayName": "Download Atom AS2 artifacts log"
},
{
"name": "AtomConnectionFieldExtensionSummary",
"description": "The Atom Connection Field Extension Summary object is used to obtain the URL for OAuth 2.0 access token generation. \n >CAUTION: \n >The Atom Connection Field Extension Summary object is a deprecated API and should no longer be used. removed non-environment functionality from the , and changed all accounts to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the [Environment Connection Field Extension Summary object](/docs/api/platformapi/EnvironmentConnectionFieldExtensionSummary). For more information about Boomi's API object deprecation status, refer to the topic [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy). \n\n You can programmatically set almost all extensible connection fields for connections used in processes attached to Runtimes through the Atom Extensions endpoint. The only current exception is the accessToken field in a connection that uses OAuth 2.0 authentication. You can obtain the URL for OAuth 2.0 access token generation using a QUERY operation on the Atom Connection Field Extension Summary object. \n\n The URL returned by the operation is valid for up to 15 minutes from the time it is generated. \n\n >**Note:** In an XML response body, the returned URL requires decoding — for example, replacement of each instance of “&” with “&” — for use in the browser.",
"x-displayName": "AtomConnectionFieldExtensionSummary (Legacy deployment, Deprecated)"
},
{
"name": "AtomConnectorVersions",
"description": "The Atom Connector Versions object represents the properties of connectors that are used by a Runtime, Runtime cluster, or Runtime cloud.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- OR ATOM_MANAGEMENT_READ_ONLY"
},
{
"name": "AtomCounters",
"description": "The AtomCounters object represents the counters and their values associated with a particular Runtime. \n The owner of a Runtime, Cloud, or Runtime cluster can retrieve a list of all counters for their container. You can also modify counters' values by adding, changing, or removing a container's counters. The Runtime Counter value should be between 1 and 2147483647. \n\n Retrieving a list of counters is an asynchronous process: \n - The client sends a GET request that specifies a list of all a container's counters to the Boomi Platform. \n - The platform returns a counter token for the specified Runtime, Runtime cluster, or Runtime cloud. \n - The client sends one or more GET requests that include the counter token. \n - The platform returns one of the following: \n - Status code 202 while the request is in progress. \n - Status code 200, with the the list of the Runtime Counters, when the request is complete.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes."
},
{
"name": "AtomDiskSpace",
"description": "As a Cloud owner, you can use the AtomDiskSpace object to retrieve information about the current disk space usage for a given Runtime cloud attachment. \n For monitoring purposes, the AtomDiskSpace object can help you determine how close your account is to the maximum disk space quota set on the **Account Disk Usage** property (**Runtime Management** --> **Cloud Management** --> **Attachment Quotas tab**). \n Retrieving Runtime disk space is an asynchronous process: \n - The client sends a GET request that specifies a container ID to the . \n - The platform returns a token for the specified Runtime cloud. \n - The client sends one or more GET requests that include the token. \n - The platform returns one of the following: \n - Status code 202 while the request is in progress. \n - Status code 200 with the custom contents of the token when the request is complete."
},
{
"name": "AtomLog",
"description": "You can use this operation to request and download Runtime logs. \n Because large Runtime logs can take some time to download, the Platform API provides an asynchronous technique for downloading Runtime logs: \n 1. You send a Runtime Log request to the Boomi Enterprise Platform API that specifies the Runtime ID and the date of the logged events. \n 2. The Enterprise platform returns a Log Download object that contains a URL with a unique Runtime log ID. \n 3. You open the URL to download the log. \n >**Note:** \n Runtime logs purge 30 days after creation. \n \n You must have the Runtime Management privilege to download Runtime logs. If you have the Runtime Management Read Access privilege, you cannot perform this action.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- User should have access to the container.",
"x-displayName": "Download Atom log"
},
{
"name": "AtomPurge",
"description": "You can use the Purge Atom 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. \n You can use the Purge Runtime cloud attachment operation for any Runtime cloud attachment. You must be a Cloud owner and have the **Runtime Management** privilege to use the this operation. \n The Purge Atom Cloud attachment operation works the same as a purge schedule, starting the process according to any of the following properties specified in the **Properties** and the **Account Properties**(**Advanced** tab) panels of Runtime Management: \n - **Purge History After X Days** \n - **Purge Schedule for Components** \n - **Purge Schedule for Logs** \n - **Purge Schedule for Processed Documents** \n - **Purge Schedule for Temporary Data** \n This operation honors existing purge schedule settings defined in the Integration user interface. For example, suppose that the **Purge History After X Days** property is set to seven days. If you run the Purge Atom Cloud attachment operation, it only deletes files that are older than seven days. If the operation does not find any files that match this criterion, it does not purge any files.",
"x-displayName": "Purge Atom Cloud attachment"
},
{
"name": "AtomSecurityPolicies",
"description": "The Atom Security Policies object represents custom updates to the current Java Virtual Machine (JVM) HIGH security policy for a Runtime cloud or a Runtime cluster with forked execution enabled. \n As the owner of a Runtime cloud or Runtime cluster, you can retrieve any custom updates to the HIGH security policy for your container. You can also update the policy by adding, changing, or removing custom runtime permissions. \n Refer to the topic [Security policies for Clouds and Runtime clusters](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/c-atm-Security_policies_for_Clouds_and_Molecules_19d244bf-2cab-45a8-8d8e-49ebde3eddc7) for more information. \n Retrieving a security policy is an asynchronous process: \n - The client sends a GET request that specifies a container ID to the . \n - The platform returns a security policy token for the specified Runtime cloud or Runtime cluster. \n - You send one or more GET requests that include the security policy token. \n - The platform returns one of the following: \n - Status code 202 while the request is in progress. \n - Status code 200 with the custom contents of the security policy when the request is complete.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "AtomStartupProperties",
"description": "The Atom Startup Properties object represents the start-up properties for a Runtime, Runtime cluster, or Runtime cloud. These properties come from the Java virtual machine \\(JVM\\) to which you deploy the Runtime, Runtime cluster, or Runtime cloud. \n The fields in the Atom Startup Properties object correspond to properties listed on the **Startup Properties** panel of the **Runtime Management** page. The specific fields returned depend on the system configuration and can vary from one Runtime to the next. \n >**Note:** This API is not applicable for runtimes attached to clouds. \n\n ### Startup Properties Reference\n\n|Property|Type|Description|\n|-----|----|-----------|\n|atomArch|*string*|The architecture of the Runtime, Runtime cluster, or Runtime cloud — either 64-bit or 32-bit.|\n|atomFreeDiskSpace|*long*|The amount of free disk space, in bytes, on the drive that holds the Runtime, Runtime cluster, or Runtime cloud installation directory. Some systems do not report this information.|\n|atomHome|*string*|The installation directory of the Runtime, Runtime cluster, or Runtime cloud.|\n|atomTimeZone|*string*|The Java timezone for the runtime.|\n|atomType|*string*|The type of runtime (Runtime, Runtime cluster, Cloud). Cloud attachments are not applicable for the API.|\n|containerImageVersion|*string*|The Docker image version for containerized runtimes.|\n|customProcbrowserScript|*string*|The customized procbrowser script file name.|\n|customProcrunnerScript|*string*|The customized procrunner script file name.|\n|customProcworkerScript|*string*|The customized procworker script file name.|\n|customRestartScript|*string*|The customized restart script file name.|\n|fileEncoding|*string*|Default character encoding for data processed by the Runtime, Runtime cluster, or Runtime cloud. Common values are UTF-8, Windows-1252, and US-ASCII.|\n|infrastructureProvider|*string*|The infrastructure provider where the Runtime, Runtime cluster, or Runtime cloud is running. Possible values are: \n\n \n```\n\n| Field | Description |\n| --- | --- |\n| `signatureAlgorithm` | Required. Must not be blank. The values should be SHA512withRSA, SHA384withRSA, SHA256withRSA, SHA224withRSA or SHA1withRSA. If not, API will return an error. |\n| `keyLength` | Required. Must not be blank. The values should be 1024 or 2048. If not, API will return an error. |\n| `Validity` | Required. Must not be blank. The values must be integer and should be in between 1 to 9999. |\n| `passPhrase` | Required. Must not be blank. |\n| `alias` | Required, can be blank. |\n| `commonName`, `organization`, `organizationalUnit`, `locality`, `country` | Required. Must not be blank. |\n\n**Key Generation Response:**\n\n``**\n\n``` ```\n\n- Pass the above key generation response in the `` section of the Component create/update XML, as below by taking any GET response of an existing certificate:\n\n```\n\n```\n\n**``**\n\n``` ```\n\n#### Required Privileges\n\n**Write access**\n\n- Build Read and Write Acccess\n\n**Read access**\n\n- Build Read Access"
},
{
"name": "ComponentDiffRequest",
"description": "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: \n - Insights for auditing and change management \n - Better understanding of changes across component versions \n - Component version insights into external DevOps processes."
},
{
"name": "ComponentAtomAttachment",
"description": "The Component Atom Attachment object enables the attachment or detachment of a component to or from a particular Runtime. \n\n >**Caution:** The Component Atom Attachment (Legacy) object is a deprecated API and should no longer be used. removed the non-environment functionality from the , and all accounts are changed to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the [Component Environment Attachment (Legacy) object](https://developer.boomi.com/docs/api/platformapi/ComponentEnvironmentAttachment) instead. For more information about Boomi's API object deprecation status, refer to the topic [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy).",
"x-displayName": "ComponentAtomAttachment (Legacy deployment, Deprecated)"
},
{
"name": "ComponentEnvironmentAttachment",
"description": "The Component Environment Attachment object enables the attachment or detachment of a component to or from a particular environment. \n\n >**Caution:** The Component Environment Attachment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the [Deployed Package object](https://developer.boomi.com/docs/api/platformapi/DeployedPackage) instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about Boomi's API object deprecation status, refer to the topic [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy). \n\n Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new [Deployment workflow](https://help.boomi.com/docs/Atomsphere/Integration/Deployment/c-atm-Deployment_workflow_c785c476-f1b3-413b-a5a5-57afcc98978f) and [How to upgrade Legacy accounts to use the new deployment workflow](https://help.boomi.com/docs/Atomsphere/Integration/Deployment/int-Enabling_packaged_components_deployment_b134486a-2868-4cd4-868c-a0f108cb8d7e).\n\n In the meantime, do not use the replacement API without first converting your Legacy account.",
"x-displayName": "ComponentEnvironmentAttachment (Legacy deployment, Deprecated)"
},
{
"name": "ComponentMetadata",
"description": "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. \n\n >**Note:** The ability to create a new component is not supported at this time. \n\n You can also retrieve the full configuration details for a component, using the Component object. \n You can use the Component Metadata object's GET and QUERY operations to find: \n - Components created within a specific date range \n - Components modified by a specific user \n - Components of a certain type \n - Revision history for a specified component \n For example, you can use a combination of these operations to retrieve the revision history for a given component, or to create audit reports of which users changed a component. \n >**Note:** \n The ComponentMetadata API is available only with certain permissions: \n - In order to use the Get and Query operations, Build Read access is needed. \n - In order to use the Update, Create, and Delete operations, Read and Write Access privileges are needed. \n - If Folder Restrictions are enabled, you need sufficient edit access on the folder and parent folder to use these operations. \n - If Component Locking is enabled, including being locked by the same user credentials that were used in the API, the component cannot be modified. \n\n ### Component types\n\nUse the following table to determine the component types that are available for use within the Component Metadata object. Note that connector subtype fields are not defined in the following table; you can retrieve subtype values using the [Connector object](/docs/api/platformapi/Connector).\n\n|Component type field|Component type description|\n|--------------------|--------------------------|\n|certificate|X.509 Certificate|\n|certificate.pgp|PGP Certificate|\n|connector-action|Connector Operation|\n|connector-settings|Connector Connection|\n|crossref|Cross Reference Table|\n|documentcache|Document Cache|\n|transform.map|Map|\n|transform.function|Map Function|\n|process|Process|\n|processproperty|Process Property|\n|profile.db|Database Profile|\n|profile.edi|EDI Profile|\n|profile.flatfile|Flat File Profile|\n|profile.xml|XML Profile|\n|profile.json|JSON Profile|\n|queue|Queue|\n|tradingpartner|Trading Partner|\n|tpgroup|Processing Group|\n|tporganization|Organization|\n|tpcommoptions|Communication Channel|\n|webservice|API Service|\n|webservice.external|API Proxy|\n|processroute|Process Route|\n|customlibrary|Custom Library|\n|flowservice|Flow Service|\n|script.processing|Process Script|\n|script.mapping|Map Script|\n|xslt|XSLT Stylesheet| \n\n ### Component Metadata API example requests\n\nUse a list of API call examples for quick insight into the various requests you can make using the Component Metadata object.\n\nThe process available in the community article [AtomSphere API: Component Metadata Query Examples](https://community.boomi.com/s/article/AtomSphere-API-Component-Metadata-Query-Examples) demonstrates how to use the Platform API connector to create various Component Metadata queries and map them to a CSV report.\n\n### General tips for using the Component Metadata object\n\n- Include a filter for `currentVersion = true` for most calls to avoid returning previous component versions.\n\n- Include a filter for `deleted = false` for most calls to avoid returning deleted component versions.\n\n- For information about which query filters you can use, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters).\n\n### Get the current component Name for an ID\n\nThis query retrieves the current version including the name for a specific component ID. You can use this query in conjunction with other APIs that only return a component ID, such as PackagedComponent and DeployedPackage.\n\n```xml\n\n \n \n \n true \n \n \n c9fa4b5d-de31-4018-9bb5-6ea4b074a039 \n \n \n \n \n```\n\n### Get all current component versions\n\nThis query retrieves all the current, non-deleted component versions in your account, similar to the list you see in Component Explorer on the **Build** tab by default.\n\n```xml\n\n \n \n \n true \n \n \n false \n \n \n \n \n```\n\n### Get all versions for a component\n\nThis query retrieves the full version history for a component, to see when and by whom modified it.\n\n```xml\n\n \n \n1234a5-67a8-912f-a345-a6ed7891c2b \n \n \n \n```\n\n### Get all current components in a folder\n\nThis query retrieves all the non-deleted components currently stored in a specific folder.\n\n```xml\n\n \n \n \n true \n \n \n false \n \n \n #Common Utilities \n \n \n \n \n```\n\n### Get all changes made by a user during a specific timeframe\n\nThis query retrieves all the component changes made by a specific user during a specific time window. You can use this query to create audit reports.\n\n```xml\n\n \n \n \n boomi_user@mycompany.com \n \n \n 2020-01-01T00:00:00Z \n 2020-03-01T00:00:00Z \n \n \n \n \n```\n\n### Get all components of a specific type\n\nThis query retrieves all non-deleted components of a given type, similar to filtering by Component Type in Component Explorer on the **Build** tab. The example below filters for Map components. For the full list of valid Component Type values, refer to Component Types section above.\n\n```xml\n\n \n \n \n true \n \n \n false \n \n \n transform.map \n \n \n \n \n```\n\n### Get all components of a specific subtype \\(Connectors\\)\n\nThis query retrieves all non-deleted components of a given subtype, similar to filtering by Component Type in Component Explorer on the **Build** tab. The subtype is currently applicable only for Connector component types. The example below filters for HTTP Client Connector connection components.\n\n >**Note:** To obtain the connector subtype value, you can query a specific component of that subtype.\n\n```xml\n\n \n \n \n true \n \n \n false \n \n \n connector-settings \n \n \n http \n \n \n \n \n```\n\n### Get all connection components not in a specific folder\n\nThis query retrieves all non-deleted connection type components that do not reside in a specific folder. This query helps ensure that you save all connections in a shared folder and avoid possible duplicate connections.\n\n```xml\n\n \n \n \n true \n \n \n false \n \n \n connector-settings \n \n \n #Shared Connections \n \n \n \n \n```\n\n### Get all currently deleted components\n\nThis query retrieves all deleted components currently in your account. Components are “soft deleted,” which means the current revision of a given component marked as `deleted = true`.\n\n```xml\n\n \n \n \n true \n \n \n true \n \n \n \n \n```\n\n#### Required Privileges\n\n**Write access**\n\n- Build Read and Write Acccess\n\n**Read access**\n\n- Build Read Access"
},
{
"name": "ComponentReference",
"description": "Use the Component Reference object to programatically retrieve and query all the components which use or are used by a specific component. \n\n This object represents the functionality provided by the **Show Where Used** filter found in Component Explorer of the service. You can use this filter to find the bi-directional relationships between components by querying for all the primary components that use a common secondary component or, conversely, querying for all the secondary components used in a common primary component. \n\n A secondary component is one used or referenced by the primary component. For example, the individual components used in a process flow are considered dependent or secondary references to the process itself \\(where the process is the primary component\\). \n\n In another example, when you configure EDI profiles as your source and destination profiles in a Map component, those profiles are considered secondary components to the primary Map component. These concepts are important to remember when deciding how you want to use the Component Reference object — you can query for all the secondary components you configure under a single primary component, or you can retrieve a list of multiple components or processes that use a common secondary component."
},
{
"name": "ConnectionLicensingReport",
"description": "The Connection Licensing operation provides a detailed response to the Test and Production connector classes that have been deployed to one or more environments. \n You can programatically download and view detailed reports for each connector class. \n The Connection Licensing operation is a two-step asynchronous process: \n 1. The User first sends a CREATE request to the Boomi Enterprise Platform, with a request body that specifies with our without filters. \n - The Enterprise platform returns the Connection Licensing URL in the response to view or download the deployed connection details. \n 2. The User invokes the GET API call with the URL returned in Step 1 to download or view the data. The Boomi Enterprise Platform will return an HTTP 202 status code until the data is ready. \n >**Note:** \n An account can accept ONLY one request at a time. In order to CREATE a new request, the Client or User has to download or view the previous requested details with the GET API. If not, in the next CREATE request, the response returned will have the previous request URL to download or view the details, which allows users to make a new CREATE request. \n\n ### Download the Connection Licensing Report\n\n*ConnectionLicensingReport* call\n\nSend an HTTP GET using the URL returned in the CREATE request to download the detailed connection licensing report in the CSV format.\n\nGET API URL:\n\n`https://api.boomi.com/account//api/download/ConnectionLicensingConnectionLicensing-`\n\nwhere *accountId* is the ID of the authenticating account for the request and *ConnectionLicensingID* is the GUID of the created request for the connection licensing report you want to view. To download the CSV report, make a GET API call and select the **Send and Download** option in the Postman.\n\nThis URL is valid until it is invoked. Once the GET API is invoked the URL becomes inactive.\n\nGET API Response:\n\n```\n\"Deployed Connection Licensing Report for admin-123 20230809143136\"\n\n\"ENVIRONMENT\\_ID\",\"ENVIRONMENT\\_NAME\",\"ENVIRONMENT\\_CLASS\",\"CONTAINER\\_ID\",\"CONTAINER\\_NAME\",\"COMPONENT\\_ID\",\"CONNECTOR\\_TYPE\",\"CONNECTOR\\_CLASS\",\"COMPONENT\\_NAME\",\"COMPONENT\\_FOLDER\\_ID\",\"COMPONENT\\_FOLDER\\_PATH\"\n\n\"d0412cc3-52ad-4ae3-ad4e-687dd4d7715e\",\"Production\\_Env\",\"PROD\",\"e1282939-ff19-42c4-83a2-f2c1f4c8ac3e\",\"Mini\\_Atom\",\"66c0d1d2-82d5-46b4-b965-cd670425b536\",\"ebs\",\"Enterprise\",\"New Oracle E-Business \\(new\\) Connection\",\"RjoxMzA5MzUx\",\"minalrathod/TBD/TBD-connectors\"\n\n\"149dd86a-0e7d-48d8-bae3-b88b0f8ae474\",\"MinalLocalEnv\",\"TEST\",\"9055857b-5020-4580-9557-e6a42185dbd1\",\"Local\\_Atom\",\"3be9f2b8-4729-4ad3-850b-fe1eff64ed31\",\"sapjco\",\"Enterprise\",\"SAP RAC\",\"Rjo5MzM1Mzg\",\"FolderA\"\n\n```\n\n>**Note:** You cannot invoke GET API directly. The GUID passed in the URL must be the ID that was returned in the CREATE request. \n\n ### Download request responses\n\nThe download URL returned in the CREATE request, such as `https://api.platform.boomi.com/account/admin-123/api/download/ConnectionLicensing-bdc1d9f7-1158-4062-8a13-63e5276f3b52`, is valid for a single request. The URL becomes inactive if it is already invoked. The following are the possible responses to an HTTP request when downloading or viewing the deployed connection details:\n\n- 200 \\(OK\\) - The download is complete. The downloaded log is in the response body.\n\n All subsequent requests to open the download URL returns 404 \\(Not Found\\).\n\n- 202 \\(Accepted\\) - The download is in progress.\n\n Before returning a final download response, you might receive multiple 202 responses.\n\n- 204 \\(No Content\\) - Log data is not available.\n\n All subsequent requests to open the download URL returns 404 \\(Not Found\\).\n\n- 404 \\(Not Found\\) - A 200, 204, or 504 response was returned from a previous request to open this URL.\n\n- 504 \\(Gateway Timeout\\) - The Runtime is unavailable. It might have timed out.\n\n All subsequent requests to open the download URL returns 404 \\(Not Found\\).\n\n### Known Limitations\n\nThese are the known limitations:\n\n- The **Deployed** count and the CSV report count may or may not match. This is because the same connection might be used in multiple processes; therefore, the report contains an entry for each deployed process where the connection has been used.\n\n- For invoking the SOAP requests, along with the *Licensing* privilege, users must have *API Access* privilege for creating the SOAP requests."
},
{
"name": "Connector",
"description": "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. \n Using the Connector object, you can use the GET operation to retrieve the connector type for a component name, and the QUERY operation to return a list of all connector types available for the account. \n - All standard connectors. \n - Any custom SDK connectors created by the specified tenant. \n - Any custom connectors shared to the specific tenant through account groups. \n - Any connectors made available through tenant feature flags. For example, the AS2 Client/Server only available with Trading Partner feature, or Web Services Shared. \n - Legacy connectors, such as the legacy LDAP connector. \n\n ### Component Metadata object\n\nThe Connector object plays a supportive role to the Component Metadata object. Using the Component Metadata object, you can filter by component type, similar to doing so on the **Build** tab's Component Explorer in the user interface. For connectors specifically, you can use Component Metadata to refine by subtype by providing the connector type value. To find this value, use the Connector object to query a list of available connector types, which you can then use to query the ComponentMetadata using the subType."
},
{
"name": "ConnectorDocument",
"description": "You can programmatically download and view connector document data for a Generic Connector Record. \n >**Note:** \n This operation is part of a series of process run-related API objects and operations for viewing and running documents using the Platform API. You can use each object or operation conjunctively with one another to achieve a set of results pertaining to viewing or retrieving process run details. For a deeper dive into understanding the relationships and usability between each of these APIs, refer to the Community article [How to get integration process execution details with the AtomSphere API](https://community.boomi.com/s/article/How-to-get-integration-process-execution-details-with-the-AtomSphere-API). \n \n The Connector Document operation allows you to download the raw, document data for a specific Generic Connector Record. The data is equivalent to viewing and downloading document data through the **Process Reporting** page. \n The Connector Document operation is a two-step asynchronous process: \n 1. The client first sends a CREATE request to the Boomi platform with a request body specifying a generic connector record object's ID. \n 2. The platform returns `ConnectorDocumentDownload` object with a URL in the response. \n 3. The client repeatedly polls the URL returned in step 2 to download the data. The platform will return an HTTP 202 status code until the data is ready. \n 4. When ready the platform returns an HTTP 200 status code along with the document's content in text format as the body of the response. Note that once the document data has returned, it is no longer available for download. Submit a new CREATE request to download the same connector document again. \n >**Note:** \n The Connector Document operation retrieves individual document data to assist with troubleshooting or testing. However, this object is not intended to perform bulk retrieval of all document data processed for archiving or analytics. Be advised that document data can be huge. \n"
},
{
"name": "CustomTrackedField",
"description": "Use the Custom Tracked Field object to describe the custom tracked fields configured for a specific account. \n >**Note:** The fields in the Custom Tracked Field object correspond to the fields on the **Document Tracking** tab of the **Setup** page.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "DeployedExpiredCertificate",
"description": "The Deployed Expired Certificate object provides access to the deployed X.509 certificate information used to populate the [Certificates panel](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/r-atm-Certificates_panel_dd4b2756-2061-46e4-a672-3e9385421e1c) 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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "DeployedPackage",
"description": "The Deployed Package object represents a packaged component deployed to an environment. \n\n You must have the Packaged Component Deployment privilege \\(formerly known as the Process Deployment privilege\\) to use the Deployed Package object. If you want to use the CREATE operation to create a packaged component and deploy it in a single operation, you must also have the Packaged Component Management privilege \\(formerly known as the Package Management privilege\\).\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- DEPLOY — Deploy processes and other packaged components to environments.\n\n**Read access**\n\n- N/A"
},
{
"name": "Deployment",
"description": "The Deployment object represents a component deployment. \n caution \n 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](https://developer.boomi.com/docs/api/platformapi/PackagedComponent) and [Deployed Package](https://developer.boomi.com/docs/api/platformapi/DeployedPackage) objects instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about Boomi's API object deprecation status, refer to the topic [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy). \n Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new [Deployment workflow](https://help.boomi.com/docs/Atomsphere/Integration/Deployment/c-atm-Deployment_workflow_c785c476-f1b3-413b-a5a5-57afcc98978f) and [How to upgrade Legacy accounts to use the new deployment workflow](https://help.boomi.com/docs/Atomsphere/Integration/Deployment/int-Enabling_packaged_components_deployment_b134486a-2868-4cd4-868c-a0f108cb8d7e). In the meantime, do not use the replacement API without first converting your Legacy account. \n \n You cannot deploy processes that contain Process Route components as a unit with the API. You must deploy the parent process, the Process Route component, and any subprocesses that the process route calls independently.",
"x-displayName": "Deployment (Legacy deployment, Deprecated)"
},
{
"name": "DocumentCountAccount",
"description": "The Document Count Account object represents data corresponding to the data that is accessible through the **Document Count gadget** in the **Account Dashboard**. \n\n The data is the total number of documents processed under the querying account on a particular date. Calculating the document count occurs by adding the total number of inbound documents and the total number of outbound documents. QUERY operations retrieve the data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis. \n >**Note:** Retrieved document counts are raw data that might differ from the counts reported by the **Document Count gadget**.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- DASHBOARD — Access the integration account dashboards."
},
{
"name": "DocumentCountAccountGroup",
"description": "The Document Count Account Group object represents accessible data that corresponds to the data through the **Document Count** gadget in the **Account Dashboard**. \n\n This data is the total number of documents processed across all accounts in an account group on a particular date. The calculation of the document count is done by adding the total number of inbound documents and the total number of outbound documents. QUERY operations retrieve this data as XML by default. After retrieving the documents, you can import the data into a reporting tool for analysis. \n >**Note:** Retrieved document counts are raw data that might differ from the counts reported by the **Document Count** gadget.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- DASHBOARD — Access the integration account dashboards."
},
{
"name": "EDIFACTConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "EdiCustomConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "Environment",
"description": "The Environment object represents an environment. \n For accounts with Unlimited environment support, you can classify environments as either *Production* or *Test*. For accounts with Basic environment support, the classification of all environments as *Production*. \n >**Note:** The fields in the Environment object correspond to controls in the **Environments** panel of the **Runtime Management** page. \n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "EnvironmentAtomAttachment",
"description": "The Environment Atom Attachment object enables the attachment or detachment of a Runtime to or from a particular environment. \n\n You must have the Runtime Management privilege to perform the CREATE or DELETE operation. If you have the Runtime Management Read Access privilege, you cannot attach or detach Runtimes.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "EnvironmentConnectionFieldExtensionSummary",
"description": "You can use the Environment Connection Field Extension Summary object to obtain the URL for OAuth 2.0 access token generation. \n\n Through the Environment Extensions endpoint, you can programmatically set almost all extensible connection fields for those used in processes attached to environments. The only current exception is the accessToken field in a connection that uses OAuth 2.0 authentication. You can obtain the URL for OAuth 2.0 access token generation using a QUERY operation on the Environment Connection Field Extension Summary object. \n\n From the time you generate it, the URL returned by the operation is valid for up to 15 minutes only. \n\n >**Note:** Note: The Boomi Enterprise Platform API and Partner API connectors do not support operations on the Environment Connection Field Extension Summary object.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "EnvironmentExtensions",
"description": "The Environment Extensions object represents the extension \\(process override\\) values for an environment. \n\n The Environment Extensions object supports the ability to retrieve and update environment extension values. The functionality provided in the Environment Extensions object mimics the actions you can perform from the **Runtime Management** \\> **Environment Management** \\> **Environment Extensions** dialog in the Boomi Enterprise Platform. \n\n This topic covers the basics for using the Environment Extensions object. To learn more intricate details of using this object, such as working with encrypted fields, overriding extension values, working with multi-install integration pack extensions, and working with custom properties fields, refer to the topic [Working with the Environment Extensions object](https://developer.boomi.com/docs/APIs/PlatformAPI/APIReference/Working_with_the_Environment_Extensions_object). \n\n #### Environment Extension options\n\nThe following table details the components that you can retrieve or update extension values for.\n\n| XML Element | Integration Component | Notes for consideration | Partial update behavior |\n| --- | --- | --- | --- |\n| *connections* | Connection component | Available fields vary by the individual connector. | You can perform a partial update per individual field within a connection component. |\n| *operations* | Web Services Server operation | This property is only applicable to Web Services Server (WSS) listeners used in a multi-install integration pack. It allows you to override the WSS operation’s object name so you can have a unique URL per each installed instance of the integration pack. | You can perform a partial update per individual field within an operation component. |\n| *tradingPartner* | Trading Partner component | Trading partner component communication method fields, EDI document standard fields, or both. Available fields vary by individual communication method and standard. | You can perform a partial update per individual field within a Trading Partner component. |\n| *sharedCommunication* | Communication Channel component | Available fields vary by the individual communication method. | You can perform a partial update per individual field within a Shared Communication component. |\n| *crossReferences* | Cross Reference table component | Available columns vary by individual cross reference table configurations. | You can perform a partial update per individual Cross Reference Table component, but you must provide the values for all rows in the component. |\n| *properties* | Dynamic Process Property | You can use the dynamic process property’s name as the extension field ID. | You can perform a partial update per individual Dynamic Process Property component. |\n| *PGPCertificate* | PGP certificate component | Use an existing PGP certificate’s component ID in your requests. It is not possible to use the Environment Extensions object to upload a new certificate directly. | You can perform a partial update per individual PGP Certificate component. |\n| *processProperty* | Process Property component | Available fields vary based on the properties defined within a given process property component. The property’s key is used as the extension field ID. | You can perform a partial update per individual property within a Process Property component. |\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "EnvironmentMapExtension",
"description": "The Environment Map Extension object represents the extensible data map configuration for a deployed process. \n\n Data map extensions allow you to override or augment default field mappings and profile elements for a given pair of object definitions. Map extensions are typically used with integration packs. It is common for an integration pack developer to configure a default set of field mappings for a given integration, but then allow extension of the map. This enables each consumer of that integration pack to customize and augment the field mappings to meet their specific requirements. Additionally, in some cases, consumers can customize the source and destination profiles to incorporate custom fields that exist in their endpoint applications. For more information, refer to the topic [Data map extensions](https://help.boomi.com/docs/Atomsphere/Integration/Process%20building/c-atm-Data_Map_Extensions_126d6c7d-71d1-4839-b1e7-586147f826d1). \n\n Integration pack developers typically use the Environment Map Extension object to present the mapping configuration to their end users through a custom user interface. In some situations, developers can customize the source and destination profile fields to include the end user's own custom fields. Refer to the **Customizing profiles** section later in this topic. \n\n The Environment Map Extension object operates with a single map ID. Use the [Environment Map Extensions Summary object](https://developer.boomi.com/docs/api/platformapi/EnvironmentMapExtensionsSummary) to query the list of available map extensions for the given environment. \n\n To learn more about customizing profiles, refer to the topic [Customizing Profile](https://developer.boomi.com/docs/APIs/PlatformAPI/APIReference/Customizing_profiles_environment_map_extension). \n\n For more details on the map function, refer to [Environment Map Extension Function](https://developer.boomi.com/docs/APIs/PlatformAPI/APIReference/Environment_Map_Extension_functions).\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "EnvironmentMapExtensionExternalComponent",
"description": "Query the Environment Map Extension External Components object for a list of all available cross-reference components with a given environment map extension. \n\n This object is helpful for process and integration pack developers that need to perform a cross-reference lookup function. After using this object to get a list of available cross-reference components, you can then use the Component API to retrieve a table's definition from the results list. \n\n ### Component types\n\nUse the following table to determine the component types that are available for use within the Environment Map Extension External Component object. The following content does not define the connector subtype fields; you can retrieve subtype values using the [Connector object](/docs/api/platformapi/Connector).\n\n| Component type field | Component type description |\n|--------------------|--------------------------|\n| certificate | X.509 Certificate |\n| certificate.pgp | PGP Certificate |\n| connector-action | Connector Operation |\n| connector-settings | Connector Connection |\n| crossref | Cross-Reference Table |\n| documentcache | Document Cache |\n| transform.map | Map |\n| transform.function | Map Function |\n| process | Process |\n| processproperty | Process Property |\n| profile.db | Database Profile |\n| profile.edi | EDI Profile |\n| profile.flatfile | Flat File Profile |\n| profile.xml | XML Profile |\n| profile.json | JSON Profile |\n| queue | Queue |\n| tradingpartner | Trading Partner |\n| tpgroup | Processing Group |\n| tporganization | Organization |\n| tpcommoptions | Communication Channel |\n| webservice | API Service |\n| webservice.external | API Proxy |\n| processroute | Process Route |\n| customlibrary | Custom Library |\n| flowservice | Flow Service |\n| script.processing | Process Script |\n| script.mapping | Map Script |\n| xslt | XSLT Stylesheet |"
},
{
"name": "EnvironmentMapExtensionUserDefinedFunction",
"description": "Use the Environment Map Extension User Defined Function object to create, modify, delete, and restore user-defined map functions within environment data maps. \n\n You must have the **Environment Management Full Access** or the **Environment Management** privileges to use this API object. Extensible [user-defined map functions](https://help.boomi.com/docs/Atomsphere/Integration/Process%20building/r-atm-Map_Function_components_d209f3e8-3094-42de-a504-2f2dc33ab15c) allow you to link multiple standard function steps in a defined sequence to perform sophisticated transformations between profile fields in an extended Map. With the Environment Map Extension User Defined Function object, you can:\n\n - Retrieve the properties of an extended user-defined function\n- Create new, extensible user-defined functions\n- Update the configuration of an extended user-defined function\n- Delete an extended user-defined function\n- Restore a deleted extended user-defined function\n\nThe actions available with this API object directly represent how you interact with extensible user-defined functions [in the user interface](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/int-Adding_a_user_defined_function_to_an_extended_data_map_4ba06b78-8db5-42ea-a58d-593f36be10bb). After using this API object, you can use the [Environment Map Extension object](/docs/api/platformapi/EnvironmentMapExtension) to map through these extensible user-defined functions as part of a greater Map extension. The Environment Map Extension User Defined Function object is most useful for Integration Pack developers who need the flexibility to accommodate more complicated mapping logic for their specific business cases.\n\n>**Note:** Creating user-defined functions using this object exists only at the environment extension level and are tied to a single map extension only; you cannot reference process-level functions in extensions. You can reuse a given function within a single map extension but cannot reuse it across multiple maps within an integration pack or across environments. User-defined functions are their own entities and are saved separately from extended maps that may reference them. After you save the Environment Map Extension object, the new versions of the user-defined functions communicate to the runtime.\n\nThis API supports all user-defined functions except:\n\n- SQL Lookups\n- Document Cache lookups\n- Get Properties\n- Set Properties\n- Set Trading Partners\n\nThough you cannot create new Cross Reference Tables, you can look up existing Cross Reference Tables."
},
{
"name": "EnvironmentMapExtensionUserDefinedFunctionSummary",
"description": "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. \n You can use this object in combination with other Environment Map Extension objects. For example, you can query this object to retrieve a list of user-defined functions and then employ the [Environment Map Extension User Defined object](/docs/api/platformapi/EnvironmentMapExtensionUserDefinedFunction) to modify the properties of a function returned in the list of results."
},
{
"name": "EnvironmentMapExtensionsSummary",
"description": "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. \n Data map extensions are overrides to field mappings or fields augmenting profile-based object definitions. Data map extensions represent the generalized mapping between two object definitions. For more information, refer to the topic [Data map extensions](https://help.boomi.com/docs/Atomsphere/Integration/Process%20building/c-atm-Data_Map_Extensions_126d6c7d-71d1-4839-b1e7-586147f826d1). \n Before you can request a GET or UPDATE operation on an [Environment Map Extension object](/docs/api/platformapi/EnvironmentMapExtension), you must perform a QUERY operation on the Environment Map Extensions Summary object to obtain the object IDs for extensible maps. The Environment Map Extensions Summary object also returns any connection fields required to reimport the source and destination profiles for customization. \n\n >**Note:** You use the Environment Map Extension Summary object to configure extended maps only. Using the Environment Extensions object, you manage all other types of extensions, such as connections and process properties.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "EnvironmentRole",
"description": "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.\n\n#### Required Privileges\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ENV_MANAGEMENT — Management of all environments and associated access.\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n- ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration."
},
{
"name": "Event",
"description": "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 Runtime monitoring events. The Event object returns process details information via the `user.notification` record, such as `topLevelProcessId`, `processId`, and `processName`. \n >**Note:** Purging of event records occurs after seven days.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- VIEW_RESULT — View and monitor process execution activity and logs."
},
{
"name": "ExecutionArtifacts",
"description": "The Download execution artifacts operation allows users to programmatically retrieve a link for downloading detailed information about a given process run. \n Execution artifacts provide granular information about a process run. After downloading, you can view process and data logs, metrics such as how long it took for a process shape to run, and more. The functionality provided by the Download execution artifacts operation is similar to the act of downloading execution artifacts from the **Process Reporting** page in the user interface (**Manage** --> **Process Reporting** --> **Actions menu** --> **View Extended Information**). \n >**Note:** \n When a Cloud owner enables the **Enable Download of Execution Artifacts and Worker Logs** property on the **Cloud Attachment Quotas** tab (**Manage** --> **Cloud Management**) of the Integration user interface, account users can employ the Download execution artifacts operation to retrieve a download link for viewing process execution artifacts. \n \n Retrieving a process' execution artifacts is an asynchronous process: \n 1. You send a CREATE (or POST) request to the Boomi Enterprise Platform API that specifies an account ID in the endpoint and a run ID in the request body. \n 2. The Enterprise platform returns a download URL for the specified run ID and a status code 202 while the request is in progress. \n 3. Press **CTRL** and left-click on the link to initiate the download in their default browser. \n >**Note:** You can also copy and paste the link into your web browser to begin the download. The browser might require you to enter your sign-in credentials. \n 4. The Enterprise platform downloads the ExecutionArtifacts\\log.zip file to the your local **Downloads** folder. Then, you can open the file by extracting the zip file.",
"x-displayName": "Download execution artifacts"
},
{
"name": "ExecutionConnector",
"description": "Use the Execution Connector object to programmatically retrieve information about the connectors included in a process run. \n >**Note:** \n This object is part of a series of process run-related API objects and operations for viewing and running documents using the Platform API. You can use each object or operation conjunctively with one another to achieve a set of results pertaining to viewing or retrieving process run details. For a deeper dive into understanding the relationships and usability between each of these APIs, Refer to the Community article [How to get integration process execution details with the AtomSphere API](https://community.boomi.com/s/article/How-to-get-integration-process-execution-details-with-the-AtomSphere-API). \n \n The Execution Connector object represents the connector steps used in a given process run that moves documents either into or out of the process. Execution Connector records include the **Start** shape, **Connector** shapes, **Trading Partner** shapes, and **Return Documents** shapes used in the process. The information returned with the Execution Connector object includes the type of connector, the number of success or error documents, and the action performed by the connector."
},
{
"name": "ExecutionCountAccount",
"description": "The Execution Count Account object represents data corresponding to the data that is accessible through the Execution Count gadget in the **Account Dashboard**. \n This data is the total number of successful and failed process runs, including subprocesses, under the querying account on a particular date. QUERY operations retrieve this data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis. \n >**Note:** Retrieved run counts are raw data that might differ from the counts reported by the **Execution Count gadget**.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- DASHBOARD — Access the integration account dashboards."
},
{
"name": "ExecutionCountAccountGroup",
"description": "The Execution Count Account Group object represents data corresponding to the data accessible through the **Execution Count gadget** in the **Account Dashboard**. \n The data is the total number of successful and failed process runs, including subprocesses, across all accounts in an account group on a particular date. QUERY operations retrieve this data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis. \n >**Note:** Retrieved execution counts are raw data that might differ from the counts reported by the **Execution Count gadget**.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- DASHBOARD — Access the integration account dashboards."
},
{
"name": "ExecutionRecord",
"description": "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, Runtime information, and error messages along with other fields.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- VIEW_RESULT — View and monitor process execution activity and logs."
},
{
"name": "ExecutionRequest",
"description": "Use the Execution Request object to asynchronously run an integration process on a given Runtime using a CREATE operation. \n >**Note:** \n You must have the **Execute** privilege for the intended environment to use this object. \n \n The action provided by the Execution Request object is similar to running a process from **Process Reporting** in the user interface. \n\n ### Retrieving the run record: \n Use the Execution Request object with the Execution Record object to retrieve the run record, as described in the following steps. \n Requesting a process run is an asynchronous process: \n 1. Send a POST request to the Execution Request object with a request body that specifies both the ID of the process that you want to run and the desired Runtime on which to run the process. The response returns a requestId. \n 2. Using the requestId returned in Step 1, make a subsequent call to the Execution Record object to retrieve detailed information about the process run \\(in other words, the run record\\). \n 3. Repeatedly poll the Execution Record object with the requestId until the run record is available. If the `ExecutionRecord` is not available yet, it returns an HTTP 202 status code. \n\n ### Benefits of using the Execution Request object\n\n The Execution Request object provides these additional benefits:\n\n - A means for you to correlate the run request to the actual run, which helps a developer know whether a test passed or failed in the result.\n - Support for passing process property component property values in addition to dynamic process properties. Currently, the Execute Process operation supports passing dynamic process properties only.\n - Additional validations to ensure that you deploy process properly and can be run.\n - Returns a `requestId` that you can use in a subsequent call to the Execution Record object. The Execute Process operation does not return a `requestId` value. \n\n > **Note:**\n> - This API object accepts dynamic process properties and process properties components. Their specified values override corresponding values persisted from previous runs. The dynamic process property names must match exactly.\n>\n> - For additional clarity, the properties you provide in the request override persisted properties or extensions. This object does not validate property component IDs, property keys, or field values. The object does not error in these cases, and as a result, those properties are not set.\n>\n> - Also, if environment extensions are used to set property values, those values override anything passed in the API call."
},
{
"name": "ExecutionSummaryRecord",
"description": "The Execution Summary Record object enables the retrieval of run information for processes that use the Low Latency option. \n You can use this information to populate the **Real-time Dashboard** in the user interface. Each object represents a block of time and contains summary information for runs occurring during that time block.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- VIEW_RESULT — View and monitor process execution activity and logs."
},
{
"name": "Folder",
"description": "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. If Folder Restrictions are enabled, you need sufficient edit access on the folder and parent folder to use these operations. \n\n#### Required Privileges\n\n**Write access**\n\n- Build Read and Write Acccess\n\n**Read access**\n\n- Build Read Access"
},
{
"name": "getAssignableRoles",
"x-displayName": "Retrieve a list of roles assignable to users under an account."
},
{
"name": "GenericConnectorRecord",
"description": "Use the Generic Connector Record object to programmatically retrieve document metadata for a given process execution by means of a GET and QUERY operation. \n >**Note:** \n This object is part of a series of process run-related API objects and operations for viewing and running documents using the Platform API. You can use each object or operation conjunctively with one another to achieve a set of results for viewing or retrieving process run details. For a deeper understanding into the relationships and usability between each of these APIs, refer to the Community article [How to get integration process execution details with the AtomSphere API](https://community.boomi.com/s/article/How-to-get-integration-process-execution-details-with-the-AtomSphere-API). \n \n The Generic Connector Record represents the individual documents that are tracked for a given integration process run. Generic Connector Records are obtained through **Start**, **connector**, or **Return Documents** shapes. These records also include both standard connector and user-defined tracked document metadata. \n A typical usage pattern when using this object is to: \n 1. Query for a particular [ExecutionRecord](/docs/api/platformapi/ExecutionRecord) record. \n 2. Retrieve the [ExecutionConnector](/docs/api/platformapi/ExecutionConnector) records for that run record. \n 3. Retrieve the GenericConnectorRecords for a particular ExecutionConnector record. \n This record is equivalent to viewing the details of a run through the **Process Reporting** page. \n >**Note:** \n You can query Generic Connector Records within a single process run. You cannot query Generic Connector Records across all available runs at this time. \n"
},
{
"name": "HL7ConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "InstallerToken",
"description": "The Installer Token object represents a unique token generated by that you can use to install a Runtime, Runtime cluster node, Runtime cloud cluster, Authentication Broker, or API Gateway. \n Using a token eliminates the need to specify credentials. When you create a token, it is valid only for the generating account.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- N/A"
},
{
"name": "IntegrationPack",
"description": "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 \n This object does not return the integration packs created in the primary or publisher account.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "IntegrationPackAtomAttachment",
"description": "The Integration Pack Atom Attachment object enables the attachment or detachment of an integration pack instance to or from a particular Runtime. \n >CAUTION: \n The Integration Pack Atom Attachment object is a deprecated API and should no longer be used. Non-environment functionality was removed from the , and all accounts are changed to utilize Environments. Therefore, Boomi recommends that you take advantage of the API functionality provided by the [Integration Pack Environment Attachment object](/docs/api/platformapi/IntegrationPackEnvironmentAttachment) instead. For more information about Boomi's API object deprecation status, refer to [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy).\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- DEPLOY — Deploy processes and other packaged components to environments.",
"x-displayName": "IntegrationPackAtomAttachment (Legacy deployment, Deprecated)"
},
{
"name": "IntegrationPackEnvironmentAttachment",
"description": "The Integration Pack Environment Attachment object enables the attachment or detachment of an integration pack instance to or from a particular environment. \n >**Note:** \n The Integration Pack Environment Attachment object type is exposed only for accounts where you enable environments. For accounts where you do not enable environments, it reveals the Integration Pack Atom Attachment object type instead.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- DEPLOY — Deploy processes and other packaged components to environments."
},
{
"name": "IntegrationPackInstance",
"description": "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.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "JavaRollback",
"description": "Use the Roll back Java operation to programmatically return a Runtime, Runtime cluster, Runtime Cloud, Authentication Broker, or Gateway to use the previous version of Java with an EXECUTE operation. \n >**Note:** \n You must have the **Runtime Management** privilege to use the Roll back Java operation to update any and all containers. \n\n >**Important:** - Suppose you roll back a container from Java 11 to an earlier version of Java. In that case, you must also update your Runtime virtual machine (VM) options to include endorsed directories by enabling the ATOM\\INSTALL\\DIR\\bin\\atom.vmoptions property. \n > - For Java 11, the default state for this property is disabled, and you need to turn it on when you roll back to earlier versions of Java. \n > - You do not need to enable the property if you already have earlier Java versions installed.",
"x-displayName": "Roll back Java"
},
{
"name": "JavaUpgrade",
"description": "Use the Upgrade Java operation to programmatically download and run the Java upgrader script for a specified Runtime, Runtime cluster, Runtime Cloud, Authentication Broker, or API Gateway. \n The Upgrade Java operation upgrades your selected container to Boomi's latest supported version of Java. Currently, the latest version of Java available is Java 11. \n >**Note:** You must have the **Runtime Management** privilege to use the Upgrade Java operation to update any and all containers. Additionally the container must be eligible for upgrade.",
"x-displayName": "Upgrade Java"
},
{
"name": "ListenerStatus",
"description": "The Listener Status object represents the status of a listener process deployed to a Runtime, Runtime cluster, or Runtime cloud. For example, you can retrieve a listener's status to ensure that requests for pause, resume, or restart take effect before performing other actions. \n Retrieving the listener status is an asynchronous process: \n - The client sends a QUERY request that specifies a container ID and, optionally, a listener ID to the platform. \n - The platform returns a listener status token. \n - The client sends a GET request that includes the listener status token to the platform. \n - The platform returns the status of the specified listener or listeners. \n\n >**Note:** If the QUERY request does not include a listener ID, the subsequent GET request retrieves the status of all listeners on that container.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes."
},
{
"name": "ListQueues",
"description": "Use the List queues operation to programmatically retrieve a list of message queues (both point-to-point and publisher-subscriber) along with its name, type, and number of messages and dead letter messages in the queue. \n This operation leverages the deprecated functionality provided by the GET queue list operation. You must have the **Runtime Management** privilege to use this operation. The List queues action is an asynchronous process: \n 1. The client sends an initial GET request to the that specifies a Runtime ID for the Runtime, Runtime cluster, or Runtime cloud containing the message queue that the user wants to retrieve. \n 2. The platform returns a status code 202 while the request is in process. A 200 status code indicates that the request is complete. \n 3. The client sends a second GET request using the Session ID value provided in the first response. \n 4. The second GET response returns all message queues available in the Runtime ID specified in step 1.",
"x-displayName": "List queues"
},
{
"name": "MergeRequest",
"description": "You can use the Merge Request object to create and manage merge requests to merge changes in a development branch to another branch. \n\n To enable fine-grained control over the merge process and facilitate efficient conflict resolution, you can now exclude specific components by using the `excluded` property in the MERGE REQUEST UPDATE and MERGE REQUEST EXECUTE APIs."
},
{
"name": "MoveQueueRequest",
"description": "Use the Move queue request operation to programmatically move messages from one Runtime queue to another using the CREATE operation. \n\n You must have the **Runtime Management** privilege to use the Move queue request operation. To move messages between Runtime queues, they must reside on the same Runtime and be of the same type (for example, *Point-to-Point* or *Publish/Subscribe*).",
"x-displayName": "Move queue request"
},
{
"name": "NodeOffboard",
"description": "As a Cloud or Runtime cluster owner, use the Node Offboard object to programatically delete nodes from a Cloud or Runtime cluster cluster. \n\n The Node Offboard object performs similarly to how you might use the **Delete** button on the **Cluster Status** panel in Runtime Management to remove a node. You must have **Runtime Management** privileges to use the Node Offboard object."
},
{
"name": "ODETTEConnectorRecord",
"description": "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."
},
{
"name": "OFTP2ConnectorRecord",
"description": "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."
},
{
"name": "OrganizationComponent",
"description": "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."
},
{
"name": "PackagedComponent",
"description": "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. \n In addition to processes, you can convert the following types of components into packaged components and deploy them to an environment independently: \n - API Proxy \n - API Service \n - Certificate \\(public X.509\\) \n - Custom Library \n - Flow Service \n - Process Route \n - Processing Group \n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- PACKAGE_MANAGEMENT — Create and manage packaged components."
},
{
"name": "PackagedComponentManifest",
"description": "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. \n\n The Packaged Component Manifest object resembles how a user accesses the **Packaged Component Details** panel in the user interface to view all included components within a package. You can use this object in combination with other Component objects. For example, you can query the Packaged Components object to find a record of interest such as those matching a specific version name, and then employ the Packaged Component Manifest object to get all the included components for each result."
},
{
"name": "PersistedProcessProperties",
"description": "The Persisted Process Properties object represents the collection of properties that a Runtime persists across subsequent \n runs. \n The owner of a Runtime cloud or Runtime cluster can retrieve a list of all Persisted Process properties for a specified \n container. You can also update a property by adding, changing, or removing a container's Persisted Process properties. \n Retrieving a list of Persisted Process properties is an asynchronous process: \n - The client sends a GET request that specifies a list of all a container's Persisted Process properties to the Boomi Enterprise Platform. \n - The platform returns a persisted process property token for the specified Runtime, Runtime cluster, or Runtime cloud. \n - The client sends one or more GET requests that include the Persisted Process properties token. \n - The platform returns one of the following: Status code 202 while the request is in progress. \n - Status code 200 with the custom contents of the security policy when the request is complete.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT or PERSIST_PROCESS_PROPERTY\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT or ATOM_MANAGEMENT_READ_ONLY or PERSIST_PROCESS_PROPERTY"
},
{
"name": "Process",
"description": "The Process object represents a process that is available to the requesting account. \n The primary use of this object is to assist with integration packs and extensions for multi-install integration packs. \n To retrieve general information about a process or other type of component, use the [Component Metadata object](/docs/api/platformapi/ComponentMetadata) instead.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "ProcessAtomAttachment",
"description": "The Process Atom Attachment object enables the attachment or detachment of a process to or from a particular Runtime. The Process Atom Attachment object (Legacy) is a deprecated API and should no longer be used. Processes are no longer deployed to a specific runtime, and all accounts are changed to use Environments. You can use the [Process Environment Attachment API](https://developer.boomi.com/docs/api/platformapi/ProcessEnvironmentAttachment) instead. For more information about Boomi's API object deprecation status, refer to the topic [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy). \n\n You can use the Process Atom Attachment object only for processes. For other components, use the [Component Atom Attachment object](https://developer.boomi.com/docs/api/platformapi/ComponentAtomAttachment).",
"x-displayName": "ProcessAtomAttachment (Legacy deployment, Deprecated)"
},
{
"name": "ProcessEnvironmentAttachment",
"description": "The Process Environment Attachment object enables the attachment or detachment of a process to or from a particular environment. \n caution \n The Process Environment Attachment object is a deprecated API and should no longer be used. Boomi recommends that you take advantage of the API functionality provided by the [Deployed Package object](https://developer.boomi.com/docs/api/platformapi/DeployedPackage) instead. This change is to support the introduction of Packaged Component Deployments, which leverages the way Legacy account users deploy components to environments. For more information about Boomi's API object deprecation status, refer to the topic [API deprecation and versioning policy](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/API_versioning_and_deprecation_policy). \n\n Boomi encourages administrators of Legacy deployment accounts to take advantage of the new Packaged Components Deployment by upgrading their accounts. Learn more about the new [deployment workflow](https://help.boomi.com/docs/Atomsphere/Integration/Deployment/c-atm-Deployment_workflow_c785c476-f1b3-413b-a5a5-57afcc98978f) and [how to upgrade Legacy accounts to use the new deployment workflow](https://help.boomi.com/docs/Atomsphere/Integration/Deployment/int-Enabling_packaged_components_deployment_b134486a-2868-4cd4-868c-a0f108cb8d7e). In the meantime, do not use the replacement API without first converting your Legacy account. \n You can use the Process Environment Attachment object only for processes. For other components, use the [Component Environment Attachment object](https://developer.boomi.com/docs/api/platformapi/ComponentEnvironmentAttachment).",
"x-displayName": "ProcessEnvironmentAttachment (Legacy deployment, Deprecated)"
},
{
"name": "ProcessLog",
"description": "Runtime cloud owners and tenants in a Cloud can use the Download Process Log operation to download their accounts’ process run logs. You can use process logs for compliance, reporting, or diagnostic purposes. \n To download process logs, you must have access to the account and the environment in which the process exists. You must also have the View Results privilege. \n Because large process logs can take a while to download, the Platform API provides an asynchronous technique for requesting and downloading these logs. \n >**Note:** If you use a connector, rather than a direct http request, you will need to choose EXECUTE to obtain the process logs. \n To download the process log operation via a http request: \n 1. The client sends a process log request to the Boomi Enterprise Platform API that specifies the process run ID and, optionally, the process run log level. \n 2. The Enterprise platform returns a Log Download object that contains a URL with a unique process log ID. \n 3. The client opens the URL to download the log. \n \n >**Note:** Process logs are purged 30 days after their creation.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- VIEW_RESULT — View and monitor process execution activity and logs.\n- user access to deployed environment and atom\n\n**Read access**\n\n- N/A",
"x-displayName": "Download Process Log"
},
{
"name": "ProcessSchedules",
"description": "The Process Schedules object represents the run schedules for a deployed process. \n\n The platform creates the Process Schedules object for every deployed process by default. Initially, the object is empty, and a run schedule is not in effect. \n\n The fields used to specify run times conform with the Advanced (cron) syntax supported in the **Scheduling** dialog in the user interface at **Manage** > **Runtime Management**.\n\nIn schedule fields, an asterisk [*] indicates that the schedule runs every minute, hour, day of the week, day of the month, month, or year. Use hyphens to specify ranges of values, and use commas as delimiters between values and ranges. The time specification of a range — whether it be a range of years, months, days of the month or week, hours, or minutes — can optionally be followed by a slash and an interval of that unit of time. For example:\n - In the minutes field, a value of 0-59/15 specifies 0, 15, 30, and 45 minutes after the hour.\n - In the daysOfMonth field, a value of 3-30/3 specifies every third day beginning with the third day of the month.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- SCHEDULE_MAINTENANCE or ATOM_MANAGEMENT\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- SCHEDULE_MAINTENANCE or ATOM_MANAGEMENT_READ_ONLY or ATOM_MANAGEMENT"
},
{
"name": "ProcessScheduleStatus",
"description": "The Process Schedule Status object represents the status of run schedules for a deployed process.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- SCHEDULE_MAINTENANCE or ATOM_MANAGEMENT\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- SCHEDULE_MAINTENANCE or ATOM_MANAGEMENT_READ_ONLY or ATOM_MANAGEMENT"
},
{
"name": "PublisherIntegrationPack",
"description": "The PublisherIntegrationPack object represents the integration packs created in a parent or publisher account. Using the PublisherIntegrationPack object, you can retrieve details of integration packs and packaged components available to the publisher account.\n \n You can perform the following operations using the PublisherIntegrationPack object:\n \n - create, retrieve, update, query, and delete the integration packs\n - retrieve and update the packaged components. \n >**Note:** To use the PublisherIntegrationPack API, the account-level features, Publisher Integration Pack and Integration Pack must be enabled. For more information, contact your Boomi representative."
},
{
"name": "RefreshSecretsManager",
"description": "Your secrets are never stored in the file system and are constrained to an individual Java classloader. These cached secrets are only stored for one hour, and do not persist between restarts, the creation of a new execution worker, or the creation of a new forked process execution. \n\n To coordinate the caching of secrets with your secret rotation practices, the `refreshSecretsManager` API allows you to reset the secret cache on all runtimes in an account. This ensures that the runtimes in your account directly retrieve secrets from the external secrets manager the next time the secret is referenced."
},
{
"name": "ReleaseIntegrationPack",
"description": "The ReleaseIntegrationPack object represents the release object of the publisher integration pack. \n\n- You can release (immediate or scheduled) a publisher integration pack using the Create operation.\n- You can modify a scheduled release for an integration pack. \n >**Note:** To use the ReleaseIntegrationPack API, the account-level features, Publisher Integration Pack, and Integration Pack must be enabled. For more information, contact your Boomi representative.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API Publisher Integration Pack\n- Integration Pack"
},
{
"name": "ReleaseIntegrationPackStatus",
"description": "Retrieves the status of the publisher integration pack scheduled for the release. \n\n#### Required Privileges\n\n**Write access**\n\n- API Publisher Integration Pack\n- Integration Pack\n\n**Read access**\n\n- N/A"
},
{
"name": "RerunDocument",
"description": "The Rerun Document object allows you to reprocess one or more documents from a previous run. You can rerun documents from a process’ **Start** shape or **Trading Partner** shape only. \n >**Note:** \n This operation is part of a series of process run-related API objects and operations for viewing and running documents using the Platform API. You can use each object or operation conjunctively with one another to achieve a set of results pertaining to viewing or retrieving process run details. For a deeper dive into understanding the relationships and usability between each of these APIs, refer to the Community article [How to get integration process execution details with the AtomSphere API](https://community.boomi.com/s/article/How-to-get-integration-process-execution-details-with-the-AtomSphere-API). \n \n You can use the Rerun Document operation to reprocess either all documents for a given run by status, or individual documents \\(also known as Generic Connector Records\\) in a process run. \n A common usage pattern to rerun individual documents \\(Generic Connector Records\\) is to: \n 1. First, query for a particular [Execution Record object](/docs/api/platformapi/ExecutionRecord) record. \n 2. Next, retrieve the [ExecutionConnector](/docs/api/platformapi/ExecutionConnector) where `startShape=`true. The ExecutionConnector API response includes is `StartShape=`true or `StartShape=`false, and if true, you can rerun the record. \n 3. Then, retrieve the [GenericConnectorRecords](/docs/api/platformapi/GenericConnectorRecord) by `status=`ERROR \\(most common\\) for a particular ExecutionConnector record. \n 4. Call `RerunDocument` with the collection of GenericConnectorRecord IDs generated from the GenericConnectorRecords object in Step 3. \n 5. Finally, use the [ExecutionRecord object](/docs/api/platformapi/ExecutionRecord) with the requestId returned from the `RerunDocument` request, to get the result of the retry run."
},
{
"name": "Role",
"description": "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. \n >**Note:** Any role (including custom roles) created in an internal account is considered a default Boomi role and cannot be deleted, resulting in the following error message:\n\n```json\n{\n \"@type\": \"Error\",\n \"message\": \"Cannot modify default Boomi roles\"\n}\n``` \n\n >**Note:** Your account must have the Advanced User Security feature enabled to query for custom roles and create, update, or delete custom roles. If you do not enable this feature, you can only query for default roles.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ACCOUNT_ADMIN — Account configuration and administration."
},
{
"name": "RosettaNetConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "RuntimeCloud",
"description": "The RuntimeCloud object lets you create, query, update, and delete private runtime clouds. \n\n**Required privilege:** You must have Cloud Management privilege to use the RuntimeCloud API."
},
{
"name": "RuntimeObservabilitySettings",
"description": "Manages observability settings for runtimes, including logs, metrics, and traces configuration."
},
{
"name": "RuntimeProperties",
"description": "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).\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n**Read access**\n\n- ATOM_MANAGEMENT — Configure and administer integration runtimes.\n\n- OR ATOM_MANAGEMENT_READ_ONLY"
},
{
"name": "RuntimeReleaseSchedule",
"description": "The Runtime Release Schedule object allows you to configure a schedule for automatically receiving updates on a Runtime, Runtime cluster, or Runtime cloud. \n\n >**Note:** You must have the **Runtime Management** privilege to use the Runtime Release Schedule object."
},
{
"name": "RuntimeRestartRequest",
"description": "The RuntimeRestartRequest object allows you to restart the runtime when performing runtime maintenance or configuration. Restarting runtime is captured in the audit log entries.\n\n >**Note:** You must have the Runtime Management and Environment Management privileges to restart the runtime. "
},
{
"name": "SharedCommunicationChannelComponent",
"description": "The Shared Communication Channel Component object allows users to retrieve, query, update, and delete Shared Communication Channel components through the Boomi Enterprise Platform API. \n\n The `PartnerCommunication` portion of this structure varies depending on which communication option you want to use for the Shared Communication Channel component. The following sections include the structures for AS2, Disk, FTP, SFTP, HTTP, and OFTP2. \n\n \nAS2 communication options \n\n ```xml \n\n \n\nSampleUrl \n\n\n \n\n\n\n\n\n\n\n\n \n \n\n \n\n \n \n \n ``` \n \n\n \nDisk communication options \n\n ```xml \n\n \n\n \n\n \n \n ``` \n\n \n\n \n \n\n \nFTP communication options \n\n ```xml \n \n\nSampleuer \n\n\n \n \n\n \n\n \n \n ``` \n \n\n \n \n\n \nSFTP communication options \n\n ```xml \n \n\n\n \n\n \n \n\n \n\n \n \n ``` \n \n\n \n \n\n \nHTTP communication options \n\n ```xml \n \n\n\n\n\n\n\n\n \n\n \n\n \n\n \n\n \n ``` \n \n\n \n \n\n \nOFTP2 communication options \n\n ```xml \n \n\nfalse \nfalse \n\"\",0 \nfalse \nfalse \n \n\n\n\n \n \n \n\n\n\n \n \n \n\n \n\n\n\n \n \n \n \n``` \n \n\n \n \n\n \nOFTP2 partner archiving \n\n ```xml \n \n \n ``` \n \n\n"
},
{
"name": "SharedServerInformation",
"description": "The Shared Server Information object provides information about the configuration of a Runtime’s shared web server.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes."
},
{
"name": "SharedWebServer",
"description": "The Shared Web Server object details the configuration settings for a Runtime'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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data.\n- ATOM_MANAGEMENT — Configure and administer integration runtimes."
},
{
"name": "ThroughputAccount",
"description": "The Throughput Account object represents data corresponding to the data accessible from the **Throughput** gadget in the **Account Dashboard**. \n This data is the throughput size — the total volume, in bytes, of inbound and outbound documents — for querying the account on a particular date. QUERY operations retrieve this data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis. \n >**Note:** Retrieved throughput sizes are raw data that might differ from the sizes reported by the **Throughput** gadget.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- DASHBOARD — Access the integration account dashboards."
},
{
"name": "ThroughputAccountGroup",
"description": "The Throughput Account Group object represents data corresponding to accessible data from the **Throughput** gadget in the **Account Dashboard**. \n This data is the throughput size — the total volume, in bytes, of inbound and outbound documents — across all accounts in a particular account group on a specific date. QUERY operations retrieve this data as XML by default. After retrieving the data, you can import it into a reporting tool for analysis. \n >**Note:** Retrieved throughput sizes are raw data that might differ from the sizes reported by the **Throughput**gadget.\n\n#### Required Privileges\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data.\n- DASHBOARD — Access the integration account dashboards."
},
{
"name": "TradacomsConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "TradingPartnerComponent",
"description": "The Trading Partner Component object allows users to retrieve, query, create, update, and delete Trading Partner components through the Platform API. \n >**Note:** Due to the large number of fields and options for this object, Boomi recommends that you use the Platform and Partner API connectors to create Trading Partner components through the API. For detailed information about the fields, refer to the [Trading Partner component](https://help.boomi.com/docs/Atomsphere/Integration/Process%20building/r-atm-Trading_Partner_Components_96eb4e6c-f5a6-4583-98a8-690236d288f9) information or the help provided for the Trading Partner component within the user interface. \n\n For more details about the partner componets object structure, refer to [Trading partner components](https://developer.boomi.com/docs/APIs/PlatformAPI/APIReference/Trading_partner_object).\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "TradingPartnerProcessingGroup",
"description": "The Trading Partner Processing Group object allows users to retrieve, query, create, update, and delete [Processing Group components](https://help.boomi.com/docs/Atomsphere/Integration/Process%20building/c-atm-Trading_Partner_Group_components_5f1fa272-5d7d-4e5a-a2c3-da273b3db418) through the Platform API.\n\n#### Required Privileges\n\n**Read and Write access**\n\n- API — Use the Boomi Platform API to access account data."
},
{
"name": "Worker",
"description": "You can use the Worker object to get information about and stop a specific Runtime Worker attached to a Runtime cloud."
},
{
"name": "X12ConnectorRecord",
"description": "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.\n\n#### Required Privileges\n\nYou need these privileges in the *target environment*:\n\n**Write access**\n\n- N/A\n\n**Read access**\n\n- API — Use the Boomi Platform API to access account data."
}
],
"paths": {
"/AS2ConnectorRecord/query": {
"post": {
"tags": [
"AS2ConnectorRecord"
],
"summary": "Queries for an AS2ConnectorRecord object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAS2ConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AS2ConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AS2ConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11 \n \n \n another-value \n \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2018-07-11T06:24:12Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Send \n as2 \n Sample AS2 Connection \n Sample AS2 Operation \n 0 \n true \n 654 \n Acknowledged \n DASHER \n DANCER \n Sleigh Order 122518 \n <976473487.15.1527087239460.JavaMail.dasher@northpole> \n processed \n 484 \n 0000000122518.dat \n application/octet-stream \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2018-07-11T06:25:02Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Send \n as2 \n Sample AS2 Connection \n Sample AS2 Operation \n 49 \n true \n 654 \n Acknowledged \n DASHER \n DANCER \n Sleigh Order 122560 \n <976473487.15.1527087239502.JavaMail.dasher@northpole> \n processed \n 610 \n 0000000122560.dat \n application/octet-stream \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AS2ConnectorRecord/queryMore": {
"post": {
"tags": [
"AS2ConnectorRecord"
],
"summary": "Retrieves additional results for an AS2ConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAS2ConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AS2ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1AS2ConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AS2ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1AS2ConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Account/{id}": {
"get": {
"tags": [
"Account"
],
"summary": "Retrieves an instance of an Account object",
"description": "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.",
"operationId": "GetAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Account"
},
"example": {
"@type": "Account",
"licensing": {
"@type": "",
"standard": {
"@type": "License",
"purchased": 1000000,
"used": 60
},
"smallBusiness": {
"@type": "License",
"purchased": 1000000,
"used": 0
},
"enterprise": {
"@type": "License",
"purchased": 1000000,
"used": 0
},
"tradingPartner": {
"@type": "License",
"purchased": 100000,
"used": 3
},
"standardTest": {
"@type": "License",
"purchased": 1000,
"used": 0
},
"smallBusinessTest": {
"@type": "License",
"purchased": 1000,
"used": 0
},
"enterpriseTest": {
"@type": "License",
"purchased": 1000,
"used": 0
},
"tradingPartnerTest": {
"@type": "License",
"purchased": 1000,
"used": 0
}
},
"molecule": {
"@type": "Molecule",
"purchased": 10,
"used": 0
},
"accountId": "boomiqa-T7KIDU",
"name": "BoomiQA",
"status": "active",
"dateCreated": "2022-09-02T20:16:28Z",
"widgetAccount": false,
"supportAccess": true,
"supportLevel": "standard",
"overDeployed": false,
"expirationDate": "2016-02-13T05:00:00Z",
"suggestionsEnabled": false
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Account"
},
"example": "\n expirationDate=\"2016-03-18T05:00:00Z\" suggestionsEnabled=\"false\"\n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Account/bulk": {
"post": {
"tags": [
"Account"
],
"summary": "Retrieves multiple Account objects by identifier",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAccount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Account/query": {
"post": {
"tags": [
"Account"
],
"summary": "Queries for an Account object(s)",
"description": "The Account Query API returns accounts that were created by the parent account identified in the request URL. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAccount",
"requestBody": {
"description": " Possible properties include: ACCOUNTID, DATECREATED, EXPIRATIONDATE, NAME, STATUS, WIDGETACCOUNT, OVERDEPLOYED",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"deleted"
],
"operator": "NOT_EQUALS",
"property": "status"
},
{
"argument": [
"2014-01-01T00:00:00Z",
"2016-01-01T00:00:00Z"
],
"operator": "BETWEEN",
"property": "dateCreated"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"deleted"
],
"operator": "NOT_EQUALS",
"property": "status"
},
{
"argument": [
"2014-01-01T00:00:00Z",
"2016-01-01T00:00:00Z"
],
"operator": "BETWEEN",
"property": "dateCreated"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\ndeleted \n \n\n2014-01-01T00:00:00Z \n2016-01-01T00:00:00Z \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n deleted \n \n \n another-value \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Account/queryMore": {
"post": {
"tags": [
"Account"
],
"summary": "Retrieves additional results for an Account query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccount",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1Account~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1Account~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentProperties/{id}": {
"post": {
"tags": [
"AccountCloudAttachmentProperties"
],
"summary": "Modifies or updates an AccountCloudAttachmentProperties object",
"description": "Modifies one or more Account Cloud attachment properties. \n\n - 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](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/r-atm-Attachment_Quotas_tab_4fbc3fff-7aaf-4bbd-a2dc-25d0edb5189c) (Manage > Cloud Management) in the user interface. \n\n - To ensure a successful request, you must provide valid property names and their accepted values in the request body. Otherwise, it returns an error. \n\n - The response returns a status code of 200 indicating a successful request. To verify updates made to a property, you can make a new GET request or view the Cloud attachment quotas tab (Manage > Cloud Management) in the user interface. \n\n - To modify properties, you must be the owner of the private Runtime cloud, and both the Runtime cloud and its attachments must be online. \n\n >**Note:** The `containerId` field is required in the request body when sending a POST request. You must include the container ID (Runtime ID) of the cloud whose properties you want to modify.",
"operationId": "UpdateAccountCloudAttachmentProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the Runtime cloud. "
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentProperties"
},
"example": {
"@type": "AccountCloudAttachmentProperties",
"statusCode": "200",
"sessionId": "AccountCloudAttachmentProperties-1f23456f-a78f-91cc-012e-3e4dec5b67d8",
"containerId": "1b7a821e-2d32-4fa1-bdba-6b7caeaec33d",
"accountDiskUsage": "429496729600",
"numberofAtomWorkers": "1",
"atomInputSize": "413132133313",
"atomOutputOverflowSize": "421313313",
"atomWorkingOverflowSize": "31313313",
"httpRequestRate": "31313313",
"workerMaxExecutionTime": "30000",
"workerMaxGeneralExecutionTime": "600000",
"workerMaxRunningExecutions": "20",
"workerMaxQueuedExecutions": "10",
"workerQueuedExecutionTimeout": "10000",
"maxConnectorTrackDocs": "10000",
"httpWorkload": "LOW_LATENCY",
"as2Workload": "GENERAL",
"cloudAccountExecutionLimit": "2147383646",
"cloudAccountExecutionWarningOffset": "31313213",
"enableAtomWorkerWarmup": "false",
"minNumberofAtomWorkers": "1",
"testModeMaxDocs": "100",
"testModeMaxDocBytes": "10485760",
"enableAccountDataArchiving": "false",
"listenerMaxConcurrentExecutions": "6",
"downloadRunnerlogs": "true",
"flowControlParallelProcessTypeOverride": "NONE",
"queueIncomingMessageRateLimit": "1",
"workerElasticScalingThreshold": "1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentProperties"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentQuota": {
"post": {
"tags": [
"AccountCloudAttachmentQuota"
],
"summary": "Creates an AccountCloudAttachmentQuota object",
"description": "- 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.\n - 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.\n - CREATE and UPDATE use the same REST endpoint, as seen in the next section of sample code REST calls. When calling the endpoint for an account that has a quota set, the endpoint acts as an update and modifies the existing value, as explained in the previous item. When calling the endpoint for an account that does not already have a quota set, the endpoint creates a new quota.\n - 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.\n - The CREATE operation returns an id value that you can use in a GET operation to retrieve the existing quota for a specific account's Cloud ID.",
"operationId": "CreateAccountCloudAttachmentQuota",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": {
"accountId": "account-123456",
"cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
"maxAtomAttachment": "5"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": {
"id": "b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA",
"accountId": "account-123456",
"cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
"maxAtomAttachment": "5"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": "\n\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"AccountCloudAttachmentQuota"
],
"summary": "Modifies or updates an AccountCloudAttachmentQuota object",
"description": "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.",
"operationId": "UpdateAccountCloudAttachmentQuota",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID generated for a newly created or recently updated Cloud quota (using the Account Cloud Attachment quota object). You can use this ID to get a Cloud quota for an account's specific Cloud ID."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": {
"accountId": "account-123456",
"cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
"maxAtomAttachment": "8"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": {
"id": "b0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1HgA",
"accountId": "account-123456",
"cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
"maxAtomAttachment": "8"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuota"
},
"example": "\n\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"AccountCloudAttachmentQuota"
],
"summary": "Deletes an AccountCloudAttachmentQuota object",
"description": "Deletes a Cloud quota for a given account.",
"operationId": "DeleteAccountCloudAttachmentQuota",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID generated for a newly created or recently updated Cloud quota (using the Account Cloud Attachment quota object). You can use this ID to get a Cloud quota for an account's specific Cloud ID."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentQuota/bulk": {
"post": {
"tags": [
"AccountCloudAttachmentQuota"
],
"summary": "Retrieves multiple AccountCloudAttachmentQuota objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAccountCloudAttachmentQuota",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuotaBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuotaBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuotaBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentQuotaBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroup": {
"post": {
"tags": [
"AccountGroup"
],
"summary": "Creates an AccountGroup object",
"description": "Creates an account group based on the supplied name.",
"operationId": "CreateAccountGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": {
"accountId": "*accountId*",
"name": "TestGroup",
"autoSubscribeAlertLevel": "none",
"defaultGroup": false,
"Resources": {
"@type": "Resources",
"Resource": [
{
"@type": "Resource",
"resourceId": "ffd7622d-1f6f-4f08-9bf7-5f2f6eabbf30",
"resourceName": "Test Integration Pack",
"objectType": "Integration Pack"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": {
"@type": "AccountGroup",
"autoSubscribeAlertLevel": "none",
"defaultGroup": false,
"name": "TestGroup",
"accountId": "account-123456",
"id": "fedcba98-7654-3210-fedc-ba9876543210",
"Resources": {
"@type": "Resources",
"Resource": [
{
"@type": "Resource",
"resourceId": "ffd7622d-1f6f-4f08-9bf7-5f2f6eabbf30",
"resourceName": "Test Integration Pack",
"objectType": "Integration Pack"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroup/{id}": {
"get": {
"tags": [
"AccountGroup"
],
"summary": "Retrieves an instance of an AccountGroup object",
"description": "Returns a single Account Group object based on the supplied account group ID. \n\n >**Note:** \n Resources information is returned only for the Get operation, not the Query operation.",
"operationId": "GetAccountGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the account group."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": {
"@type": "AccountGroup",
"id": "fedcba98-7654-3210-fedc-ba9876543210",
"accountId": "account-123456",
"name": "Analyst Accounts",
"autoSubscribeAlertLevel": "none",
"defaultGroup": false,
"Resources": {
"@type": "Resources",
"Resource": [
{
"@type": "Resource",
"resourceId": "ffd7622d-1f6f-4f08-9bf7-5f2f6eabbf30",
"resourceName": "Test Integration Pack",
"objectType": "Integration Pack"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": "\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"AccountGroup"
],
"summary": "Modifies or updates an AccountGroup object",
"description": "Updates an account group based on the supplied account group ID.",
"operationId": "UpdateAccountGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the account group."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": {
"id": "fedcba98-7654-3210-fedc-ba9876543210",
"name": "TestGroupRenamed",
"accountId": "account-123456",
"autoSubscribeAlertLevel": "none",
"defaultGroup": false,
"Resources": {
"@type": "Resources",
"Resource": [
{
"@type": "Resource",
"resourceId": "ffd7622d-1f6f-4f08-9bf7-5f2f6eabbf30",
"resourceName": "Test Integration Pack",
"objectType": "Integration Pack"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": " "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": {
"@type": "AccountGroup",
"id": "fedcba98-7654-3210-fedc-ba9876543210",
"accountId": "account-123456",
"name": "TestGroupRenamed",
"autoSubscribeAlertLevel": "none",
"defaultGroup": false,
"Resources": {
"@type": "Resources",
"Resource": [
{
"@type": "Resource",
"resourceId": "ffd7622d-1f6f-4f08-9bf7-5f2f6eabbf30",
"resourceName": "Test Integration Pack",
"objectType": "Integration Pack"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroup"
},
"example": " "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroup/bulk": {
"post": {
"tags": [
"AccountGroup"
],
"summary": "Retrieves multiple AccountGroup objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAccountGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroup/query": {
"post": {
"tags": [
"AccountGroup"
],
"summary": "Queries for an AccountGroup object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAccountGroup",
"requestBody": {
"description": " Possible properties include: id, accountId, name, defaultGroup, autoSubscribeAlertLevel",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"Admins"
],
"operator": "EQUALS",
"property": "name"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"Admins"
],
"operator": "EQUALS",
"property": "name"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n Admins \n \n \n "
},
"GroupingExpression": {
"value": "\n \n Admins \n \n \n another-value \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroup/queryMore": {
"post": {
"tags": [
"AccountGroup"
],
"summary": "Retrieves additional results for an AccountGroup query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountGroup",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountGroup~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountGroup~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupAccount": {
"post": {
"tags": [
"AccountGroupAccount"
],
"summary": "Creates an AccountGroupAccount object",
"description": "Adds an account to an account group.",
"operationId": "CreateAccountGroupAccount",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccount"
},
"example": {
"accountId": "account-123456",
"accountGroupId": "fedcba98-7654-3210-fedc-ba9876543c210"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccount"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccount"
},
"example": {
"@type": "AccountGroupAccount",
"id": "gAb0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1H",
"accountGroupId": "fedcba98-7654-3210-fedc-ba9876543210",
"accountId": "account-123456"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccount"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupAccount/query": {
"post": {
"tags": [
"AccountGroupAccount"
],
"summary": "Queries for an AccountGroupAccount object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAccountGroupAccount",
"requestBody": {
"description": " Possible properties include: accountGroupId, accountId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"fedcba98-7654-3210-fedc-ba9876543c210"
],
"operator": "EQUALS",
"property": "accountGroupId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543c210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n fedcba98-7654-3210-fedc-ba9876543c210 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n fedcba98-7654-3210-fedc-ba9876543c210 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupAccount/queryMore": {
"post": {
"tags": [
"AccountGroupAccount"
],
"summary": "Retrieves additional results for an AccountGroupAccount query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountGroupAccount",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountGroupAccount~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountGroupAccount~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupAccount/{id}": {
"delete": {
"tags": [
"AccountGroupAccount"
],
"summary": "Deletes an AccountGroupAccount object",
"description": "Removes an account from an account group.",
"operationId": "DeleteAccountGroupAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The object’s conceptual ID from which the account and account group IDs synthesizes."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupUserRole": {
"post": {
"tags": [
"AccountGroupUserRole"
],
"summary": "Creates an AccountGroupUserRole object",
"description": "Adds a user to an account group.",
"operationId": "CreateAccountGroupUserRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRole"
},
"example": {
"userId": "user123@company.biz",
"accountGroupId": "fedcba98-7654-3210-fedc-ba9876543c210",
"roleId": "01234567-89ab-cdef-0123-456789abcdef",
"firstName": "John",
"lastName": "Doe",
"notifyUser": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRole"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRole"
},
"example": {
"@type": "AccountGroupUserRole",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"accountGroupId": "fedcba98-7654-3210-fedc-ba9876543c210",
"userId": "user123@company.biz",
"roleId": "01234567-89ab-cdef-0123-456789abcdef",
"firstName": "John",
"lastName": "Doe",
"notifyUser": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRole"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupUserRole/query": {
"post": {
"tags": [
"AccountGroupUserRole"
],
"summary": "Queries for an AccountGroupUserRole object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAccountGroupUserRole",
"requestBody": {
"description": " Possible properties include: accountGroupId, userId, roleId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"user123@company.biz"
],
"operator": "EQUALS",
"property": "userId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"user123@company.biz"
],
"operator": "EQUALS",
"property": "userId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n user123@company.biz \n \n \n "
},
"GroupingExpression": {
"value": "\n \n user123@company.biz \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupUserRole/queryMore": {
"post": {
"tags": [
"AccountGroupUserRole"
],
"summary": "Retrieves additional results for an AccountGroupUserRole query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountGroupUserRole",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountGroupUserRole~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupUserRoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountGroupUserRole~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupUserRole/{id}": {
"delete": {
"tags": [
"AccountGroupUserRole"
],
"summary": "Deletes an AccountGroupUserRole object",
"description": "Removes the user from an account group specified by the conceptual Account Group User Role object ID.",
"operationId": "DeleteAccountGroupUserRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountSSOConfig/{id}": {
"get": {
"tags": [
"AccountSSOConfig"
],
"summary": "Retrieves an instance of an AccountSSOConfig object",
"description": "Returns the Account Single Sign-on Configuration for the supplied account ID.",
"operationId": "GetAccountSSOConfig",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfig"
},
"example": {
"@type": "AccountSSOConfig",
"certificate": "LSO...",
"accountId": "account-123456",
"enabled": true,
"idpUrl": "http://www.testsaml.com:8080/openam_954/SSOPOST/metaAlias/idp",
"signoutRedirectUrl": "http://www.google.com",
"certInfo": "test~~Sun~~OpenSSO~~null~~null~~US~~2018-01-12T19:19:39.000Z",
"fedIdFromNameId": false,
"nameIdPolicy": "TRANSIENT",
"authnContext": "PPT",
"authnContextComparison": "EXACT",
"assertionEncryption": true,
"caseInsensitiveFederationId": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfig"
},
"example": "\n LSO... \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"AccountSSOConfig"
],
"summary": "Modifies or updates an AccountSSOConfig object",
"description": "Updates the Account Single Sign-on Configuration for the supplied account ID.",
"operationId": "UpdateAccountSSOConfig",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfig"
},
"example": {
"certificate": "LSO...",
"accountId": "account-123456",
"enabled": true,
"idpUrl": "http://www.testsaml.com:8080/openam_954/SSOPOST/metaAlias/idp",
"signoutRedirectUrl": "https://news.google.com",
"certInfo": "test~~Sun~~OpenSSO~~null~~null~~US~~2018-01-12T19:19:39.000Z",
"fedIdFromNameId": false,
"nameIdPolicy": "TRANSIENT",
"authnContext": "PPT",
"authnContextComparison": "EXACT",
"assertionEncryption": true,
"caseInsensitiveFederationId": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfig"
},
"example": "\n LSO... \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfig"
},
"example": {
"@type": "AccountSSOConfig",
"certificate": "LSO...",
"accountId": "account-123456",
"enabled": true,
"idpUrl": "http://www.testsaml.com:8080/openam_954/SSOPOST/metaAlias/idp",
"signoutRedirectUrl": "https://news.google.com",
"certInfo": "test~~Sun~~OpenSSO~~null~~null~~US~~2018-01-12T19:19:39.000Z",
"fedIdFromNameId": false,
"nameIdPolicy": "TRANSIENT",
"authnContext": "PPT",
"authnContextComparison": "EXACT",
"assertionEncryption": true,
"caseInsensitiveFederationId": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfig"
},
"example": "\n LSO...= \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"AccountSSOConfig"
],
"summary": "Deletes an AccountSSOConfig object",
"description": "Deletes the Account Single Sign-on Configuration for the supplied account ID.",
"operationId": "DeleteAccountSSOConfig",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountSSOConfig/bulk": {
"post": {
"tags": [
"AccountSSOConfig"
],
"summary": "Retrieves multiple AccountSSOConfig objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAccountSSOConfig",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfigBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfigBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfigBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountSSOConfigBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserFederation": {
"post": {
"tags": [
"AccountUserFederation"
],
"summary": "Creates an AccountUserFederation object",
"description": "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.",
"operationId": "CreateAccountUserFederation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": {
"federationId": "user123",
"userId": "user123@company.biz",
"accountId": "account-123456"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": {
"@type": "AccountUserFederation",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts",
"accountId": "account-123456",
"userId": "user123@company.biz",
"federationId": "user123"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserFederation/query": {
"post": {
"tags": [
"AccountUserFederation"
],
"summary": "Queries for an AccountUserFederation object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAccountUserFederation",
"requestBody": {
"description": " Possible properties include: accountId, userId, federationId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederationQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"user123"
],
"operator": "EQUALS",
"property": "federationId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"user123"
],
"operator": "EQUALS",
"property": "federationId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederationQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n user123 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n user123 \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserFederation/queryMore": {
"post": {
"tags": [
"AccountUserFederation"
],
"summary": "Retrieves additional results for an AccountUserFederation query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountUserFederation",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederationQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountUserFederation~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederationQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountUserFederation~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserFederation/{id}": {
"post": {
"tags": [
"AccountUserFederation"
],
"summary": "Modifies or updates an AccountUserFederation object",
"description": "Updates the federation ID of a specific user in a specific account.",
"operationId": "UpdateAccountUserFederation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": {
"accountId": "account-123456",
"userId": "user123@company.biz",
"federationId": "user456"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": {
"@type": "AccountUserFederation",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts",
"accountId": "account-123456",
"userId": "user123@company.biz",
"federationId": "user456"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserFederation"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"AccountUserFederation"
],
"summary": "Deletes an AccountUserFederation object",
"description": "Disables single sign-on for the user specified by the conceptual Account User Federation object ID.",
"operationId": "DeleteAccountUserFederation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserRole": {
"post": {
"tags": [
"AccountUserRole"
],
"summary": "Creates an AccountUserRole object",
"description": "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. \n\n 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. If you include the firstName and lastName fields in a CREATE request for a user name that exists, the request ignores those fields.",
"operationId": "CreateAccountUserRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserRole"
},
"example": {
"accountId": "account-123456",
"userId": "user123@company.biz",
"roleId": "01234567-89ab-cdef-0123-456789abcdef",
"firstName": "John",
"lastName": "Doe",
"notifyUser": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserRole"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserRole"
},
"example": {
"@type": "AccountUserRole",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"accountId": "account-123456",
"userId": "user123@company.biz",
"roleId": "01234567-89ab-cdef-0123-456789abcdef",
"firstName": "John",
"lastName": "Doe",
"notifyUser": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserRole"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserRole/query": {
"post": {
"tags": [
"AccountUserRole"
],
"summary": "Queries for an AccountUserRole object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAccountUserRole",
"requestBody": {
"description": " Possible properties include: accountId, userId, roleId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserRoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"user123@company.biz"
],
"operator": "EQUALS",
"property": "userId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"user123@company.biz"
],
"operator": "EQUALS",
"property": "userId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserRoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n user123@company.biz \n \n \n "
},
"GroupingExpression": {
"value": "\n \n user123@company.biz \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserRole/queryMore": {
"post": {
"tags": [
"AccountUserRole"
],
"summary": "Retrieves additional results for an AccountUserRole query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountUserRole",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountUserRoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountUserRole~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountUserRoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1AccountUserRole~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountUserRole/{id}": {
"delete": {
"tags": [
"AccountUserRole"
],
"summary": "Deletes an AccountUserRole object",
"description": "Removes the specified user by a specified conceptual Account User Role object ID from an account.",
"operationId": "DeleteAccountUserRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ApiUsageCount/query": {
"post": {
"tags": [
"ApiUsageCount"
],
"summary": "Queries for an ApiUsageCount object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryApiUsageCount",
"requestBody": {
"description": " Possible properties include: processDate, classification, successCount, errorCount",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUsageCountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"TEST"
],
"operator": "NOT_EQUALS",
"property": "classification"
},
{
"argument": [
"2017-09-01T00:00:00Z",
"2017-09-07T00:00:00Z"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"TEST"
],
"operator": "NOT_EQUALS",
"property": "classification"
},
{
"argument": [
"2017-09-01T00:00:00Z",
"2017-09-07T00:00:00Z"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ApiUsageCountQueryConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUsageCountQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "ApiUsageCount",
"classification": "PROD",
"processDate": "2017-09-01T04:00:00Z",
"errorCount": 0,
"successCount": 100
},
{
"@type": "ApiUsageCount",
"classification": "PROD",
"processDate": "2017-09-02T04:00:00Z",
"errorCount": 0,
"successCount": 4
},
{
"@type": "ApiUsageCount",
"classification": "PROD",
"processDate": "2017-09-03T04:00:00Z",
"errorCount": 0,
"successCount": 4
},
{
"@type": "ApiUsageCount",
"classification": "PROD",
"processDate": "2017-09-04T04:00:00Z",
"errorCount": 0,
"successCount": 100
},
{
"@type": "ApiUsageCount",
"classification": "PROD",
"processDate": "2017-09-05T04:00:00Z",
"errorCount": 0,
"successCount": 100
},
{
"@type": "ApiUsageCount",
"classification": "PROD",
"processDate": "2017-09-06T04:00:00Z",
"errorCount": 0,
"successCount": 100
}
],
"numberOfResults": 6
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ApiUsageCountQueryResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ApiUsageCount/queryMore": {
"post": {
"tags": [
"ApiUsageCount"
],
"summary": "Retrieves additional results for an ApiUsageCount query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreApiUsageCount",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUsageCountQueryResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ApiUsageCountQueryResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Atom": {
"post": {
"tags": [
"Atom"
],
"summary": "Creates a Runtime object",
"description": "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. \n\n >**Note:** The `createdBy` is a system-generated or read-only field. It cannot be passed in a CREATE request.",
"operationId": "CreateAtom",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": {
"cloudId": "23456789-abcd-ef01-2345-6789abcdef01",
"name": "Cloud Atom"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Atom/{id}": {
"get": {
"tags": [
"Atom"
],
"summary": "Retrieves an instance of a Runtime object",
"description": "Retrieves the properties of the Runtime, Runtime cluster, or Runtime cloud having the specified ID. \n\n For Runtime clusters and Runtime clouds that are part of a multi-node runtime, the GET operation returns values for the following additional variables:\n\n - *nodeId*\n - *hostName*\n - *status*\n - *clusterProblem*\n\n For more information on these variables, refer to the topic [Cluster Status panel](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/r-atm-Cluster_Status_panel_fbdb3645-00e2-4c3c-bba8-bf5fdb0f90f6).",
"operationId": "GetAtom",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID for the Runtime, Runtime cluster, or Runtime cloud."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": {
"@type": "Atom",
"id": "3456789a-bcde-f012-3456-789abcdef012",
"name": "My Local Atom",
"status": "OFFLINE",
"type": "ATOM",
"hostName": "WN7X64-11A2BB3",
"dateInstalled": "2016-02-05T14:49:21Z",
"currentVersion": "17.08.0.0",
"purgeHistoryDays": 18,
"purgeImmediate": false,
"forceRestartTime": 9
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"Atom"
],
"summary": "Modifies or updates a Runtime object",
"description": "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. \n\n >**Note:** There might be a delay before you see the changes in the Runtime Information panel.",
"operationId": "UpdateAtom",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID for the Runtime, Runtime cluster, or Runtime cloud."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": {
"id": "3456789a-bcde-f012-3456-789abcdef012",
"purgeHistoryDays": 90
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": {
"@type": "Atom",
"id": "3456789a-bcde-f012-3456-789abcdef012",
"purgeHistoryDays": 90
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Atom"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"Atom"
],
"summary": "Deletes a Runtime object",
"description": "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.",
"operationId": "DeleteAtom",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID for the Runtime, Runtime cluster, or Runtime cloud."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Atom/bulk": {
"post": {
"tags": [
"Atom"
],
"summary": "Retrieves multiple Runtime objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAtom",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Atom/query": {
"post": {
"tags": [
"Atom"
],
"summary": "Queries for a Runtime object(s)",
"description": "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. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAtom",
"requestBody": {
"description": " Possible properties include: name, id, hostname, status, type, capabilities, cloudId, attachmentCloudId, cloudMoleculeId, instanceId, isCloudAttachment",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"ONLINE"
],
"operator": "EQUALS",
"property": "status"
},
{
"argument": [
"ATOM"
],
"operator": "EQUALS",
"property": "type"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"ONLINE"
],
"operator": "EQUALS",
"property": "status"
},
{
"argument": [
"ATOM"
],
"operator": "EQUALS",
"property": "type"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\nONLINE \n \n\nATOM \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n ONLINE \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Atom/queryMore": {
"post": {
"tags": [
"Atom"
],
"summary": "Retrieves additional results for a Runtime query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAtom",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomQueryResponse"
},
"example": {
"$ref": "#/paths/~1Atom~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomQueryResponse"
},
"example": {
"$ref": "#/paths/~1Atom~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomAS2Artifacts": {
"post": {
"tags": [
"AtomAS2Artifacts"
],
"summary": "Creates an AtomAS2Artifacts object",
"description": "You can use the Download AS2 Artifacts Log operation to request and download AS2 artifacts logs.",
"operationId": "CreateAtomAS2Artifacts",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomAS2Artifacts"
},
"example": {
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"logDate": "2016-02-05"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomAS2Artifacts"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": {
"@type": "AtomAS2Artifacts",
"url": "http://localhost:8081/account/account-123456/api/download/AtomAS2Artifacts-89abcdef-0123-4567-89ab-cdef01234567",
"message": "Beginning download.",
"statusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomConnectionFieldExtensionSummary/query": {
"post": {
"tags": [
"AtomConnectionFieldExtensionSummary"
],
"summary": "Queries for an AtomConnectionFieldExtensionSummary object(s)",
"description": "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. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAtomConnectionFieldExtensionSummary",
"requestBody": {
"description": " Possible properties include: atomId, extensionGroupId, connectionId, fieldId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomConnectionFieldExtensionSummaryQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"bcdef012-3456-789a-bcde-f0123456789a"
],
"operator": "EQUALS",
"property": "connectionId"
},
{
"argument": [
"oauthOptions/OAuth2Config/credentials/@accessToken"
],
"operator": "EQUALS",
"property": "fieldId"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"bcdef012-3456-789a-bcde-f0123456789a"
],
"operator": "EQUALS",
"property": "connectionId"
},
{
"argument": [
"oauthOptions/OAuth2Config/credentials/@accessToken"
],
"operator": "EQUALS",
"property": "fieldId"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomConnectionFieldExtensionSummaryQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\n3456789a-bcde-f0123-4567-89abcdef012 \n \n\nbcdef012-3456-789a-bcde-f0123456789a \n \n\noauthOptions/OAuth2Config/credentials/@accessToken \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomConnectionFieldExtensionSummary/queryMore": {
"post": {
"tags": [
"AtomConnectionFieldExtensionSummary"
],
"summary": "Retrieves additional results for an AtomConnectionFieldExtensionSummary query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAtomConnectionFieldExtensionSummary",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomConnectionFieldExtensionSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1AtomConnectionFieldExtensionSummary~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomConnectionFieldExtensionSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1AtomConnectionFieldExtensionSummary~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomConnectorVersions/{id}": {
"get": {
"tags": [
"AtomConnectorVersions"
],
"summary": "Retrieves an instance of an AtomConnectorVersions object",
"description": "Retrieves the properties of connectors used by the Runtime, Runtime cluster, or Runtime cloud with specified ID.",
"operationId": "GetAtomConnectorVersions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the Runtime, Runtime cluster, or Runtime cloud."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomConnectorVersions"
},
"example": {
"@type": "AtomConnectorVersions",
"ConnectorVersion": [
{
"@type": "ConnectorVersion",
"name": "Disk",
"version": "16.06.2-20160512.140052-1"
},
{
"@type": "ConnectorVersion",
"name": "Atom",
"version": "16.06.2-20160511.102900-1"
},
{
"@type": "ConnectorVersion",
"name": "Platform API",
"version": "16.06.2-20160510.100150-1"
},
{
"@type": "ConnectorVersion",
"name": "Platform Partner API",
"version": "16.06.2-20160509.150052-2"
}
],
"id": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomConnectorVersions"
},
"example": "\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomConnectorVersions/bulk": {
"post": {
"tags": [
"AtomConnectorVersions"
],
"summary": "Retrieves multiple AtomConnectorVersions objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAtomConnectorVersions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomConnectorVersionsBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomConnectorVersionsBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomConnectorVersionsBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomConnectorVersionsBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomCounters/{id}": {
"post": {
"tags": [
"AtomCounters"
],
"summary": "Modifies or updates an AtomCounters object",
"description": "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.",
"operationId": "UpdateAtomCounters",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the Runtime."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomCounters"
},
"example": {
"id": "3456789a-bcde-f012-3456-789abcdef012",
"purgeHistoryDays": 90,
"@type": "AtomCounters",
"counter": [
{
"@type": "Counter",
"name": "counter1",
"value": 3
},
{
"@type": "Counter",
"name": "counter2",
"value": 4
}
],
"atomId": "d63aaa92-4520-4592-b070-3487d0e03522"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomCounters"
},
"example": "\n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomCounters"
},
"example": {
"@type": "AtomCounters",
"counter": [
{
"@type": "Counter",
"name": "counter1",
"value": 3
},
{
"@type": "Counter",
"name": "counter2",
"value": 4
}
],
"atomId": "d63aaa92-4520-4592-b070-3487d0e03522"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomCounters"
},
"example": "\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomLog": {
"post": {
"tags": [
"AtomLog"
],
"summary": "Creates an AtomLog object",
"description": "You can use the Download Atom Log operation to request and download Runtime logs.",
"operationId": "CreateAtomLog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomLog"
},
"example": {
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"logDate": "2016-02-05",
"includeBin": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomLog"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": {
"@type": "LogDownload",
"url": "http://localhost:8081/account/account-123456/api/download/AtomLog-89abcdef-0123-4567-89ab-cdef01234567",
"message": "Beginning download.",
"statusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomPurge/{id}": {
"post": {
"tags": [
"AtomPurge"
],
"summary": "Modifies or updates an AtomPurge object",
"description": "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.",
"operationId": "UpdateAtomPurge",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The unique ID assigned by the system to the Runtime cloud attachment. The Runtime ID is found in the user interface by navigating to **Manage > Runtime Management** and viewing the Runtime Information panel for a selected Runtime."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomPurge"
},
"example": {
"id": "3456789a-bcde-f012-3456-789abcdef012",
"purgeHistoryDays": 90,
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomPurge"
},
"example": "\n\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomPurge"
},
"example": {
"@type": "AtomPurge",
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomPurge"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomSecurityPolicies/{id}": {
"post": {
"tags": [
"AtomSecurityPolicies"
],
"summary": "Modifies or updates an AtomSecurityPolicies object",
"description": "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. \n As confirmation of the changes made, the UPDATE operation returns a copy of the request.",
"operationId": "UpdateAtomSecurityPolicies",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The runtime (container) id for the applicable runtime (accepts only Runtime cloud cluster and regular Runtime cluster types, no basic runtimes or cloud attachments)."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomSecurityPolicies"
},
"example": {
"atomId": "8f535694-c152-42f3-9923-2f805a17775a",
"common": {
"policies": [
{
"privilegeType": "runtimePermission",
"arguments": [
{
"value": "arg2"
}
]
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomSecurityPolicies"
},
"example": "\n\n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomSecurityPolicies"
},
"example": {
"@type": "AtomSecurityPolicies",
"common": {
"@type": "AtomSecurityPoliciesType",
"policies": [
{
"@type": "AtomSecurityPolicy",
"arguments": [
{
"@type": "AtomSecurityPolicyArgumentType",
"value": "arg2"
}
],
"privilegeType": "runtimePermission"
}
]
},
"runner": {
"@type": "AtomSecurityPoliciesType",
"policies": []
},
"worker": {
"@type": "AtomSecurityPoliciesType",
"policies": []
},
"browser": {
"@type": "AtomSecurityPoliciesType",
"policies": []
},
"atomId": "8f535694-c152-42f3-9923-2f805a17775a"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomSecurityPolicies"
},
"example": "\n\n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomStartupProperties/{id}": {
"get": {
"tags": [
"AtomStartupProperties"
],
"summary": "Retrieves an instance of an AtomStartupProperties object",
"description": "Retrieves the startup properties for the Runtime, Runtime cluster, or Runtime cloud with the specified ID.",
"operationId": "GetAtomStartupProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID for the Runtime, Runtime cluster, or Runtime cloud. (This API is not applicable for runtimes attached to clouds)"
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomStartupProperties"
},
"example": {
"@type": "Atom",
"id": "3456789a-bcde-f012-3456-789abcdef012",
"name": "My Local Atom",
"status": "OFFLINE",
"type": "ATOM",
"hostName": "WN7X64-11A2BB3",
"dateInstalled": "2016-02-05T14:49:21Z",
"currentVersion": "17.08.0.0",
"purgeHistoryDays": 18,
"purgeImmediate": false,
"forceRestartTime": 9
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomStartupProperties"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomStartupProperties/bulk": {
"post": {
"tags": [
"AtomStartupProperties"
],
"summary": "Retrieves multiple AtomStartupProperties objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAtomStartupProperties",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomStartupPropertiesBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomStartupPropertiesBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomStartupPropertiesBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomStartupPropertiesBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AtomWorkerLog": {
"post": {
"tags": [
"AtomWorkerLog"
],
"summary": "Creates an AtomWorkerLog object",
"description": "Allows users to programmatically retrieve a link for downloading a given Runtime workers log.",
"operationId": "CreateAtomWorkerLog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomWorkerLog"
},
"example": {
"workerId": "worker-1c2345c-b6e7-8f9f-01e-2345678ad91-2020.08.31"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomWorkerLog"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": {
"LogDownload": {
"url": "https://api.boomi.com/account/account-123/api/download/SoaWorkerLog-cc12c34d-56e7-89d6-b012-3bb45678a9b",
"message": "Beginning download.",
"statusCode": "202"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AuditLog/{id}": {
"get": {
"tags": [
"AuditLog"
],
"summary": "Retrieves an instance of an AuditLog object",
"description": "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.",
"operationId": "GetAuditLog",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLog"
},
"example": {
"@type": "AuditLog",
"AuditLogProperty": [
{
"@type": "AuditLogProperty",
"name": "NEW_VALUE",
"previousValue": "PREVIOUS_VALUE",
"value": "1 \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AuditLog/bulk": {
"post": {
"tags": [
"AuditLog"
],
"summary": "Retrieves multiple AuditLog objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAuditLog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AuditLogBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AuditLogBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AuditLog/query": {
"post": {
"tags": [
"AuditLog"
],
"summary": "Queries for an AuditLog object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryAuditLog",
"requestBody": {
"description": " Possible properties include: containerId, userId, date, type, action, modifier, level, source",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"as.atom"
],
"operator": "EQUALS",
"property": "type"
},
{
"argument": [
"2016-02-05T00:00:00Z",
"2016-03-04T23:59:59Z"
],
"operator": "BETWEEN",
"property": "date"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"as.atom"
],
"operator": "EQUALS",
"property": "type"
},
{
"argument": [
"2016-02-05T00:00:00Z",
"2016-03-04T23:59:59Z"
],
"operator": "BETWEEN",
"property": "date"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AuditLogQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\nas.atom \n \n\n2016-02-05T00:00:00Z \n2016-03-04T23:59:59Z \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n as.atom \n \n \n another-value \n \n \n documentId=\"XdDAzmwB7C-eRHGS1Oal\"\n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AuditLog/queryMore": {
"post": {
"tags": [
"AuditLog"
],
"summary": "Retrieves additional results for an AuditLog query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAuditLog",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogQueryResponse"
},
"example": {
"$ref": "#/paths/~1AuditLog~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AuditLogQueryResponse"
},
"example": {
"$ref": "#/paths/~1AuditLog~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Branch": {
"post": {
"tags": [
"Branch"
],
"summary": "Creates a Branch object",
"description": "- 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. \n - You can also create a branch from a packaged component. To do so, use the ID of the packaged component as the packageId. \n - To create a branch from a deployment, use the ID of the deployment for the packageId.",
"operationId": "CreateBranch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": {
"parentId": "branchId",
"name": "branchname"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": {
"@type": "Branch",
"id": "branchId",
"name": "branchname",
"createdBy": "userboomi.com",
"createdDate": "2024-02-12T21:05:27.590Z",
"parentId": "parentbranchId",
"ready": "false",
"deleted": "false",
"stage": "CREATING"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Branch/{id}": {
"get": {
"tags": [
"Branch"
],
"summary": "Retrieves an instance of a Branch object",
"description": "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.",
"operationId": "GetBranch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the branch."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": {
"Branch": {
"id": "Qjox",
"name": "main",
"createdBy": "adminboomi.com",
"createdDate": "2023-08-24T02:10:07Z",
"ready": "true",
"deleted": "false",
"stage": "NORMAL",
"description": "main branch"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": {
"@type": "Branch",
"id": "branchId",
"name": "branchname",
"createdBy": "userboomi.com",
"createdDate": "2024-02-12T21:05:28Z",
"modifiedBy": "userboomi.com",
"modifiedDate": "2024-02-14T14:20:52.402Z",
"parentId": "parentbranchId",
"ready": "true",
"deleted": "false",
"stage": "NORMAL"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Branch"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"Branch"
],
"summary": "Deletes a Branch object",
"description": "Deletes a branch",
"operationId": "DeleteBranch",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the branch."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Branch/bulk": {
"post": {
"tags": [
"Branch"
],
"summary": "Retrieves multiple Branch objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkBranch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BranchBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BranchBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Branch/query": {
"post": {
"tags": [
"Branch"
],
"summary": "Queries for a Branch object(s)",
"description": "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`. \n\n When you query a branch, it might be in one of the following states:\n - `CREATING`: The branch is being created \n - `NORMAL`: The branch is ready to use \n - `DELETING`: The branch is being deleted. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryBranch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "EQUALS",
"property": "name",
"argument": [
"branchname"
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "name",
"argument": [
"branchname"
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BranchQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n branchname \n \n \n "
},
"GroupingExpression": {
"value": "\n \n branchname \n \n \n another-value \n \n \t\t\t\t\t\t\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Branch/queryMore": {
"post": {
"tags": [
"Branch"
],
"summary": "Retrieves additional results for a Branch query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreBranch",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BranchQueryResponse"
},
"example": {
"$ref": "#/paths/~1Branch~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/BranchQueryResponse"
},
"example": {
"$ref": "#/paths/~1Branch~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/changeListenerStatus": {
"post": {
"tags": [
"Change listener status"
],
"summary": "Update listeners status",
"description": "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.",
"operationId": "UpdateListenerStatus",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeListenerStatusRequest"
},
"example": {
"ChangeListenerStatusRequest": {
"listenerId": "44e26ba5-aaf5-4e97-bc85-3e1c50a52edd",
"containerId": "d96ff19e-855d-4fd3-856b-abe2795d0dc5",
"action": "pause"
},
"listenerId": "44e26ba5-aaf5-4e97-bc85-3e1c50a52edd",
"containerId": "d96ff19e-855d-4fd3-856b-abe2795d0dc5",
"action": "pause"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ChangeListenerStatusRequest"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ClearQueue/execute/{id}": {
"post": {
"tags": [
"ClearQueue"
],
"summary": "Executes an action on a ClearQueue object",
"description": "- 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. \n - The immediate response indicates success in passing the request to the Runtime.\n - If the specified Runtime queue does not contain any messages to clear, the response only returns a success message stating that the message passed even though there is no action taken on the Runtime.\n - You can use the Get queue list API action to retrieve the number of messages in a queue, which works as an alternative way to check if the clear queue message action succeeded on the Runtime.",
"operationId": "ExecuteClearQueue",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The unique ID assigned by the system to the container. The Runtime ID for Runtimes, Runtime clusters, and Runtime clouds is found in the user interface by navigating to Manage > Runtime Management and viewing the Runtime Information panel for the selected container."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClearQueueRequest"
},
"example": {
"QueueName": "QUEUE_NAME",
"AtomId": "ATOM_ID",
"SubscriberName": "SUBSCRIBER_ID",
"DLQ": "false"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ClearQueueRequest"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClearQueueRequest"
},
"example": {
"@type": "QueueMessageResponse",
"message": "Request submitted to Request submitted to atom id: (atomId) to clear atom queue: (queue)"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ClearQueueRequest"
},
"example": "\n\n \n ...\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Cloud/bulk": {
"post": {
"tags": [
"Cloud"
],
"summary": "Retrieves multiple Cloud objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkCloud",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Cloud/query": {
"post": {
"tags": [
"Cloud"
],
"summary": "Queries for a Cloud object(s)",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryCloud",
"requestBody": {
"description": "Possible properties include: name, id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"MyCompany Cloud"
],
"operator": "EQUALS",
"property": "name"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"MyCompany Cloud"
],
"operator": "EQUALS",
"property": "name"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n MyCompany Cloud \n \n \n "
},
"GroupingExpression": {
"value": "\n \n MyCompany Cloud \n \n \n another-value \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Cloud/queryMore": {
"post": {
"tags": [
"Cloud"
],
"summary": "Retrieves additional results for a Cloud query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreCloud",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudQueryResponse"
},
"example": {
"$ref": "#/paths/~1Cloud~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudQueryResponse"
},
"example": {
"$ref": "#/paths/~1Cloud~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Component": {
"post": {
"tags": [
"Component"
],
"summary": "Creates a Component object",
"description": "- 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. \n - Request will not be processed in case if the payload has invalid attributes and tags under the section. \n - Include the `branchId` in the request body to specify a branch on which you want to create the component. \n >**Note:** To create or update a component, you must supply a valid component XML format for the given type. \n\n The component XML can be rather complex with many optional fields and nested configuration. For this reason we strongly recommend approaching it by first creating the desired component structure/skeleton as you would normally in the Build page UI, then exporting the XML using the Component object GET. This will provide an accurate example or template of the XML you will need to create. You can replace values or continue that pattern as you need for your use case.",
"operationId": "CreateComponent",
"requestBody": {
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Component"
},
"example": "\n\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t \n\t\t\n\t \n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t \n\t\t\n\t \n\t` ~ ``, it returns the specific version of the component. \n - The GET operation only accepts mediaType `application/xml` for the API response. \n - The limit is 5 requests for the BULK GET operation. All other API objects have a limit of 100 BULK GET requests. \n - If you want information for a component on a specific branch, include the branchId in the GET request: `https://api.boomi.com/api/rest/v1/{accountId}/Component/{componentId}~{branchId}`",
"operationId": "GetComponent",
"parameters": [
{
"name": "componentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service. This must be omitted for the CREATE operation but it is required for the UPDATE operation."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Component"
},
"example": {
"Component": {
"folderFullPath": "Platform APIs/Tests/Platform API Connector/AS2 Connector Record",
"componentId": "456789a-bcde-f0123-4567-89abcdef012",
"version": "1",
"name": "Receiver Encryption Public Certificate_2017",
"type": "certificate",
"createdDate": "2018-05-31T15:12:30Z",
"createdBy": "userboomi.com",
"modifiedDate": "2018-05-31T15:12:30Z",
"modifiedBy": "userboomi.com",
"deleted": "false",
"currentVersion": "true",
"folderName": "Originator",
"folderId": "RjoxNjMxNTA",
"copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
"copiedFromComponentVersion": "1",
"encryptedValues": {
"encryptedValue": {
"path": "//CertificateModel/CertificateData/text()",
"isSet": "true"
}
},
"description": null,
"object": {
"CertificateModel": {
"MD5Fingerprint": "88:44:1A:90:C7:40:DF:A4:2F:95:70:F9:88:7A:76:54",
"SHA1Fingerprint": "4B:2F:1E:A7:3C:DA:AD:F8:F2:86:38:98:25:3E:09:B4:86:5B:11:A9",
"serialNumber": "01",
"signatureAlgorithm": "SHA512withRSA",
"version": "3",
"Type": "public",
"IssuedTo": {
"commonName": "receiver",
"country": "usa",
"fullName": "CN=receiver,OU=boomi,O=dell,L=chesterbrook,ST=pa,C=usa",
"organization": "dell",
"organizationalUnit": "boomi"
},
"Issuer": {
"commonName": "receiver",
"country": "usa",
"fullName": "CN=receiver,OU=boomi,O=dell,L=chesterbrook,ST=pa,C=usa",
"organization": "dell",
"organizationalUnit": "boomi"
},
"Validity": {
"expireDate": "2024-03-12T16:46:57.000Z",
"issueDate": "2017-09-20T16:46:57.000Z"
},
"CertificateData": "12dac3f45bbaf67d89101234a3e1e567f889fcf10abaee1234ed5fab678910e123dec456789f10ddc234cc009b56d7890e1a2e345edd6c78ea9a10b234ea"
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Component"
},
"example": "\n \n \n \n \n \n public \n \n \n \n 12dac3f45bbaf67d89101234a3e1e567f889fcf10abaee1234ed5fab678910e123dec456789f10ddc234cc009b56d7890e1a2e345edd6c78ea9a10b234ea \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"Component"
],
"summary": "Modifies or updates a Component object",
"description": "- Full updates only. No partial updates. If part of the object’s configuration is omitted, the component will be updated without that configuration. \n - The only exception is for encrypted fields such as passwords. Omitting an encrypted field from the update request will NOT impact the saved value. \n - Requests without material changes to configuration will be rejected to prevent unnecessary revisions. \n - Request will not be processed in case if the payload has invalid attributes and tags under the `` section. \n - For the saved process property components, modifications to the data type are not permitted. \n - Include the `branchId` in the request body to specify the branch on which you want to update the component. \n >**Note:** To create or update a component, you must supply a valid component XML format for the given type.",
"operationId": "UpdateComponent",
"parameters": [
{
"name": "componentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service. This must be omitted for the CREATE operation but it is required for the UPDATE operation."
}
],
"requestBody": {
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Component"
},
"example": "\n\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t \n\t\t\n\t \n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t \n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t \n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t \n\t\t\t\t\t \n\t\t\t \n\t\t\n\t \n\t"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentAtomAttachment"
},
"example": {
"@type": "Component",
"folderFullPath": "Boomi/Admin",
"componentId": "bb302dbb-2e30-41a8-9e59-035f491e6da6",
"version": "1",
"name": "Process A",
"type": "process",
"createdDate": "2023-07-05T15:43:18Z",
"createdBy": "adminboomi.com",
"modifiedDate": "2023-07-05T15:43:18Z",
"modifiedBy": "adminboomi.com",
"deleted": "false",
"currentVersion": "true",
"folderName": "Admin",
"folderId": "RjozMDk2OQ",
"encryptedValues": null,
"object": {
"process": {
"xmlns": "",
"allowSimultaneous": "false",
"enableUserLog": "false",
"processLogOnErrorOnly": "false",
"purgeDataImmediately": "false",
"updateRunDates": "true",
"workload": "general",
"shapes": {
"shape": [
{
"image": "start",
"name": "shape1",
"shapetype": "start",
"userlabel": "",
"x": "96.0",
"y": "94.0",
"configuration": {
"noaction": null
},
"dragpoints": {
"dragpoint": {
"name": "shape1.dragpoint1",
"toShape": "shape2",
"x": "240.0",
"y": "120.0"
}
}
},
{
"image": "map_icon",
"name": "shape2",
"shapetype": "map",
"userlabel": "",
"x": "256.0",
"y": "112.0",
"configuration": {
"map": null
},
"dragpoints": {
"dragpoint": {
"name": "shape2.dragpoint1",
"toShape": "shape3",
"x": "368.0",
"y": "120.0"
}
}
},
{
"image": "stop_icon",
"name": "shape3",
"shapetype": "stop",
"userlabel": "",
"x": "384.0",
"y": "112.0",
"configuration": {
"stop": {
"continue": "true"
}
},
"dragpoints": null
}
]
}
}
},
"processOverrides": null
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentAtomAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentAtomAttachment/query": {
"post": {
"tags": [
"ComponentAtomAttachment"
],
"summary": "Queries for a ComponentAtomAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryComponentAtomAttachment",
"requestBody": {
"description": " Possible properties include: atomId, componentId, componentType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"3456789a-bcde-f012-3456-789abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f012-3456-789abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentAtomAttachment/queryMore": {
"post": {
"tags": [
"ComponentAtomAttachment"
],
"summary": "Retrieves additional results for a ComponentAtomAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreComponentAtomAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentAtomAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentAtomAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentAtomAttachment/{id}": {
"delete": {
"tags": [
"ComponentAtomAttachment"
],
"summary": "Deletes a ComponentAtomAttachment object",
"description": "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.",
"operationId": "DeleteComponentAtomAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentDiffRequest": {
"post": {
"tags": [
"ComponentDiffRequest"
],
"summary": "Creates a ComponentDiffRequest object",
"description": "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](https://learning.postman.com/docs/sending-requests/response-data/visualizer/).",
"operationId": "CreateComponentDiffRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequest"
},
"example": {
"componentId": "a28620b7-67e8-4ca4-b598-3863fd3b3a90",
"sourceVersion": 1,
"targetVersion": 3
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequest"
},
"example": "\n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffResponseCreate"
},
"example": {
"@type": "ComponentDiffResponse",
"message": "Diffed Versions 1 and 3 of Component: Salesforce to NetSuite (Type = process, ID = a28620b7-67e8-4ca4-b598-3863fd3b3a90)",
"GenericDiff": {
"addition": {
"total": "1",
"change": {
"type": "element",
"changedParticleName": "shape",
"elementKey": {
"elementName": "shape",
"key-part": {
"attribute": "name",
"value": "shape5"
}
},
"newValue": {
"xpath": "/Component[1]/object[1]/process[1]/shapes[1]/shape[5]",
"value": "\n \n \n \n \n \n \n <shape image=\"documentproperties_icon\" name=\"shape5\" shapetype=\"documentproperties\" userlabel=\"\" x=\"640.0\" y=\"192.0\"><configuration><documentproperties/></configuration><dragpoints><dragpoint name=\"shape5.dragpoint1\" toShape=\"shape4\" x=\"640.0\" y=\"72.0\"/></dragpoints></shape> \n \n \n \n \n \n shape5 \n shape4 \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentDiffRequest/{componentId}": {
"get": {
"tags": [
"ComponentDiffRequest"
],
"summary": "Retrieves an instance of a ComponentDiffRequest object",
"description": "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](https://learning.postman.com/docs/sending-requests/response-data/visualizer/). The Postman visualization feature currently supports only JSON responses.",
"operationId": "GetComponentDiffRequest",
"parameters": [
{
"name": "componentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the component for which you want to compare versions."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequest"
},
"example": {
"@type": "ComponentDiffResponse",
"GenericDiff": {
"@type": "GenericDiff",
"addition": {
"@type": "ChangeAggregation",
"change": [
{
"@type": "Change",
"elementKey": {
"@type": "ChangeKey",
"key-part": [
{
"@type": "KeyPair",
"attribute": "name",
"value": "shape5"
}
],
"elementName": "shape"
},
"newValue": {
"@type": "ChangeValue",
"value": "\n\n\n\n \n\n\n \n\n\n \n\n\n\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentDiffRequest/bulk": {
"post": {
"tags": [
"ComponentDiffRequest"
],
"summary": "Retrieves multiple ComponentDiffRequest objects",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkComponentDiffRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequestBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequestBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequestBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentDiffRequestBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentEnvironmentAttachment": {
"post": {
"tags": [
"ComponentEnvironmentAttachment"
],
"summary": "Creates a ComponentEnvironmentAttachment object",
"description": "Attaches a component with a specific ID to the environment with a specific ID.",
"operationId": "CreateComponentEnvironmentAttachment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachment"
},
"example": {
"folderFullPath": "Boomi/Admin",
"version": "1",
"name": "Process A",
"type": "process",
"createdDate": "2023-07-05T14:06:28Z",
"createdBy": "adminboomi.com",
"modifiedDate": "2023-07-05T14:06:28Z",
"modifiedBy": "adminboomi.com",
"deleted": "false",
"currentVersion": "true",
"folderName": "Admin",
"folderId": "RjozMDk2OQ",
"encryptedValues": null,
"description": null,
"object": {
"process": {
"xmlns": "",
"allowSimultaneous": "false",
"enableUserLog": "false",
"processLogOnErrorOnly": "false",
"purgeDataImmediately": "false",
"updateRunDates": "true",
"workload": "general",
"shapes": {
"shape": [
{
"image": "start",
"name": "shape1",
"shapetype": "start",
"userlabel": "",
"x": "96.0",
"y": "94.0",
"configuration": {
"noaction": null
},
"dragpoints": {
"dragpoint": {
"name": "shape1.dragpoint1",
"toShape": "shape2",
"x": "240.0",
"y": "120.0"
}
}
},
{
"image": "map_icon",
"name": "shape2",
"shapetype": "map",
"userlabel": "",
"x": "256.0",
"y": "112.0",
"configuration": {
"map": null
},
"dragpoints": {
"dragpoint": {
"name": "shape2.dragpoint1",
"toShape": "shape3",
"x": "368.0",
"y": "120.0"
}
}
},
{
"image": "stop_icon",
"name": "shape3",
"shapetype": "stop",
"userlabel": "",
"x": "384.0",
"y": "112.0",
"configuration": {
"stop": {
"continue": "true"
}
},
"dragpoints": null
}
]
}
}
},
"processOverrides": null
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachment"
},
"example": {
"@type": "ComponentEnvironmentAttachment",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"componentId": "56789abc-def0-1234-5678-9abcdef01234",
"componentType": "process",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentEnvironmentAttachment/query": {
"post": {
"tags": [
"ComponentEnvironmentAttachment"
],
"summary": "Queries for a ComponentEnvironmentAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryComponentEnvironmentAttachment",
"requestBody": {
"description": " Possible properties include: environmentId, componentId, componentType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"e96b6e8a-7835-40c3-9db2-37095f2e3949"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"20f3a063-e534-4e74-bc29-c2fbca583903"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"webservice"
],
"operator": "EQUALS",
"property": "componentType"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"e96b6e8a-7835-40c3-9db2-37095f2e3949"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"20f3a063-e534-4e74-bc29-c2fbca583903"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"webservice"
],
"operator": "EQUALS",
"property": "componentType"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\ne96b6e8a-7835-40c3-9db2-37095f2e3949 \n \n\nprocess \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n e96b6e8a-7835-40c3-9db2-37095f2e3949 \n \n \n another-value \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentEnvironmentAttachment/queryMore": {
"post": {
"tags": [
"ComponentEnvironmentAttachment"
],
"summary": "Retrieves additional results for a ComponentEnvironmentAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreComponentEnvironmentAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentEnvironmentAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentEnvironmentAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentEnvironmentAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentEnvironmentAttachment/{id}": {
"delete": {
"tags": [
"ComponentEnvironmentAttachment"
],
"summary": "Deletes a ComponentEnvironmentAttachment object",
"description": "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.",
"operationId": "DeleteComponentEnvironmentAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentMetadata": {
"post": {
"tags": [
"ComponentMetadata"
],
"summary": "Creates a ComponentMetadata object",
"description": "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.",
"operationId": "CreateComponentMetadata",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadata"
},
"example": {
"componentId": "ae9e0ac0-fbdf-486a-8b27-6702c82dbba0"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadata"
},
"example": "\n\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentMetadata/{id}": {
"get": {
"tags": [
"ComponentMetadata"
],
"summary": "Retrieves an instance of a ComponentMetadata object",
"description": "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.",
"operationId": "GetComponentMetadata",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadata"
},
"example": {
"@type": "ComponentMetadata",
"componentId": "456789a-bcde-f0123-4567-89abcdef012",
"version": 14,
"name": "Component123",
"type": "process",
"createdDate": "2016-11-17T19:30:39Z",
"createdBy": "johndoe@boomi.com",
"modifiedDate": "2019-04-30T15:03:44Z",
"modifiedBy": "janedoe@boomilcom",
"deleted": false,
"currentVersion": true,
"folderName": "Test Folder 1234",
"folderId": "PloxRzM5OTk",
"copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
"copiedFromComponentVersion": "6",
"branchName": "main",
"branchId": "QjoxNDMxNg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadata"
},
"example": "\n\n\t456789a-bcde-f0123-4567-89abcdef012 \n\t7 \n\tComponent123 \n\tprocess \n\tprocess \n\t2019-11-05T20:13:25Z \n\tjohndoe@boomi.com \n\t2019-11-26T21:23:55Z \n\tjanedoe@boomi.com \n\ttrue \n\tfalse \n\tBoomi \n\t\"PloxRzM5OTk\" \n\t123456a-bcde-f4567-8901-23abcdef456 \n\t6 \n main \n QjoxNDMxNg "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"ComponentMetadata"
],
"summary": "Modifies or updates a ComponentMetadata object",
"description": "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.",
"operationId": "UpdateComponentMetadata",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadata"
},
"example": {
"componentId": "ae9e0ac0-fbdf-486a-8b27-6702c82dbba0",
"name": "New Process Update"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadata"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"ComponentMetadata"
],
"summary": "Deletes a ComponentMetadata object",
"description": "Lets you delete required components. Note that deleting a component does NOT delete dependent components.",
"operationId": "DeleteComponentMetadata",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Required. Read only. The ID of the component. The component ID is available on the Revision History dialog, which you can access from the Build page in the service."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentMetadata/bulk": {
"post": {
"tags": [
"ComponentMetadata"
],
"summary": "Retrieves multiple ComponentMetadata objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkComponentMetadata",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentMetadata/query": {
"post": {
"tags": [
"ComponentMetadata"
],
"summary": "Queries for a ComponentMetadata object(s)",
"description": "- 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. \n - The `version` field must be accompanied by the `componentId` field. You can query all other fields. \n - The `copiedFromComponentId` field must accompany the `copiedFromComponentVersion` field. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryComponentMetadata",
"requestBody": {
"description": " Possible properties include: accountId, componentId, version, name, type, subType, createdDate, createdBy, modifiedDate, modifiedBy, deleted, currentVersion, folderName, folderId, copiedFromComponentId, copiedFromComponentVersion, branchName, branchId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"000b7e59-8dd6-4219-9be6-8d31512f0b66"
],
"operator": "EQUALS",
"property": "componentId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"000b7e59-8dd6-4219-9be6-8d31512f0b66"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\n456789a-bcde-f0123-4567-89abcdef012 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentMetadata/queryMore": {
"post": {
"tags": [
"ComponentMetadata"
],
"summary": "Retrieves additional results for a ComponentMetadata query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreComponentMetadata",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentMetadata~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentMetadataQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentMetadata~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentReference/{componentId}": {
"get": {
"tags": [
"ComponentReference"
],
"summary": "Retrieves an instance of a ComponentReference object",
"description": "Retrieves the component reference for a component ID. \n\n Send an HTTP GET to `https://api.boomi.com/api/rest/v1/{accountId}/ComponentReference/{componentId}`\n\nwhere `{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.\n\nIf you want to specify a branch, send an HTTP GET to `https://api.boomi.com/api/rest/v1/{accountId}/ComponentReference/{componentId}~{branchId}`\n\nwhere `{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 want to GET component references.\n\n >**Note**: If the requested `componentId` has no children or parent references, the API returns an HTTP 400 error instead of a 200 success response.",
"operationId": "GetComponentReference",
"parameters": [
{
"name": "componentId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the secondary component. The component ID is available in the **Revision History** dialog, which you can access from the **Build** page in the service."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentReference"
},
"example": {
"Component": {
"folderFullPath": "Platform APIs/Tests/Platform API Connector/AS2 Connector Record",
"componentId": "456789a-bcde-f0123-4567-89abcdef012",
"version": "1",
"name": "Receiver Encryption Public Certificate_2017",
"type": "certificate",
"createdDate": "2018-05-31T15:12:30Z",
"createdBy": "userboomi.com",
"modifiedDate": "2018-05-31T15:12:30Z",
"modifiedBy": "userboomi.com",
"deleted": "false",
"currentVersion": "true",
"folderName": "Originator",
"folderId": "RjoxNjMxNTA",
"copiedFromComponentId": "123456a-bcde-f4567-8901-23abcdef456",
"copiedFromComponentVersion": "1",
"encryptedValues": {
"encryptedValue": {
"path": "//CertificateModel/CertificateData/text()",
"isSet": "true"
}
},
"description": null,
"object": {
"CertificateModel": {
"MD5Fingerprint": "88:44:1A:90:C7:40:DF:A4:2F:95:70:F9:88:7A:76:54",
"SHA1Fingerprint": "4B:2F:1E:A7:3C:DA:AD:F8:F2:86:38:98:25:3E:09:B4:86:5B:11:A9",
"serialNumber": "01",
"signatureAlgorithm": "SHA512withRSA",
"version": "3",
"Type": "public",
"IssuedTo": {
"commonName": "receiver",
"country": "usa",
"fullName": "CN=receiver,OU=boomi,O=dell,L=chesterbrook,ST=pa,C=usa",
"organization": "dell",
"organizationalUnit": "boomi"
},
"Issuer": {
"commonName": "receiver",
"country": "usa",
"fullName": "CN=receiver,OU=boomi,O=dell,L=chesterbrook,ST=pa,C=usa",
"organization": "dell",
"organizationalUnit": "boomi"
},
"Validity": {
"expireDate": "2024-03-12T16:46:57.000Z",
"issueDate": "2017-09-20T16:46:57.000Z"
},
"CertificateData": "12dac3f45bbaf67d89101234a3e1e567f889fcf10abaee1234ed5fab678910e123dec456789f10ddc234cc009b56d7890e1a2e345edd6c78ea9a10b234ea"
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentReference"
},
"example": "\n \n \t\n \t\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentReference/bulk": {
"post": {
"tags": [
"ComponentReference"
],
"summary": "Retrieves multiple ComponentReference objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkComponentReference",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentReference/query": {
"post": {
"tags": [
"ComponentReference"
],
"summary": "Queries for a ComponentReference object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n- 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.\n\n>**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. \n\n For example, take a process that references a Map component where it references two Profile components. If you query by `parentComponentId=`, the API returns a result for the Map component but not the profiles. To get the profiles, you need to perform a second call to query references for the Map component.\n\n- You can filter the query operation in one of two ways:\n\n - To find all the secondary components referenced by a given primary component, you must provide both the parentComponentId and the parentVersion values. You can optionally use the type filter in your query.\n\n - To find all the primary components that reference a given secondary component, you must provide the componentId value. You can optionally include the type filter in your query.\n\n- To view more information about a component ID returned in the response, like the component's type or name, you can query that same ID using the [Component Metadata object](/docs/api/platformapi/ComponentMetadata).\n\n #### Understanding references to deleted components \n\n Filtering or querying by `componentId` only returns the component's current version. If you delete the current component revision, it does not return results.\n\nWhen filtering by `parentComponentId` or `parentVersion`, it saves references to other components for a given version of the primary component. If you delete the given primary component version, it does not return results. Note that it is possible to return a reference to a deleted secondary component if you do not remove the reference in the user interface (appears in red).",
"operationId": "QueryComponentReference",
"requestBody": {
"description": " Possible properties include: parentComponentId, parentVersion, componentId, type",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "componentId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\n123456a-bcde-f4567-8901-23abcdef456 \n \n\n7 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 123456a-bcde-f4567-8901-23abcdef456 \n \n \n another-value \n \n \n \t\n \t\t\n \t \n \t\n \t\t\n \t \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ComponentReference/queryMore": {
"post": {
"tags": [
"ComponentReference"
],
"summary": "Retrieves additional results for a ComponentReference query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreComponentReference",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentReference~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ComponentReferenceQueryResponse"
},
"example": {
"$ref": "#/paths/~1ComponentReference~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ConnectionLicensingReport": {
"post": {
"tags": [
"ConnectionLicensingReport"
],
"summary": "Creates a ConnectionLicensingReport object",
"description": "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: \n\n a. Send a POST and request body to `https://api.boomi.com/api/rest/v1//ConnectionLicensingReport` \n\n where accountId is the ID of the authenticating account for the request. \n\n Populate the request body with or without the available filters for the report that you want to download. \n\n b. Next, send a GET request using the URL returned in the POST response. The GET does not require a request body, and returns the deployed connection details. \n\n >**Note:** Do not pass any filters in the CREATE payload. This will not help get the Test & Production connections deployed details for all the connector classes. To get the Test and Production deployed connection details you have to pass ONLY the structure in the CREATE request, without any filters.\n\n - To apply multiple filters, add the Operator to the payload. Refer to the provided code samples for guidance.\n\n - The argument values for the *property* filters in the CREATE payload should be:\n\n - componentId - Must be a valid componentId value. If an invalid value is passed, the report or the GET response will be blank or will have zero records.\n\n - environmentId - Must be valid environmentId value. If an invalid value is passed, the report or the GET response will be blank or will have zero records.\n\n - containerId - Must be a valid atomId or moleculeId. If an invalid value is passed, the report or the GET response will be blank or will have zero records.\n\n - connectorClass - Must be valid connectorClass. Values must be either Standard, Small Business, Trading Partner, or Enterprise.",
"operationId": "CreateConnectionLicensingReport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionLicensingReport"
},
"example": {
"@type": "ConnectionLicensingReport",
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "componentId",
"argument": [
"453f8d58-fd81-4389-9150-7e7258efdc2c"
]
},
{
"operator": "EQUALS",
"property": "environmentId",
"argument": [
"891eb24b-a107-4e0f-a37a-d49b1bb1b491"
]
},
{
"operator": "EQUALS",
"property": "containerId",
"argument": [
"59e17d96-77a7-4a03-99bc-97fef80ff5cc"
]
},
{
"operator": "EQUALS",
"property": "connectorClass",
"argument": [
"small business"
]
}
]
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectionLicensingReport"
},
"example": "\n \n \n \n 453f8d58-fd81-4389-9150-7e7258efdc2c \n \n \n 891eb24b-a107-4e0f-a37a-d49b1bb1b491 \n \n \n 59e17d96-77a7-4a03-99bc-97fef80ff5cc \n \n \n small business \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionLicensingDownload"
},
"example": {
"@type": "ConnectionLicensingDownload",
"url": "https://qa.boomi.com/account/Admin-123/api/download/ConnectionLicensing-e0e1d98b-2c25-4948-aa07-6ee181547695",
"message": "Connection licensing report generation has started.",
"statusCode": "202"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectionLicensingDownload"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Connector/{connectorType}": {
"get": {
"tags": [
"Connector"
],
"summary": "Retrieves an instance of a Connector object",
"description": "You can only perform the GET operation by `type` and not by `name`. \n\n 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.\n\nFor example, sending an HTTP GET to `https://api.boomi.com/api/rest/v1/accountId/Connector/database` returns `Database` type connectors available on the account.",
"operationId": "GetConnector",
"parameters": [
{
"name": "connectorType",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The internal and unique identifier for connector type, such as `http`, `ftp`, `greatplains`. The [Component Metadata object](/docs/api/platformapi/ComponentMetadata) refers to this field as *subType*."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Connector"
},
"example": {
"@type": "Connector",
"type": "database",
"name": "Database"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Connector"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Connector/bulk": {
"post": {
"tags": [
"Connector"
],
"summary": "Retrieves multiple Connector objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkConnector",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Connector/query": {
"post": {
"tags": [
"Connector"
],
"summary": "Queries for a Connector object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryConnector",
"requestBody": {
"description": " Possible properties include: type, name",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"nestedExpression": [
{
"argument": [
"Platform Partner API"
],
"operator": "EQUALS",
"property": "name"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"nestedExpression": [
{
"argument": [
"Platform Partner API"
],
"operator": "EQUALS",
"property": "name"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorQueryConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "Connector",
"type": "boomipartnerapi",
"name": "Platform Partner API"
}
],
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorQueryResponse"
},
"example": " \n \n \n \n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Connector/queryMore": {
"post": {
"tags": [
"Connector"
],
"summary": "Retrieves additional results for a Connector query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreConnector",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorQueryResponse"
},
"example": {
"$ref": "#/paths/~1Connector~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorQueryResponse"
},
"example": {
"$ref": "#/paths/~1Connector~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ConnectorDocument": {
"post": {
"tags": [
"ConnectorDocument"
],
"summary": "Creates a ConnectorDocument object",
"description": "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.",
"operationId": "CreateConnectorDocument",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorDocument"
},
"example": {
"genericConnectorRecordId": "A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzLTQ0MmEtYjVhNS0zM2NiNDM0OTQ0ZjctMjAyMS4wMi4xNzpjb25uZWN0b3ItMTMzN2MyOWYtZDBhZC00Y2Q1LTgxYWEtMjkzNzA2NmJhZTcy"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorDocument"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorDocumentDownload"
},
"example": {
"@type": "ConnectorDocumentDownload",
"url": "https://api.boomi.com/account/boomiaccount123/api/download/ConnectorDocument-a6bc21d6-94e6-4039-8f29-g4h1094i1802",
"message": "Beginning download.",
"statusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ConnectorDocument"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/CustomTrackedField/query": {
"post": {
"tags": [
"CustomTrackedField"
],
"summary": "Queries for a CustomTrackedField object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n>**Note:** This operation doesn't accept filters because the list is constrained to 20 fields.",
"operationId": "QueryCustomTrackedField",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomTrackedFieldQueryConfig"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomTrackedFieldQueryConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomTrackedFieldQueryResponse"
},
"example": {
"numberOfResults": 5,
"@type": "QueryResult",
"result": [
{
"@type": "CustomTrackedField",
"label": "Field 1",
"type": "character",
"position": 1
},
{
"@type": "CustomTrackedField",
"label": "Field 5",
"type": "number",
"position": 5
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomTrackedFieldQueryResponse"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/CustomTrackedField/queryMore": {
"post": {
"tags": [
"CustomTrackedField"
],
"summary": "Retrieves additional results for a CustomTrackedField query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreCustomTrackedField",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomTrackedFieldQueryResponse"
},
"example": {
"$ref": "#/paths/~1CustomTrackedField~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomTrackedFieldQueryResponse"
},
"example": {
"$ref": "#/paths/~1CustomTrackedField~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedExpiredCertificate/query": {
"post": {
"tags": [
"DeployedExpiredCertificate"
],
"summary": "Queries for a DeployedExpiredCertificate object(s)",
"description": "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. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryDeployedExpiredCertificate",
"requestBody": {
"description": " Possible properties include: containerId, containerName, environmentId, environmentName, expirationBoundary",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedExpiredCertificateQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789a-bcdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"0",
"14"
],
"operator": "BETWEEN",
"property": "expirationBoundary"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789a-bcdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"0",
"14"
],
"operator": "BETWEEN",
"property": "expirationBoundary"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedExpiredCertificateQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n\n456789a-bcdef-0123-4567-89abcdef0123 \n \n\n0 \n14 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789a-bcdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedExpiredCertificate/queryMore": {
"post": {
"tags": [
"DeployedExpiredCertificate"
],
"summary": "Retrieves additional results for a DeployedExpiredCertificate query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreDeployedExpiredCertificate",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedExpiredCertificateQueryResponse"
},
"example": {
"$ref": "#/paths/~1DeployedExpiredCertificate~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedExpiredCertificateQueryResponse"
},
"example": {
"$ref": "#/paths/~1DeployedExpiredCertificate~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedPackage": {
"post": {
"tags": [
"DeployedPackage"
],
"summary": "Creates a DeployedPackage object",
"description": "You can use the CREATE operation in two ways: \n - With `environmentId` and `packageId`, CREATE deploys the specified packaged component to the identified environment. \n - With `environmentId` and `componentId`, CREATE packages with the specified component and deploys the package to the specified environment. \n >**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`.\n\n Only fields explicitly marked “Valid in request body” may be included in requests. All other fields are read-only and are returned by the API in responses.",
"operationId": "CreateDeployedPackage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackage"
},
"example": {
"environmentId": "e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2",
"packageId": "e5f2896e-5988-4d98-920e-4fb9750b469d",
"componentId": "58c53139-1e34-477f-be05-1ef8e3336adf",
"notes": "Package deployment via Rest request"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackage"
},
"example": "\n e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2 \n 6023ff5f-f28c-4a83-b714-180649da6c55 \n Create package and deploy via Rest request \n \n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackage"
},
"example": {
"@type": "DeployedPackage",
"deploymentId": "d0340bcd-066f-4ed3-a096-91e96b062d43",
"version": 4,
"packageId": "f478349c-2974-4795-81ba-e24b0b98975d",
"packageVersion": "6.0",
"environmentId": "e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2",
"componentId": "58c53139-1e34-477f-be05-1ef8e3336adf",
"componentVersion": "2.0",
"componentType": "webservice",
"deployedDate": "2017-11-01T16:44:26Z",
"deployedBy": "admin@boomi.com",
"notes": "Package deployment via Rest request",
"active": true,
"branchName": "test-branch1",
"listenerStatus": "RUNNING",
"message": "success message"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackage"
},
"example": "\n\n 5c41fbbe-be0b-4b93-95a5-1c9eadd19fac \n 2 \n eca224d9-8382-4c5d-8293-1eb077766f96 \n 2.0 \n e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2 \n 6023ff5f-f28c-4a83-b714-180649da6c55 \n 2.0 \n process \n 2017-11-16T16:10:45Z \n admin@boomi.com \n Create package and deploy via Rest request \n true \n test-branch1 \n RUNNING \n success message \n \n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedPackage/{id}": {
"get": {
"tags": [
"DeployedPackage"
],
"summary": "Retrieves an instance of a DeployedPackage object",
"description": "Returns a single Deployed Package object based on the deployment ID.",
"operationId": "GetDeployedPackage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the Deployed Package object you are attempting to GET."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackage"
},
"example": {
"@type": "DeployedPackage",
"deploymentId": "75bdf0f7-e9d5-46f7-b90f-37e77df03c0a",
"version": 3,
"packageId": "7f436a84-f9dd-4417-ac3e-ee01a1343a3b",
"packageVersion": "3.0",
"environmentId": "e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2",
"componentId": "5b4746bc-6a3e-4b18-838c-57887dae41e3",
"componentVersion": "2.0",
"componentType": "process",
"deployedDate": "2017-04-04T15:15:36Z",
"deployedBy": "admin@boomi.com",
"notes": "Deployment through API\nDeployment of version 1 from environment Test_acct_envDeployment through API\nDeployment of version 1 from environment Test_acct_env",
"active": false,
"branchName": "test-branch1",
"listenerStatus": "RUNNING",
"message": "success message"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackage"
},
"example": "\n \n 75bdf0f7-e9d5-46f7-b90f-37e77df03c0a \n 3 \n 7f436a84-f9dd-4417-ac3e-ee01a1343a3b \n 3.0 \n e7fc610a-c1ef-4b66-8bb5-a01a1f8970e2 \n 5b4746bc-6a3e-4b18-838c-57887dae41e3 \n 2.0 \n process \n 2017-04-04T15:15:36Z \n admin@boomi.com \n Deployment through API\n Deployment of version 1 from environment Test_acct_envDeployment through API\n Deployment of version 1 from environment Test_acct_env \n false \n test-branch1 \n RUNNING \n success message \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"DeployedPackage"
],
"summary": "Deletes a DeployedPackage object",
"description": "Removes the packaged component from the environment each with a specific IDs.",
"operationId": "DeleteDeployedPackage",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the Deployed Package object you are attempting to DELETE."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedPackage/bulk": {
"post": {
"tags": [
"DeployedPackage"
],
"summary": "Retrieves multiple DeployedPackage objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkDeployedPackage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedPackage/query": {
"post": {
"tags": [
"DeployedPackage"
],
"summary": "Queries for a DeployedPackage object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n>**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.",
"operationId": "QueryDeployedPackage",
"requestBody": {
"description": " Possible properties include: uid, notes, current, packageNotes, active, componentId, componentVersion, componentName, componentType, deployedBy, deployedDate, deploymentId, environmentId, environmentName, packageId, packageVersion, version, accountId, branch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"983870bd-3e41-4fcc-a622-c3cb6042d9c2"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"process"
],
"operator": "EQUALS",
"property": "componentType"
},
{
"argument": [
true
],
"operator": "EQUALS",
"property": "active"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"983870bd-3e41-4fcc-a622-c3cb6042d9c2"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"process"
],
"operator": "EQUALS",
"property": "componentType"
},
{
"argument": [
true
],
"operator": "EQUALS",
"property": "active"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 983870bd-3e41-4fcc-a622-c3cb6042d9c2 \n \n \n process \n \n \n true \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 983870bd-3e41-4fcc-a622-c3cb6042d9c2 \n \n \n another-value \n \n \n \n 8720160b-ad1a-4fcf-a36c-ed9e9a14b626 \n 1 \n 1ee2411e-00b9-4223-9882-b211ec3629f4 \n 6.0 \n 983870bd-3e41-4fcc-a622-c3cb6042d9c2 \n 5b4746bc-6a3e-4b18-838c-57887dae41e3 \n 2.0 \n process \n 2017-04-04T15:20:46Z \n admin@boomi.com \n Deployment of version 1 from environment Test_acct_envDeployment of version 1 from environment Test_acct_env \n true \n test-branch1 \n RUNNING \n success message \n ...\n \n 90d14e55-fbcc-4121-b8c5-d37bd754abab \n 4 \n 3a069907-4f55-46b4-90e8-27663d28112c \n 6.0 \n 983870bd-3e41-4fcc-a622-c3cb6042d9c2 \n 1fa6c6c7-4847-4c57-8db2-587ea53afe33 \n 2.0 \n process \n 2017-11-16T16:04:51Z \n admin@boomi.com \n Package deployment via Rest request \n true \n test-branch1 \n RUNNING \n success message \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DeployedPackage/queryMore": {
"post": {
"tags": [
"DeployedPackage"
],
"summary": "Retrieves additional results for a DeployedPackage query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreDeployedPackage",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageQueryResponse"
},
"example": {
"$ref": "#/paths/~1DeployedPackage~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeployedPackageQueryResponse"
},
"example": {
"$ref": "#/paths/~1DeployedPackage~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Deployment": {
"post": {
"tags": [
"Deployment"
],
"summary": "Creates a Deployment object",
"description": "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](https://help.boomi.com/docs/Atomsphere/Integration/AtomSphere%20API/r-atm-Packaged_Component_object_66fa92c8-948f-46c6-a521-3927ab431c84) and [Deployed Package objects](https://help.boomi.com/docs/Atomsphere/Integration/AtomSphere%20API/r-atm-Deployed_Package_object_897b5068-6daa-44e4-bf04-7e25385157a8) instead.",
"operationId": "CreateDeployment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deployment"
},
"example": {
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"componentId": "789abcde-f012-3456-789a-bcdef0123456",
"notes": "via RESTish request: Re-deployment of version 54"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Deployment"
},
"example": "\n 456789ab-cdef-0123-4567-89abcdef0123 \n 789abcde-f012-3456-789a-bcdef0123456 \n via RESTish request: Re-deployment of version 54 \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deployment"
},
"example": {
"@type": "Deployment",
"id": "89abcdef-0123-4567-89ab-cdef01234567",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"componentId": "789abcde-f012-3456-789a-bcdef0123456",
"componentType": "process",
"current": true,
"notes": "via RESTish request: Re-deployment of version 54",
"version": 55,
"deployedOn": "2013-09-23T16:33:53.413Z",
"deployedBy": "user123@company.biz"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Deployment"
},
"example": "\n 89abcdef-0123-4567-89ab-cdef01234567 \n 456789ab-cdef-0123-4567-89abcdef0123 \n 789abcde-f012-3456-789a-bcdef0123456 \n 789abcde-f012-3456-789a-bcdef0123456 \n process \n true \n via RESTish request: Re-deployment of version 54 \n 55 \n 2013-09-23T16:33:53.413Z \n user123@company.biz \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Deployment/{id}": {
"get": {
"tags": [
"Deployment"
],
"summary": "Retrieves an instance of a Deployment object",
"description": "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](https://help.boomi.com/docs/Atomsphere/Integration/AtomSphere%20API/r-atm-Packaged_Component_object_66fa92c8-948f-46c6-a521-3927ab431c84) and [Deployed Package objects](https://help.boomi.com/docs/Atomsphere/Integration/AtomSphere%20API/r-atm-Deployed_Package_object_897b5068-6daa-44e4-bf04-7e25385157a8) instead.",
"operationId": "GetDeployment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deployment"
},
"example": {
"@type": "Deployment",
"id": "89abcdef-0123-4567-89ab-cdef01234567",
"digest": "abb98d1a5b659afbe77cc361cb255c8b",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"componentId": "789abcde-f012-3456-789a-bcdef0123456",
"componentType": "process",
"current": true,
"notes": "Added Message step",
"version": 54,
"deployedOn": "2013-08-13T17:13:46Z",
"deployedBy": "user123@company.biz"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Deployment"
},
"example": "\n 89abcdef-0123-4567-89ab-cdef01234567 \n abb98d1a5b659afbe77cc361cb255c8b \n 456789ab-cdef-0123-4567-89abcdef0123 \n 789abcde-f012-3456-789a-bcdef0123456 \n true \n Added Message step \n 54 \n 2013-08-13T17:13:46Z \n user123@company.biz \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Deployment/bulk": {
"post": {
"tags": [
"Deployment"
],
"summary": "Retrieves multiple Deployment objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkDeployment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeploymentBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeploymentBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Deployment/query": {
"post": {
"tags": [
"Deployment"
],
"summary": "Queries for a Deployment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryDeployment",
"requestBody": {
"description": " Possible properties include: environmentId, processId, componentId, componentType, current",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
false
],
"operator": "EQUALS",
"property": "current"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
false
],
"operator": "EQUALS",
"property": "current"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeploymentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n 789abcde-f012-3456-789a-bcdef0123456 \n \n \n false \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n 89abcdef-0123-4567-89ab-cdef01234567 \n 456789ab-cdef-0123-4567-89abcdef0123 \n 789abcde-f012-3456-789a-bcdef0123456 \n 789abcde-f012-3456-789a-bcdef0123456 \n process \n false \n Initial \n 1 \n 2012-09-23T11:48:27Z \n user123@company.biz \n \n \n 76543210-fedc-ba98-7654-3210fedcba98 \n 456789ab-cdef-0123-4567-89abcdef0123 \n 789abcde-f012-3456-789a-bcdef0123456 \n 789abcde-f012-3456-789a-bcdef0123456 \n process \n false \n Added process properties \n 50 \n 2013-07-29T13:01:14Z \n user123@company.biz \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Deployment/queryMore": {
"post": {
"tags": [
"Deployment"
],
"summary": "Retrieves additional results for a Deployment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreDeployment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentQueryResponse"
},
"example": {
"$ref": "#/paths/~1Deployment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DeploymentQueryResponse"
},
"example": {
"$ref": "#/paths/~1Deployment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DocumentCountAccount/query": {
"post": {
"tags": [
"DocumentCountAccount"
],
"summary": "Queries for a DocumentCountAccount object(s)",
"description": "The authenticating user for a QUERY operation must have the Dashboard privilege. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryDocumentCountAccount",
"requestBody": {
"description": " Possible properties include: environmentId, atomId, processDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property ": "atomId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property ": "atomId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n 2016-05-01 \n 2016-08-31 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DocumentCountAccount/queryMore": {
"post": {
"tags": [
"DocumentCountAccount"
],
"summary": "Retrieves additional results for a DocumentCountAccount query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreDocumentCountAccount",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1DocumentCountAccount~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1DocumentCountAccount~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DocumentCountAccountGroup/query": {
"post": {
"tags": [
"DocumentCountAccountGroup"
],
"summary": "Queries for a DocumentCountAccountGroup object(s)",
"description": "- You can use the EQUALS operator only with the `accountGroupId` filter parameter. \n - The authenticating user for a QUERY operation must have the Dashboard privilege. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryDocumentCountAccountGroup",
"requestBody": {
"description": " Possible properties include: accountGroupId, processDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n fedcba98-7654-3210-fedc-ba9876543210 \n \n \n 2016-05-01 \n 2016-08-31 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n fedcba98-7654-3210-fedc-ba9876543210 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/DocumentCountAccountGroup/queryMore": {
"post": {
"tags": [
"DocumentCountAccountGroup"
],
"summary": "Retrieves additional results for a DocumentCountAccountGroup query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreDocumentCountAccountGroup",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1DocumentCountAccountGroup~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/DocumentCountAccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1DocumentCountAccountGroup~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EDIFACTConnectorRecord/query": {
"post": {
"tags": [
"EDIFACTConnectorRecord"
],
"summary": "Queries for an EDIFACTConnectorRecord object(s)",
"description": "- To filter by a customField, 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 [Custom Tracked Field object](/docs/api/platformapi/CustomTrackedField). \n - The STARTS_WITH operator accepts values that do not include spaces only. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEDIFACTConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EDIFACTConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.08.08"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.08.08"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EDIFACTConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.08.08 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.08.08 \n \n \n another-value \n \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.08.08 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2018-08-08T06:24:12Z \n connector-abcdef01-2345-6789-abcd-ef0123456789 \n Send \n edifact \n Trading Partner \n Sample EDIFACT Send Operation \n 0 \n true \n 654 \n \n 13 \n 2018-08-08T10:53:59-0400 \n sample \n \n Accepted \n Message Reference #: 1\n Acknowledgement Status: This level acknowledged, next lower level acknowledged if not explicitly rejected\n \n 12345 \n 67890 \n 4 \n INVOIC \n 1 \n 180808 \n 0624 \n 1 \n Error - Message \n Message Reference #: 1\n Validation Status: This level and all lower levels rejected\n Message: Missing\n Segment Position: 2\n Message: Unspecified error\n Data Element Error for ''\n Position in Segment: 1\n Message: notification that the length of the data element received exceeded the\n maximum length specified in the data element\n description.\n \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.08.08 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2018-08-08T06:25:02Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Send \n edifact \n Trading Partner \n Sample EDIFACT Send Operation \n 49 \n true \n 564 \n \n 55 \n 2018-08-08T10:57:14-0400 \n sample \n \n Accepted \n Message Reference #: 100\n Acknowledgement Status: This level acknowledged, next lower level acknowledged if not explicitly rejected\n \n 54321 \n 67890 \n 4 \n INVOIC \n 1 \n 180808 \n 0625 \n 1 \n Error - Message \n Message Reference #: 1\n Validation Status: This level and all lower levels rejected\n Message: Missing\n Segment Position: 2\n Message: Unspecified error\n Data Element Error for ''\n Position in Segment: 1\n Message: notification that the length of the data element received exceeded the\n maximum length specified in the data element\n description.\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EDIFACTConnectorRecord/queryMore": {
"post": {
"tags": [
"EDIFACTConnectorRecord"
],
"summary": "Retrieves additional results for an EDIFACTConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEDIFACTConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EDIFACTConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1EDIFACTConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EDIFACTConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1EDIFACTConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EdiCustomConnectorRecord/query": {
"post": {
"tags": [
"EdiCustomConnectorRecord"
],
"summary": "Queries for an EdiCustomConnectorRecord object(s)",
"description": "- To filter by a customField, use the format customFields. Use 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 [Custom Tracked Field object](/docs/api/platformapi/CustomTrackedField).\n - The STARTS_WITH operator accepts values that do not include spaces. \n - Sorting of the Query results are by the `dateProcessed` field value, from the oldest to the newest. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEdiCustomConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EdiCustomConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EdiCustomConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07 \n \n \n another-value \n \n \n \n demo-2ZR33Z \n execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07 \n 16d22e86-bc07-444b-adc8-b4a1bb1b715c \n 2025-10-07T17:47:41Z \n connector-7fdca144-5056-4110-838b-26c488277710 \n Get \n edicustom \n Start \n shape1~4d126eb9-600c-4481-90a8-2bfe79b02ade \n 2 \n true \n 340d6068-7142-468b-aafc-30006172b63d \n Simple \n Simple \n 123456789 \n DUNS \n 987654321 \n DUNS \n PurchaseOrder \n 11111 \n 10072025 \n 1347 \n 1.2 \n 675 \n \n PO01000 \n \n Custom Simple Partner \n Custom Simple MyCo \n \n \n demo-2ZR33Z \n execution-eda39aba-acee-438e-a6c0-54614e81a643-2025.10.07 \n 16d22e86-bc07-444b-adc8-b4a1bb1b715c \n 2025-10-07T17:47:41Z \n connector-7fdca144-5056-4110-838b-26c488277710 \n Get \n edicustom \n Start \n shape1~4d126eb9-600c-4481-90a8-2bfe79b02ade \n 49 \n true \n 340d6068-7142-468b-aafc-30006172b63d \n Simple \n Simple \n 123456789 \n DUNS \n 987654321 \n DUNS \n PurchaseOrder \n 11111 \n 10072025 \n 1347 \n 1.2 \n 675 \n \n PO01000 \n \n Custom Simple Partner \n Custom Simple MyCo \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EdiCustomConnectorRecord/queryMore": {
"post": {
"tags": [
"EdiCustomConnectorRecord"
],
"summary": "Retrieves additional results for an EdiCustomConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEdiCustomConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EdiCustomConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1EdiCustomConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EdiCustomConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1EdiCustomConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Environment": {
"post": {
"tags": [
"Environment"
],
"summary": "Creates an Environment object",
"description": "Creates an environment having the specified name. Environment names must be unique.",
"operationId": "CreateEnvironment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": {
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Environment/{id}": {
"get": {
"tags": [
"Environment"
],
"summary": "Retrieves an instance of an Environment object",
"description": "Retrieves the properties of the environment with a specified ID.",
"operationId": "GetEnvironment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the environment."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"Environment"
],
"summary": "Modifies or updates an Environment object",
"description": "Updates the Environment object having the specified ID. You can edit the name field only.",
"operationId": "UpdateEnvironment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the environment."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": {
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "Our Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "Our Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Environment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"Environment"
],
"summary": "Deletes an Environment object",
"description": "Deletes the Environment object with a specified ID. It is not possible to delete an environment that has attached Runtimes or integration packs.",
"operationId": "DeleteEnvironment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the environment."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Environment/bulk": {
"post": {
"tags": [
"Environment"
],
"summary": "Retrieves multiple Environment objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkEnvironment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Environment/query": {
"post": {
"tags": [
"Environment"
],
"summary": "Queries for an Environment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEnvironment",
"requestBody": {
"description": " Possible properties include: name, id, classification",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"PROD"
],
"operator": "EQUALS",
"property": "classification"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"PROD"
],
"operator": "EQUALS",
"property": "classification"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n PROD \n \n \n "
},
"GroupingExpression": {
"value": "\n \n PROD \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Environment/queryMore": {
"post": {
"tags": [
"Environment"
],
"summary": "Retrieves additional results for an Environment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1Environment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1Environment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentAtomAttachment": {
"post": {
"tags": [
"EnvironmentAtomAttachment"
],
"summary": "Creates an EnvironmentAtomAttachment object",
"description": "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. \n\n >**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.",
"operationId": "CreateEnvironmentAtomAttachment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachment"
},
"example": {
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachment"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentAtomAttachment/query": {
"post": {
"tags": [
"EnvironmentAtomAttachment"
],
"summary": "Queries for an EnvironmentAtomAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEnvironmentAtomAttachment",
"requestBody": {
"description": " Possible properties include: atomId, environmentId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentAtomAttachment/queryMore": {
"post": {
"tags": [
"EnvironmentAtomAttachment"
],
"summary": "Retrieves additional results for an EnvironmentAtomAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentAtomAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentAtomAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentAtomAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentAtomAttachment/{id}": {
"delete": {
"tags": [
"EnvironmentAtomAttachment"
],
"summary": "Deletes an EnvironmentAtomAttachment object",
"description": "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 `\n \n \n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n bcdef012-3456-789a-bcde-f0123456789a \n \n \n oauthOptions/OAuth2Config/credentials/@accessToken \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentConnectionFieldExtensionSummary/queryMore": {
"post": {
"tags": [
"EnvironmentConnectionFieldExtensionSummary"
],
"summary": "Retrieves additional results for an EnvironmentConnectionFieldExtensionSummary query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentConnectionFieldExtensionSummary",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentConnectionFieldExtensionSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentConnectionFieldExtensionSummary~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentConnectionFieldExtensionSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentConnectionFieldExtensionSummary~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentExtensions/{id}": {
"get": {
"tags": [
"EnvironmentExtensions"
],
"summary": "Retrieves an instance of an EnvironmentExtensions object",
"description": "Retrieves the extension values for the environment having the specified ID (except for encrypted values). \n\n >**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.",
"operationId": "GetEnvironmentExtensions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the object. This can be either of the following: \n 1. The value of `environmentId`. \n 2. A conceptual ID synthesized from the environment ID (`environmentId`) and the ID of the multi-install integration pack to which the extension values apply (`extensionGroupId`)."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensions"
},
"example": {
"@type": "EnvironmentExtensions",
"connections": {
"@type": "Connections",
"connection": [
{
"@type": "Connection",
"field": [
{
"@type": "Field",
"customProperties": {
"@type": "customProperties",
"properties": [
{
"@type": "PropertyPair",
"key": "plaintTextKey",
"value": "plainTextValue",
"encrypted": false
},
{
"@type": "PropertyPair",
"key": "encryptedKey",
"encrypted": true
}
]
},
"id": "port",
"value": "9090",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "host",
"value": "boomi.com",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "user",
"value": "test",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "password",
"encryptedValueSet": true,
"usesEncryption": true,
"componentOverride": false,
"useDefault": false
}
],
"id": "ff4d8765...",
"name": "New FTP Connection"
},
{
"@type": "Connection",
"field": [
{
"@type": "Field",
"id": "url",
"value": "boomi.com",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "authTokenURL2",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "accessToken2",
"encryptedValueSet": false,
"usesEncryption": true,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "refreshAuthScheme",
"value": "req_body_params_auth",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
}
],
"id": "9e9cab68...",
"name": "New HTTP Client Connection"
},
{
"@type": "Connection",
"field": [
{
"@type": "Field",
"id": "directory",
"value": "C://",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"CloudManagedSecretConfig": {
"@type": "CloudManagedSecretConfig",
"usesRemoteSecretsManager": true,
"secretsManagerType": "GCP",
"secretReference": "projects/634801617861/secrets/testQA/versions/6"
}
}
],
"id": "f8f36a2c...",
"name": "Extension Test BOOMI-194"
}
]
},
"tradingPartners": {
"@type": "TradingPartners",
"tradingPartner": [
{
"@type": "TradingPartner",
"category": [
{
"@type": "TradingPartnerCategory",
"field": [
{
"@type": "Field",
"id": "diskget-directory",
"value": "D:",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "disksend-create",
"value": "true",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
}
],
"id": "disk",
"name": "Disk"
},
{
"@type": "TradingPartnerCategory",
"field": [
{
"@type": "Field",
"id": "x12envelope-authorinfoqual",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "x12envelope-interchangeid",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "x12envelope-version",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "x12envelope-gsVersion",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "x12envelope-respagencycode",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
}
],
"id": "x12",
"name": "X12 Information"
}
],
"id": "a6b22ed0...",
"name": "Boomi - My Company"
},
{
"@type": "TradingPartner",
"category": [
{
"@type": "TradingPartnerCategory",
"field": [
{
"@type": "Field",
"id": "disksend-create",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
}
],
"id": "disk",
"name": "Disk"
},
{
"@type": "TradingPartnerCategory",
"field": [
{
"@type": "Field",
"id": "x12basic",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
},
{
"@type": "Field",
"id": "x12basic",
"encryptedValueSet": false,
"usesEncryption": false,
"componentOverride": false,
"useDefault": false
}
],
"id": "x12",
"name": "X12 Information"
}
],
"id": "67383048...",
"name": "Trading Partner"
}
]
},
"crossReferences": {
"@type": "CrossReferences",
"crossReference": [
{
"@type": "CrossReference",
"CrossReferenceRows": {
"@type": ""
},
"id": "07f7533a...",
"overrideValues": false,
"name": "Cross Reference"
},
{
"@type": "CrossReference",
"CrossReferenceRows": {
"@type": ""
},
"id": "702c5971-482d-45c3-87e1-f6d6840cf70e",
"overrideValues": false,
"name": "Cross Reference"
},
{
"@type": "CrossReference",
"CrossReferenceRows": {
"@type": "",
"row": [
{
"@type": "CrossReferenceRow",
"ref1": "13.0",
"ref2": "1",
"ref3": "6",
"ref4": "6",
"ref5": "Monthly (with 13th period)",
"ref6": "",
"ref7": "",
"ref8": "",
"ref9": "",
"ref10": "",
"ref11": "",
"ref12": "",
"ref13": "",
"ref14": "",
"ref15": "",
"ref16": "",
"ref17": "",
"ref18": "",
"ref19": "",
"ref20": ""
}
]
},
"id": "ef8147c4...",
"overrideValues": true,
"name": "TEST-3292"
}
]
},
"processProperties": {
"@type": "OverrideProcessProperties",
"ProcessProperty": [
{
"@type": "OverrideProcessProperty",
"ProcessPropertyValue": [
{
"@type": "ProcessPropertyValue",
"label": "String",
"key": "68dad3cb...",
"encryptedValueSet": false,
"useDefault": true
},
{
"@type": "ProcessPropertyValue",
"label": "Password",
"key": "af61be8f...",
"value": "",
"encryptedValueSet": false,
"useDefault": true
}
],
"id": "23a30680...",
"name": "Test Some Props Yo"
}
]
},
"properties": {
"@type": "",
"property": [
{
"@type": "",
"name": "Properties",
"value": "10/10/2020"
},
{
"@type": "",
"name": "DynamicProp",
"value": "string"
}
]
},
"PGPCertificates": {
"@type": "PGPCertificates",
"PGPCertificate": [
{
"@type": "PGPCertificate",
"id": "0a1c950d...",
"value": "e8ed9a9e...",
"useDefault": false
}
]
},
"environmentId": "4f607d09...",
"extensionGroupId": "",
"id": "4f607d09..."
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensions"
},
"example": "\n \n \n \n \n \n \n \t \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"EnvironmentExtensions"
],
"summary": "Modifies or updates an EnvironmentExtensions object",
"description": "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. \n\n >**Warning:** The UPDATE operation does not support running multiple map extensions requests concurrently. Some map extensions might not get updated properly.\n\n For GCP secret manager, the secret reference must be in the following format: `projects/${project-id}/secrets/${secret-id}/versions/${version-id}`.\n If the passed secret reference is valid, a success message is displayed. For an invalid secret reference, an error message “Invalid Secret Reference Value” is displayed.\n\n >**Note:** The user must have ADC set up on the system where the atom runtime is installed and running. For more information on GCP, refer to the [Set up ADC for a local development environment](https://cloud.google.com/docs/authentication/set-up-adc-local-dev-environment) topic.\n#### Performing a partial update\n\n \nTo perform a **partial update**, set `partial` to true and then provide only the extension fields and values that you wish to update in the request.\n\n>**Note:** For cross reference tables, you can update a single cross reference table. However, you must provide all values for the entire table. You cannot update individual rows within a table.\n>\n> - For process property components, you can update a single process property component but you must provide the values for all properties in the component. \n>\n> - When performing a partial update, if `useDefault` is set to false, you must provide values to the `value` field. Otherwise, the previously overridden values will continue to be used. \n\n #### Performing a full update\n\nTo perform a **full update**, set `partial` to false and then provide all the environment extension fields and values in the request, regardless if you wish to change only some values but not all.\n\n>**Caution:** Values not included in the request are reset to use their default values. If you omit the partial attribute, the behavior defaults to a full update. \n\n ",
"operationId": "UpdateEnvironmentExtensions",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the object. This can be either of the following: \n 1. The value of environmentId. \n 2. A conceptual ID synthesized from the environment ID (environmentId) and the ID of the multi-install integration pack to which the extension values apply (extensionGroupId)."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensions"
},
"example": {
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "Our Production Environment",
"classification": "PROD",
"EnvironmentExtensions": {
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"extensionGroupId": "2545e8cb-3162-4729-8dff-3a8ccfc48933",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"partial": "false",
"connections": {
"connection": [
{
"name": "Local MySql",
"id": "9ba5dfab-8781-4e6a-b908-0c7a7797d17a",
"field": [
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "exhaustedAction",
"useDefault": "true",
"customProperties": {
"properties": [
{
"key": "plainTextKey",
"value": "plainTextValue",
"encrypted": "false"
},
{
"key": "encryptedKey",
"value": "encryptedValue",
"encrypted": "true"
}
]
}
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "driverId",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "driverId",
"useDefault": "true"
}
]
},
{
"name": "AndLinux - Datadump",
"id": "e3aeadb7-ee49-4596-9e8f-22c04724c88d",
"field": {
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "directory",
"value": "mydirectory",
"useDefault": "true"
}
},
{
"name": "New QuickBooks Connection",
"id": "c9f59f09-e592-4dae-98b9-ddf1e3512f53",
"field": [
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "appName",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "companyFileName",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "true",
"encryptedValueSet": "false",
"id": "toBeEncrypted",
"value": "toBeEncrypted",
"useDefault": "true"
},
{
"@type": "Field",
"CloudManagedSecretConfig": {
"@type": "CloudManagedSecretConfig",
"usesRemoteSecretsManager": true,
"secretsManagerType": "GCP",
"secretReference": "projects/634801617861/secrets/testQA/versions/6"
}
}
]
}
]
},
"operations": {
"operation": {
"id": "2b9a80d2-103d-4eba-8b61-b7401ab76cf8",
"name": "WebService Operation",
"field": {
"componentOverride": "false",
"encryptedValueSet": "false",
"id": "ObjectName",
"usesEncryption": "false",
"value": "Updated",
"useDefault": "true"
}
}
},
"tradingPartners": {
"tradingPartner": {
"name": "My Company",
"id": "19b261d1-70d3-45a7-bd48-ae7c7df5ea7e",
"category": [
{
"name": "AS2",
"id": "as2",
"field": [
{
"componentOverride": "true",
"usesEncryption": "false",
"encryptedValueSet": "false",
"value": "85166fdd-946e-42c7-9264-2b6db77d2d35",
"id": "as2identity-encryptAlias",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"value": "",
"id": "as2identity-as2Id",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "as2identity-mdnAlias",
"useDefault": "true"
}
]
},
{
"name": "X12 Information",
"id": "x12",
"field": [
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "x12envelope-interchangeid",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "x12envelope-securityinfo",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "x12envelope-version",
"useDefault": "true"
}
]
}
]
}
},
"sharedCommunications": {
"sharedCommunication": {
"id": "54748ce7-fd92-434c-8db3-2717b44b2692",
"name": "Best Enterprises MyCo",
"type": "http",
"field": [
{
"id": "http-trustedcertalias",
"encryptedValueSet": "false",
"usesEncryption": "false",
"componentOverride": "false",
"value": "usercred",
"useDefault": "true"
},
{
"id": "http-password",
"encryptedValueSet": "false",
"usesEncryption": "true",
"componentOverride": "false",
"value": "toBeEncrypted",
"useDefault": "true"
},
{
"id": "http-clientId",
"encryptedValueSet": "false",
"usesEncryption": "false",
"componentOverride": "false",
"value": "id123",
"useDefault": "true"
},
{
"id": "http-user",
"encryptedValueSet": "false",
"usesEncryption": "false",
"componentOverride": "false",
"value": "admin",
"useDefault": "true"
}
]
}
},
"crossReferences": {
"crossReference": {
"name": "My Cross Reference",
"overrideValues": "true",
"id": "a6759305-9ed9-47d4-a76f-2ba227454d18",
"CrossReferenceRows": {
"row": [
{
"ref3": "3",
"ref2": "2",
"ref1": "1"
},
{
"ref3": "1",
"ref2": "34",
"ref1": "12"
},
{
"ref3": "2",
"ref2": "1",
"ref1": "3"
}
]
}
}
},
"processProperties": {
"ProcessProperty": {
"name": "Test Process Property",
"id": "5399215e-3cc8-4006-bfe7-c3ae71df6c26",
"ProcessPropertyValue": [
{
"encryptedValueSet": "false",
"value": "300",
"key": "new-1355426770730",
"label": "First",
"useDefault": "true"
},
{
"encryptedValueSet": "false",
"value": "400",
"key": "new-1355426788553",
"label": "Second",
"useDefault": "true"
}
]
}
},
"properties": {
"property": [
{
"name": "reference",
"value": "myNewreference"
},
{
"name": "baseURL",
"value": "myurl"
},
{
"name": "datetime",
"value": "20110111"
}
]
},
"PGPCertificates": {
"PGPCertificate": {
"id": "6a9cb126-57ef-44e1-b30b-7770f4b803b6",
"value": "Production Certificate"
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensions"
},
"example": "\n \n \n \n \n \n \t \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensions"
},
"example": {
"@type": "EnvironmentExtensions",
"processProperties": {
"@type": "OverrideProcessProperties",
"ProcessProperty": [
{
"@type": "OverrideProcessProperty",
"ProcessPropertyValue": [
{
"@type": "ProcessPropertyValue",
"label": "String",
"key": "68dad3cb...",
"value": "Partialupdates",
"encryptedValueSet": false,
"useDefault": false
},
{
"@type": "ProcessPropertyValue",
"label": "Password",
"key": "af61be8f...",
"value": "PasswordUpdated",
"encryptedValueSet": false,
"useDefault": false
}
],
"id": "23a30680...",
"name": "Test Some Props Yo"
}
]
},
"environmentId": "456789ab...",
"extensionGroupId": "",
"id": "6f678d09...",
"partial": true,
"EnvironmentExtensions": {
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"extensionGroupId": "2545e8cb-3162-4729-8dff-3a8ccfc48933",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"partial": "false",
"connections": {
"connection": [
{
"name": "Local MySql",
"id": "9ba5dfab-8781-4e6a-b908-0c7a7797d17a",
"field": [
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "exhaustedAction",
"useDefault": "true",
"customProperties": {
"properties": [
{
"key": "plainTextKey",
"value": "plainTextValue",
"encrypted": "false"
},
{
"key": "encryptedKey",
"value": "encryptedValue",
"encrypted": "true"
}
]
}
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "driverId",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "driverId",
"useDefault": "true"
}
]
},
{
"name": "AndLinux - Datadump",
"id": "e3aeadb7-ee49-4596-9e8f-22c04724c88d",
"field": {
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "directory",
"value": "mydirectory",
"useDefault": "true"
}
},
{
"name": "New QuickBooks Connection",
"id": "c9f59f09-e592-4dae-98b9-ddf1e3512f53",
"field": [
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "appName",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "companyFileName",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "true",
"encryptedValueSet": "true",
"id": "toBeEncrypted",
"useDefault": "true"
},
{
"@type": "Field",
"CloudManagedSecretConfig": {
"@type": "CloudManagedSecretConfig",
"usesRemoteSecretsManager": true,
"secretsManagerType": "GCP",
"secretReference": "projects/634801617861/secrets/testQA/versions/6"
}
}
]
}
]
},
"operations": {
"operation": {
"id": "2b9a80d2-103d-4eba-8b61-b7401ab76cf8",
"name": "WebService Operation",
"field": {
"componentOverride": "false",
"encryptedValueSet": "false",
"id": "ObjectName",
"usesEncryption": "false",
"value": "Updated",
"useDefault": "true"
}
}
},
"tradingPartners": {
"tradingPartner": {
"name": "My Company",
"id": "19b261d1-70d3-45a7-bd48-ae7c7df5ea7e",
"category": [
{
"name": "AS2",
"id": "as2",
"field": [
{
"componentOverride": "true",
"usesEncryption": "false",
"encryptedValueSet": "false",
"value": "85166fdd-946e-42c7-9264-2b6db77d2d35",
"id": "as2identity-encryptAlias",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"value": "",
"id": "as2identity-as2Id",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "as2identity-mdnAlias",
"useDefault": "true"
}
]
},
{
"name": "X12 Information",
"id": "x12",
"field": [
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "x12envelope-interchangeid",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "x12envelope-securityinfo",
"useDefault": "true"
},
{
"componentOverride": "false",
"usesEncryption": "false",
"encryptedValueSet": "false",
"id": "x12envelope-version",
"useDefault": "true"
}
]
}
]
}
},
"sharedCommunications": {
"sharedCommunication": {
"id": "54748ce7-fd92-434c-8db3-2717b44b2692",
"name": "Best Enterprises MyCo",
"type": "http",
"field": [
{
"id": "http-trustedcertalias",
"encryptedValueSet": "false",
"usesEncryption": "false",
"componentOverride": "false",
"value": "usercred",
"useDefault": "true"
},
{
"id": "http-password",
"encryptedValueSet": "true",
"usesEncryption": "true",
"componentOverride": "false",
"useDefault": "true"
},
{
"id": "http-clientId",
"encryptedValueSet": "false",
"usesEncryption": "false",
"componentOverride": "false",
"value": "id123",
"useDefault": "true"
},
{
"id": "http-user",
"encryptedValueSet": "false",
"usesEncryption": "false",
"componentOverride": "false",
"value": "admin",
"useDefault": "true"
}
]
}
},
"crossReferences": {
"crossReference": {
"name": "My Cross Reference",
"overrideValues": "true",
"id": "a6759305-9ed9-47d4-a76f-2ba227454d18",
"CrossReferenceRows": {
"row": [
{
"ref3": "3",
"ref2": "2",
"ref1": "1"
},
{
"ref3": "1",
"ref2": "34",
"ref1": "12"
},
{
"ref3": "2",
"ref2": "1",
"ref1": "3"
}
]
}
}
},
"processProperties": {
"ProcessProperty": {
"name": "Test Process Property",
"id": "5399215e-3cc8-4006-bfe7-c3ae71df6c26",
"ProcessPropertyValue": [
{
"encryptedValueSet": "false",
"value": "300",
"key": "new-1355426770730",
"label": "First",
"useDefault": "true"
},
{
"encryptedValueSet": "false",
"value": "400",
"key": "new-1355426788553",
"label": "Second",
"useDefault": "true"
}
]
}
},
"properties": {
"property": [
{
"name": "reference",
"value": "myNewreference"
},
{
"name": "baseURL",
"value": "myurl"
},
{
"name": "datetime",
"value": "20110111"
}
]
},
"PGPCertificates": {
"PGPCertificate": {
"id": "6a9cb126-57ef-44e1-b30b-7770f4b803b6",
"value": "Production Certificate"
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensions"
},
"example": "\n \n \n \n \n \t \n \t \t \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentExtensions/bulk": {
"post": {
"tags": [
"EnvironmentExtensions"
],
"summary": "Retrieves multiple EnvironmentExtensions objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkEnvironmentExtensions",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentExtensions/query": {
"post": {
"tags": [
"EnvironmentExtensions"
],
"summary": "Queries for an EnvironmentExtensions object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n **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.",
"operationId": "QueryEnvironmentExtensions",
"requestBody": {
"description": " Possible properties include: environmentId, extensionGroupId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "environmentId",
"argument": [
"d806057a-9a6e-4b10-85df-c648dcc16abe"
]
},
{
"operator": "EQUALS",
"property": "extensionGroupId",
"argument": [
"2545e8cb-3162-4729-8dff-3a8ccfc48933"
]
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "environmentId",
"argument": [
"d806057a-9a6e-4b10-85df-c648dcc16abe"
]
},
{
"operator": "EQUALS",
"property": "extensionGroupId",
"argument": [
"2545e8cb-3162-4729-8dff-3a8ccfc48933"
]
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n d806057a-9a6e-4b10-85df-c648dcc16abe \n \n \n 2545e8cb-3162-4729-8dff-3a8ccfc48933 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n d806057a-9a6e-4b10-85df-c648dcc16abe \n \n \n another-value \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentExtensions/queryMore": {
"post": {
"tags": [
"EnvironmentExtensions"
],
"summary": "Retrieves additional results for an EnvironmentExtensions query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentExtensions",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentExtensions~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentExtensionsQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentExtensions~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtension/{id}": {
"get": {
"tags": [
"EnvironmentMapExtension"
],
"summary": "Retrieves an instance of an EnvironmentMapExtension object",
"description": "Retrieves an extensible map by its Environment Map Extension object ID. \n\n >**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.",
"operationId": "GetEnvironmentMapExtension",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": {
"EnvironmentMapExtension": {
"name": "Account - Customer",
"mapId": "01234567890123456789012345",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"extensionGroupId": "",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"Map": {
"SourceProfile": {
"componentId": "ef012345-6789-abcd-ef01-23456789abcd",
"Node": [
{
"xpath": "",
"name": "Account"
},
{
"xpath": "/CustomerNum",
"name": "CustomerNum"
},
{
"xpath": "/CustomerName",
"name": "CustomerName"
},
{
"xpath": "/Website",
"name": "Website"
},
{
"xpath": "/StreetAddress1",
"name": "StreetAddress1"
},
{
"xpath": "/StreetAddress2",
"name": "StreetAddress2"
},
{
"xpath": "/City",
"name": "City"
},
{
"xpath": "/State",
"name": "State"
},
{
"xpath": "/Zip",
"name": "Zip"
},
{
"xpath": "/Country",
"name": "Country"
},
{
"xpath": "/Phone",
"name": "Phone"
}
]
},
"DestinationProfile": {
"componentId": "dcba9876-5432-10fe-dcba-9876543210fe",
"Node": [
{
"xpath": "",
"name": "CustomerAddRq"
},
{
"xpath": "/CustomerAdd",
"name": "CustomerAdd"
},
{
"xpath": "/CustomerAdd/Name",
"name": "Name"
},
{
"xpath": "/CustomerAdd/IsActive",
"name": "IsActive"
},
{
"xpath": "/CustomerAdd/ParentRef",
"name": "ParentRef"
},
{
"xpath": "/CustomerAdd/ParentRef/ListID",
"name": "ListID"
},
{
"xpath": "/CustomerAdd/ParentRef/FullName",
"name": "FullName"
},
{
"xpath": "/CustomerAdd/CompanyName",
"name": "CompanyName"
},
{
"xpath": "/CustomerAdd/Salutation",
"name": "Salutation"
},
{
"xpath": "/CustomerAdd/FirstName",
"name": "FirstName"
},
{
"xpath": "/CustomerAdd/MiddleName",
"name": "MiddleName"
},
{
"xpath": "/CustomerAdd/LastName",
"name": "LastName"
},
{
"xpath": "/CustomerAdd/Suffix",
"name": "Suffix"
},
{
"xpath": "/CustomerAdd/BillAddress",
"name": "BillAddress"
},
{
"xpath": "/CustomerAdd/BillAddress/Addr1",
"name": "Addr1"
},
{
"xpath": "/CustomerAdd/BillAddress/Addr2",
"name": "Addr2"
},
{
"xpath": "/CustomerAdd/BillAddress/City",
"name": "City"
},
{
"xpath": "/CustomerAdd/BillAddress/State",
"name": "State"
},
{
"xpath": "/CustomerAdd/BillAddress/PostalCode",
"name": "PostalCode"
},
{
"xpath": "/CustomerAdd/BillAddress/Country",
"name": "Country"
},
{
"xpath": "/CustomerAdd/BillAddress/Note",
"name": "Note"
},
{
"xpath": "/CustomerAdd/ShipAddress",
"name": "ShipAddress"
},
{
"xpath": "/CustomerAdd/ShipAddress/Addr1",
"name": "Addr1"
},
{
"xpath": "/CustomerAdd/ShipAddress/Addr2",
"name": "Addr2"
},
{
"xpath": "/CustomerAdd/ShipAddress/City",
"name": "City"
},
{
"xpath": "/CustomerAdd/ShipAddress/State",
"name": "State"
},
{
"xpath": "/CustomerAdd/ShipAddress/PostalCode",
"name": "PostalCode"
},
{
"xpath": "/CustomerAdd/ShipAddress/Country",
"name": "Country"
},
{
"xpath": "/CustomerAdd/ShipAddress/Note",
"name": "Note"
},
{
"xpath": "/CustomerAdd/Phone",
"name": "Phone"
},
{
"xpath": "/CustomerAdd/Mobile",
"name": "Mobile"
},
{
"xpath": "/CustomerAdd/Email",
"name": "Email"
},
{
"xpath": "/CustomerAdd/Contact",
"name": "Contact"
}
]
},
"ExtendedFunctions": {
"Function": {
"type": "StringAppend",
"id": "FUNCEXT--012345678",
"cacheType": "ByDocument",
"Inputs": {
"Input": [
{
"key": "1",
"name": "Original String",
"default": ""
},
{
"key": "2",
"name": "Fix to Length",
"default": ""
},
{
"key": "3",
"name": "Char to Append",
"default": "-9999"
}
]
},
"Outputs": {
"Output": {
"key": "1",
"name": "Result"
}
},
"Configuration": null
}
},
"ExtendedMappings": {
"Mapping": [
{
"fromXPath": "/StreetAddress1",
"toXPath": "/CustomerAdd/ShipAddress/Addr1"
},
{
"fromXPath": "/StreetAddress2",
"toXPath": "/CustomerAdd/ShipAddress/Addr2"
},
{
"fromXPath": "/Zip",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
},
{
"toFunction": "FUNCEXT--012345678",
"fromXPath": "/Zip",
"toXPath": "1"
},
{
"fromFunction": "FUNCEXT--012345678",
"fromXPath": "1",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
}
]
},
"SourceProfileExtensions": {
"Node": [
{
"xpath": "",
"name": "Account",
"Character": null
},
{
"xpath": "/CustomerNum",
"name": "CustomerNum",
"Character": null
},
{
"xpath": "/CustomerName",
"name": "CustomerName",
"Character": null
},
{
"xpath": "/StreetAddress1",
"name": "StreetAddress1",
"Character": null
},
{
"xpath": "/StreetAddress2",
"name": "StreetAddress2",
"Character": null
},
{
"xpath": "/City",
"name": "City",
"Character": null
},
{
"xpath": "/State",
"name": "State",
"Character": null
},
{
"xpath": "/Zip",
"name": "Zip",
"Character": null
}
]
},
"DestinationProfileExtensions": [
null,
null
]
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"EnvironmentMapExtension"
],
"summary": "Modifies or updates an EnvironmentMapExtension object",
"description": "Updates the extended mapping configuration for the specified Environment Map Extension object ID.",
"operationId": "UpdateEnvironmentMapExtension",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": {
"name": "Account - Customer",
"mapId": "01234567890123456789012345",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"extensionGroupId": "",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"Map": {
"ExtendedFunctions": {
"Function": {
"type": "StringAppend",
"id": "FUNCEXT--012345678",
"cacheType": "ByDocument",
"Inputs": {
"Input": [
{
"key": "1",
"name": "Original String",
"default": ""
},
{
"key": "2",
"name": "Fix to Length",
"default": ""
},
{
"key": "3",
"name": "Char to Append",
"default": "-0000"
}
]
},
"Outputs": {
"Output": {
"key": "1",
"name": "Result"
}
},
"Configuration": null
}
},
"ExtendedMappings": {
"Mapping": [
{
"fromXPath": "/StreetAddress1",
"toXPath": "/CustomerAdd/ShipAddress/Addr1"
},
{
"fromXPath": "/StreetAddress2",
"toXPath": "/CustomerAdd/ShipAddress/Addr2"
},
{
"fromXPath": "/City",
"toXPath": "/CustomerAdd/ShipAddress/City"
},
{
"fromXPath": "/State",
"toXPath": "/CustomerAdd/ShipAddress/State"
},
{
"fromXPath": "/Zip",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
},
{
"fromXPath": "/Country",
"toXPath": "/CustomerAdd/ShipAddress/Country"
},
{
"toFunction": "FUNCEXT--012345678",
"fromXPath": "/Zip",
"toXPath": "1"
},
{
"fromFunction": "FUNCEXT--012345678",
"fromXPath": "1",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
}
]
},
"SourceProfileExtensions": {
"Node": [
{
"xpath": "",
"name": "Account",
"Character": null
},
{
"xpath": "/CustomerNum",
"name": "CustomerNum",
"Character": null
},
{
"xpath": "/CustomerName",
"name": "CustomerName",
"Character": null
},
{
"xpath": "/StreetAddress1",
"name": "StreetAddress1",
"Character": null
},
{
"xpath": "/StreetAddress2",
"name": "StreetAddress2",
"Character": null
},
{
"xpath": "/City",
"name": "City",
"Character": null
},
{
"xpath": "/State",
"name": "State",
"Character": null
},
{
"xpath": "/Zip",
"name": "Zip",
"Character": null
}
]
},
"DestinationProfileExtensions": [
null,
null
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "Our Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtension/bulk": {
"post": {
"tags": [
"EnvironmentMapExtension"
],
"summary": "Retrieves multiple EnvironmentMapExtension objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkEnvironmentMapExtension",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtension/execute/{id}": {
"post": {
"tags": [
"EnvironmentMapExtension"
],
"summary": "Executes an action on an EnvironmentMapExtension object",
"description": "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.\n\n 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. If you have the Runtime Management Read Access privilege, you cannot post connection credentials. \n\n For information about using these operations to retrieve or update map functions, refer to [Environment Map Extension functions](https://developer.boomi.com/docs/APIs/PlatformAPI/APIReference/Environment_Map_Extension_functions). \n\n Include the `SourceBrowse` and `DestinationBrowse` sections as appropriate to browse the respective profile and include the required BrowseFields for the given connector. If you need to call the EXECUTE action repeatedly for the same map, you can alternatively use the `sessionId` to avoid having to supply the connector fields in subsequent calls. Session caching lasts about 30 minutes.",
"operationId": "ExecuteEnvironmentMapExtension",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": {
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"Map": {
"BrowseSettings": {
"containerId": "1f4adef0-47f1-4129-aed8-1e687ab450c9",
"DestinationBrowse": {
"BrowseFields": {
"name": "password",
"value": "supersecretpassword123"
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": "\n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": {
"@type": "EnvironmentMapExtension",
"name": "Account - Customer",
"mapId": "01234567890123456789012345",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"extensionGroupId": "",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"Map": {
"SourceProfile": {
"componentId": "ef012345-6789-abcd-ef01-23456789abcd",
"Node": [
{
"xpath": "",
"name": "Account"
},
{
"xpath": "/CustomerNum",
"name": "CustomerNum"
},
{
"xpath": "/CustomerName",
"name": "CustomerName"
},
{
"xpath": "/Website",
"name": "Website"
},
{
"xpath": "/StreetAddress1",
"name": "StreetAddress1"
},
{
"xpath": "/StreetAddress2",
"name": "StreetAddress2"
},
{
"xpath": "/City",
"name": "City"
},
{
"xpath": "/State",
"name": "State"
},
{
"xpath": "/Zip",
"name": "Zip"
},
{
"xpath": "/Country",
"name": "Country"
},
{
"xpath": "/Phone",
"name": "Phone"
}
]
},
"DestinationProfile": {
"componentId": "dcba9876-5432-10fe-dcba-9876543210fe",
"Node": [
{
"xpath": "",
"name": "CustomerAddRq"
},
{
"xpath": "/CustomerAdd",
"name": "CustomerAdd"
},
{
"xpath": "/CustomerAdd/Name",
"name": "Name"
},
{
"xpath": "/CustomerAdd/IsActive",
"name": "IsActive"
},
{
"xpath": "/CustomerAdd/ParentRef",
"name": "ParentRef"
},
{
"xpath": "/CustomerAdd/ParentRef/ListID",
"name": "ListID"
},
{
"xpath": "/CustomerAdd/ParentRef/FullName",
"name": "FullName"
},
{
"xpath": "/CustomerAdd/CompanyName",
"name": "CompanyName"
},
{
"xpath": "/CustomerAdd/Salutation",
"name": "Salutation"
},
{
"xpath": "/CustomerAdd/FirstName",
"name": "FirstName"
},
{
"xpath": "/CustomerAdd/MiddleName",
"name": "MiddleName"
},
{
"xpath": "/CustomerAdd/LastName",
"name": "LastName"
},
{
"xpath": "/CustomerAdd/Suffix",
"name": "Suffix"
},
{
"xpath": "/CustomerAdd/BillAddress",
"name": "BillAddress"
},
{
"xpath": "/CustomerAdd/BillAddress/Addr1",
"name": "Addr1"
},
{
"xpath": "/CustomerAdd/BillAddress/Addr2",
"name": "Addr2"
},
{
"xpath": "/CustomerAdd/BillAddress/City",
"name": "City"
},
{
"xpath": "/CustomerAdd/BillAddress/State",
"name": "State"
},
{
"xpath": "/CustomerAdd/BillAddress/PostalCode",
"name": "PostalCode"
},
{
"xpath": "/CustomerAdd/BillAddress/Country",
"name": "Country"
},
{
"xpath": "/CustomerAdd/BillAddress/Note",
"name": "Note"
},
{
"xpath": "/CustomerAdd/ShipAddress",
"name": "ShipAddress"
},
{
"xpath": "/CustomerAdd/ShipAddress/Addr1",
"name": "Addr1"
},
{
"xpath": "/CustomerAdd/ShipAddress/Addr2",
"name": "Addr2"
},
{
"xpath": "/CustomerAdd/ShipAddress/City",
"name": "City"
},
{
"xpath": "/CustomerAdd/ShipAddress/State",
"name": "State"
},
{
"xpath": "/CustomerAdd/ShipAddress/PostalCode",
"name": "PostalCode"
},
{
"xpath": "/CustomerAdd/ShipAddress/Country",
"name": "Country"
},
{
"xpath": "/CustomerAdd/ShipAddress/Note",
"name": "Note"
},
{
"xpath": "/CustomerAdd/Phone",
"name": "Phone"
},
{
"xpath": "/CustomerAdd/Mobile",
"name": "Mobile"
},
{
"xpath": "/CustomerAdd/Email",
"name": "Email"
},
{
"xpath": "/CustomerAdd/Contact",
"name": "Contact"
}
]
},
"ExtendedFunctions": {
"Function": {
"type": "StringAppend",
"id": "FUNCEXT--012345678",
"cacheType": "ByDocument",
"Inputs": {
"Input": [
{
"key": "1",
"name": "Original String",
"default": ""
},
{
"key": "2",
"name": "Fix to Length",
"default": ""
},
{
"key": "3",
"name": "Char to Append",
"default": "-9999"
}
]
},
"Outputs": {
"Output": {
"key": "1",
"name": "Result"
}
},
"Configuration": null
}
},
"ExtendedMappings": {
"Mapping": [
{
"fromXPath": "/StreetAddress1",
"toXPath": "/CustomerAdd/ShipAddress/Addr1"
},
{
"fromXPath": "/StreetAddress2",
"toXPath": "/CustomerAdd/ShipAddress/Addr2"
},
{
"fromXPath": "/Zip",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
},
{
"toFunction": "FUNCEXT--012345678",
"fromXPath": "/Zip",
"toXPath": "1"
},
{
"fromFunction": "FUNCEXT--012345678",
"fromXPath": "1",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
}
]
},
"BrowseSettings": {
"containerId": "1f4adef0-47f1-4129-aed8-1e687ab450c9",
"SourceBrowse": {
"sessionId": "f36e10bc-f19e-4cd9-980a-da0495bb16ee"
},
"DestinationBrowse": null
},
"SourceProfileExtensions": {
"Node": [
{
"xpath": "",
"name": "Account",
"Character": null
},
{
"xpath": "/CustomerNum",
"name": "CustomerNum",
"Character": null
},
{
"xpath": "/CustomerName",
"name": "CustomerName",
"Character": null
},
{
"xpath": "/StreetAddress1",
"name": "StreetAddress1",
"Character": null
},
{
"xpath": "/StreetAddress2",
"name": "StreetAddress2",
"Character": null
},
{
"xpath": "/City",
"name": "City",
"Character": null
},
{
"xpath": "/State",
"name": "State",
"Character": null
},
{
"xpath": "/Zip",
"name": "Zip",
"Character": null
}
]
},
"DestinationProfileExtensions": null
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtension"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionExternalComponent/query": {
"post": {
"tags": [
"EnvironmentMapExtensionExternalComponent"
],
"summary": "Queries for an EnvironmentMapExtensionExternalComponent object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEnvironmentMapExtensionExternalComponent",
"requestBody": {
"description": " Possible properties include: ACCOUNT_ID, ENVIRONMENT_MAP_EXTENSION_ID, PACKAGED_COMPONENT_UID, COMPONENT_ID, COMPONENT_VERSION, COMPONENT_NAME, COMPONENT_TYPE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionExternalComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"1234b56a-ea78-90f1-beec-2fe23456cb8e"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"ZWNlYjg3Y2ItMWEwNC00MjIwLTgxYW..."
],
"operator": "EQUALS",
"property": "environmentMapExtensionId"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"1234b56a-ea78-90f1-beec-2fe23456cb8e"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"ZWNlYjg3Y2ItMWEwNC00MjIwLTgxYW..."
],
"operator": "EQUALS",
"property": "environmentMapExtensionId"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionExternalComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n ZWNlYjg3Y2ItM... \n \n \n 1234b56a-ea78-90f1-beec-2fe23456cb8e \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n ZWNlYjg3Y2ItM... \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionExternalComponent/queryMore": {
"post": {
"tags": [
"EnvironmentMapExtensionExternalComponent"
],
"summary": "Retrieves additional results for an EnvironmentMapExtensionExternalComponent query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentMapExtensionExternalComponent",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionExternalComponentQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentMapExtensionExternalComponent~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionExternalComponentQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentMapExtensionExternalComponent~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionUserDefinedFunction": {
"post": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunction"
],
"summary": "Creates an EnvironmentMapExtensionUserDefinedFunction object",
"description": "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. \n\n 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. \n\n >**Caution:** Creating new functions requires 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.",
"operationId": "CreateEnvironmentMapExtensionUserDefinedFunction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": {
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionUserDefinedFunction/{id}": {
"get": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunction"
],
"summary": "Retrieves an instance of an EnvironmentMapExtensionUserDefinedFunction object",
"description": "Retrieves an extensible user-defined function associated with a given environment map extension function ID.",
"operationId": "GetEnvironmentMapExtensionUserDefinedFunction",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Represents the unique, system-generated ID of the extended user-defined function."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": {
"@type": "EnvironmentMapExtensionUserDefinedFunction",
"Inputs": {
"@type": "MapExtensionsInputs",
"Input": [
{
"@type": "MapExtensionsInput",
"name": "input",
"key": 1
}
]
},
"Outputs": {
"@type": "MapExtensionsOutputs",
"Output": [
{
"@type": "MapExtensionsOutput",
"name": "output",
"key": 1
}
]
},
"Steps": {
"@type": "MapExtensionsFunctionSteps",
"Step": [
{
"@type": "MapExtensionsFunctionStep",
"Inputs": {
"@type": "MapExtensionsInputs",
"Input": [
{
"@type": "MapExtensionsInput",
"name": "Value",
"key": 1
}
]
},
"Outputs": {
"@type": "MapExtensionsOutputs",
"Output": [
{
"@type": "MapExtensionsOutput",
"name": "Result",
"key": 1
}
]
},
"Configuration": {
"@type": "MapExtensionsConfiguration"
},
"cacheType": "None",
"id": "1",
"type": "MathABS",
"position": 1
}
]
},
"Mappings": {
"@type": "MapExtensionsFunctionMappings",
"Mapping": [
{
"@type": "MapExtensionsFunctionMapping",
"fromFunction": "0",
"fromKey": 1,
"toFunction": "1",
"toKey": 1
},
{
"@type": "MapExtensionsFunctionMapping",
"fromFunction": "1",
"fromKey": 1,
"toFunction": "0",
"toKey": 1
}
]
},
"environmentMapExtensionId": "MWRiZDhk...",
"id": "abcd12345-6c78-9012-9eb8-345f6b678901",
"name": "My UDF in MapExtension",
"deleted": false,
"createdDate": "2021-11-10T18:09:39Z",
"createdBy": "user@boomi.com",
"modifiedDate": "2021-11-10T18:09:39Z",
"modifiedBy": "user@boomi.com"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunction"
],
"summary": "Modifies or updates an EnvironmentMapExtensionUserDefinedFunction object",
"description": "Updates the extended configuration for a single user-defined function. \n\n >**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.",
"operationId": "UpdateEnvironmentMapExtensionUserDefinedFunction",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Represents the unique, system-generated ID of the extended user-defined function."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": {
"name": "Account - Customer",
"mapId": "01234567890123456789012345",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"extensionGroupId": "",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"Map": {
"ExtendedFunctions": {
"Function": {
"type": "StringAppend",
"id": "FUNCEXT--012345678",
"cacheType": "ByDocument",
"Inputs": {
"Input": [
{
"key": "1",
"name": "Original String",
"default": ""
},
{
"key": "2",
"name": "Fix to Length",
"default": ""
},
{
"key": "3",
"name": "Char to Append",
"default": "-0000"
}
]
},
"Outputs": {
"Output": {
"key": "1",
"name": "Result"
}
},
"Configuration": null
}
},
"ExtendedMappings": {
"Mapping": [
{
"fromXPath": "/StreetAddress1",
"toXPath": "/CustomerAdd/ShipAddress/Addr1"
},
{
"fromXPath": "/StreetAddress2",
"toXPath": "/CustomerAdd/ShipAddress/Addr2"
},
{
"fromXPath": "/City",
"toXPath": "/CustomerAdd/ShipAddress/City"
},
{
"fromXPath": "/State",
"toXPath": "/CustomerAdd/ShipAddress/State"
},
{
"fromXPath": "/Zip",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
},
{
"fromXPath": "/Country",
"toXPath": "/CustomerAdd/ShipAddress/Country"
},
{
"toFunction": "FUNCEXT--012345678",
"fromXPath": "/Zip",
"toXPath": "1"
},
{
"fromFunction": "FUNCEXT--012345678",
"fromXPath": "1",
"toXPath": "/CustomerAdd/ShipAddress/PostalCode"
}
]
},
"SourceProfileExtensions": {
"Node": [
{
"xpath": "",
"name": "Account",
"Character": null
},
{
"xpath": "/CustomerNum",
"name": "CustomerNum",
"Character": null
},
{
"xpath": "/CustomerName",
"name": "CustomerName",
"Character": null
},
{
"xpath": "/StreetAddress1",
"name": "StreetAddress1",
"Character": null
},
{
"xpath": "/StreetAddress2",
"name": "StreetAddress2",
"Character": null
},
{
"xpath": "/City",
"name": "City",
"Character": null
},
{
"xpath": "/State",
"name": "State",
"Character": null
},
{
"xpath": "/Zip",
"name": "Zip",
"Character": null
}
]
},
"DestinationProfileExtensions": [
null,
null
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": {
"@type": "EnvironmentMapExtensionUserDefinedFunction",
"Inputs": {
"@type": "MapExtensionsInputs",
"Input": [
{
"@type": "MapExtensionsInput",
"name": "str",
"key": 1
},
{
"@type": "MapExtensionsInput",
"name": "str2",
"key": 2
}
]
},
"Outputs": {
"@type": "MapExtensionsOutputs",
"Output": [
{
"@type": "MapExtensionsOutput",
"name": "out1",
"key": 1
},
{
"@type": "MapExtensionsOutput",
"name": "out2",
"key": 2
}
]
},
"Steps": {
"@type": "MapExtensionsFunctionSteps",
"Step": [
{
"@type": "MapExtensionsFunctionStep",
"Inputs": {
"@type": "MapExtensionsInputs",
"Input": [
{
"@type": "MapExtensionsInput",
"default": "STRING1",
"name": "Original String",
"key": 1
},
{
"@type": "MapExtensionsInput",
"default": "5",
"name": "Fix to Length",
"key": 2
},
{
"@type": "MapExtensionsInput",
"default": "_",
"name": "Char to Prepend",
"key": 3
}
]
},
"Outputs": {
"@type": "MapExtensionsOutputs",
"Output": [
{
"@type": "MapExtensionsOutput",
"name": "Result",
"key": 1
}
]
},
"Configuration": {
"@type": "MapExtensionsConfiguration"
},
"cacheType": "None",
"id": "5",
"type": "StringPrepend",
"position": 1
}
]
},
"Mappings": {
"@type": "MapExtensionsFunctionMappings",
"Mapping": []
},
"environmentMapExtensionId": "MWRiZDhk...",
"id": "abcd12345-6c78-9012-9eb8-345f6b678901",
"name": "My UDF in MapExtension",
"deleted": false,
"createdDate": "2021-11-03T19:41:44Z",
"createdBy": "user@boomi.com",
"modifiedDate": "2021-12-06T20:11:55.112Z",
"modifiedBy": "user@boomi.com"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunction"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunction"
],
"summary": "Deletes an EnvironmentMapExtensionUserDefinedFunction object",
"description": "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. \n\n ### Restoring a deleted user-defined function \n\n 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). By restoring a deleted function, it becomes available for use in an API call and in the user interface. After a successful RESTORE operation, the function returns a deleted status of false.",
"operationId": "DeleteEnvironmentMapExtensionUserDefinedFunction",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Represents the unique, system-generated ID of the extended user-defined function."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionUserDefinedFunction/bulk": {
"post": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunction"
],
"summary": "Retrieves multiple EnvironmentMapExtensionUserDefinedFunction objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkEnvironmentMapExtensionUserDefinedFunction",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionUserDefinedFunctionSummary/query": {
"post": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunctionSummary"
],
"summary": "Queries for an EnvironmentMapExtensionUserDefinedFunctionSummary object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEnvironmentMapExtensionUserDefinedFunctionSummary",
"requestBody": {
"description": " Possible properties include: environmentId, extensionGroupId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionSummaryQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"1234b56a-ea78-90f1-beec-2fe23456cb8e"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"ZWNlYjg3Y2ItMW..."
],
"operator": "EQUALS",
"property": "environmentMapExtensionId"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"1234b56a-ea78-90f1-beec-2fe23456cb8e"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"ZWNlYjg3Y2ItMW..."
],
"operator": "EQUALS",
"property": "environmentMapExtensionId"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionSummaryQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n ZWNlYjg3Y2ItMW... \n \n \n 1234b56a-ea78-90f1-beec-2fe23456cb8e \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n ZWNlYjg3Y2ItMW... \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionUserDefinedFunctionSummary/queryMore": {
"post": {
"tags": [
"EnvironmentMapExtensionUserDefinedFunctionSummary"
],
"summary": "Retrieves additional results for an EnvironmentMapExtensionUserDefinedFunctionSummary query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentMapExtensionUserDefinedFunctionSummary",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentMapExtensionUserDefinedFunctionSummary~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionUserDefinedFunctionSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentMapExtensionUserDefinedFunctionSummary~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionsSummary/query": {
"post": {
"tags": [
"EnvironmentMapExtensionsSummary"
],
"summary": "Queries for an EnvironmentMapExtensionsSummary object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEnvironmentMapExtensionsSummary",
"requestBody": {
"description": " Possible properties include: environmentId, extensionGroupId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionsSummaryQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "EQUALS",
"property": "environmentId",
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "environmentId",
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionsSummaryQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentMapExtensionsSummary/queryMore": {
"post": {
"tags": [
"EnvironmentMapExtensionsSummary"
],
"summary": "Retrieves additional results for an EnvironmentMapExtensionsSummary query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentMapExtensionsSummary",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionsSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentMapExtensionsSummary~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentMapExtensionsSummaryQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentMapExtensionsSummary~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentRole": {
"post": {
"tags": [
"EnvironmentRole"
],
"summary": "Creates an EnvironmentRole object",
"description": "Associates a role with an environment. You must have the Runtime Management privilege to perform the CREATE operation.",
"operationId": "CreateEnvironmentRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRole"
},
"example": {
"environmentId": "myEnvironment",
"roleId": "userRole"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRole"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRole"
},
"example": {
"@type": "Environment",
"id": "456789ab-cdef-0123-4567-89abcdef0123",
"name": "My Production Environment",
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRole"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentRole/{id}": {
"get": {
"tags": [
"EnvironmentRole"
],
"summary": "Retrieves an instance of an EnvironmentRole object",
"description": "Returns a single Environment Role object based on the supplied environment role ID.",
"operationId": "GetEnvironmentRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The Environment Role object you are attempting to get."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRole"
},
"example": {
"@type": "EnvironmentRole",
"environmentId": "myEnvironment",
"roleId": "userRole"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRole"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"EnvironmentRole"
],
"summary": "Deletes an EnvironmentRole object",
"description": "Removes the association between a role and an environment. \n\n 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.",
"operationId": "DeleteEnvironmentRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The Environment Role object you are attempting to delete."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentRole/bulk": {
"post": {
"tags": [
"EnvironmentRole"
],
"summary": "Retrieves multiple EnvironmentRole objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkEnvironmentRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentRole/query": {
"post": {
"tags": [
"EnvironmentRole"
],
"summary": "Queries for an EnvironmentRole object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEnvironmentRole",
"requestBody": {
"description": " Possible properties include: environmentId, roleId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"myEnvironment"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"userRole"
],
"operator": "EQUALS",
"property": "roleId"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"myEnvironment"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"userRole"
],
"operator": "EQUALS",
"property": "roleId"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n myEnvronment \n \n \n userRole \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n myEnvronment \n \n \n another-value \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/EnvironmentRole/queryMore": {
"post": {
"tags": [
"EnvironmentRole"
],
"summary": "Retrieves additional results for an EnvironmentRole query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEnvironmentRole",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentRole~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EnvironmentRoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1EnvironmentRole~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Event/query": {
"post": {
"tags": [
"Event"
],
"summary": "Queries for an Event object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryEvent",
"requestBody": {
"description": " Possible properties include: eventId, accountId, atomId, atomName, eventLevel, eventDate, status, eventType, executionId, title, updateDate, startTime, endTime, errorDocumentCount, inboundDocumentCount, outboundDocumentCount, processName, recordDate, error, environment, classification",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-67008f66-ea50-40f8-8d1f-7a3ebe2c02a5-2024.08.08"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-67008f66-ea50-40f8-8d1f-7a3ebe2c02a5-2024.08.08"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EventQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\n execution-67008f66-ea50-40f8-8d1f-7a3ebe2c02a5-2024.08.08 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-67008f66-ea50-40f8-8d1f-7a3ebe2c02a5-2024.08.08 \n \n \n another-value \n \n \n \n event-1b2871bf-5819-41e1-a215-714c5cce3551 \n BoomiAdmin-123 \n b829b682-6e6e-4551-b9a3-61dcfa96dffd \n Biggie \n ERROR \n 2024-08-08T06:14:42Z \n ERROR \n process.execution \n execution-67008f66-ea50-40f8-8d1f-7a3ebe2c02a5-2024.08.08 \n T002a User Notify \n 2024-08-08T06:14:42Z \n 2024-08-08T06:14:42Z \n2024-08-08T06:14:46Z \n 1 \n 1 \n 0 \n 2. (Sched) General: User Notify + Exception (Proc. Call > Data Passthrough Sub-Process) 21 Jun \n 2024-08-08T06:14:57Z \n T002a Exception (Proc. Call > Data Passthru Sub-Process)\n \n ProdEnv \n PROD \n DOCUMENT \n Exception \n \n \n event-6d71102f-5c82-4206-b88f-081ae4a2a566 \n BoomiAdmin-123 \n b829b682-6e6e-4551-b9a3-61dcfa96dffd \n Biggie \n ERROR \n 2024-08-08T06:14:45Z \n T002a User Notify (Proc. Call > Data Passthru Sub-Process) \n user.notification \n execution-67008f66-ea50-40f8-8d1f-7a3ebe2c02a5-2024.08.08 \n T002a User Notify \n 2024-08-08T06:14:45Z \n 0 \n 0 \n 0 \n 2. (Sched) General: User Notify + Exception (Proc. Call > Data Passthrough Sub-Process) 21 Jun \n 2024-08-08T06:14:57Z \n ProdEnv \nPROD \n 09f94a17-a0ad-4fa9-8423-d01ff6d1e935 \n 609aaa4e-951b-407a-bdd8-9f70b713246a \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Event/queryMore": {
"post": {
"tags": [
"Event"
],
"summary": "Retrieves additional results for an Event query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreEvent",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventQueryResponse"
},
"example": {
"$ref": "#/paths/~1Event~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EventQueryResponse"
},
"example": {
"$ref": "#/paths/~1Event~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionArtifacts": {
"post": {
"tags": [
"ExecutionArtifacts"
],
"summary": "Creates an ExecutionArtifacts object",
"description": "Allows you to retrieve a link for downloading detailed information about a given process run. \n - 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. \n - Additionally, as the Cloud owner, you must select the **Enable Download of Execution Artifacts and Worker Logs** property for your account. This property permits you to download process execution data, and you can access it from the Cloud Attachment Quota tab of Manage > Cloud Management. \n - After providing the endpoint and a request body containing the execution ID, the CREATE response returns a download URL that you can open (or copy and paste) in your web browser, which initiates the file download to your local drive. \n To retrieve the download link for file containing a process execution artifacts, \n 1. First create a CREATE (or POST) request to `https://api.boomi.com/api/rest/v1//ExecutionArtifacts` where `accountId` is the ID of the account authenticating the request. \n 2. Populate the request body with the `executionId`, which is the identifier of the given run process.\n 3. Send the request and either open or copy and paste the URL from the response into your web browser.",
"operationId": "CreateExecutionArtifacts",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionArtifacts"
},
"example": {
"executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionArtifacts"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionArtifacts"
},
"example": {
"@type": "LogDownload",
"statusCode": "202",
"message": "Beginning download.",
"url": "https://api.boomi.com/account/account-123456/api/download/ExecutionArtifacts-89abcdef-0123-4567-89ab-cdef01234567"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionArtifacts"
},
"example": "\n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionConnector/query": {
"post": {
"tags": [
"ExecutionConnector"
],
"summary": "Queries for an ExecutionConnector object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n- 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.\n - Requires one or more execution IDs in the request body.\n - You can filter all fields except executionConnector and id.",
"operationId": "QueryExecutionConnector",
"requestBody": {
"description": " Possible properties include: executionId, connectorType, actionType, errorCount, successCount, size, isStartShape, recordType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionConnectorQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionConnectorQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n execution-3456789a-bcde-f012-3456-789abcdef012-2021.01.01 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-3456789a-bcde-f012-3456-789abcdef012-2021.01.01 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionConnector/queryMore": {
"post": {
"tags": [
"ExecutionConnector"
],
"summary": "Retrieves additional results for an ExecutionConnector query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreExecutionConnector",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionConnectorQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionConnector~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionConnectorQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionConnector~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionCountAccount/query": {
"post": {
"tags": [
"ExecutionCountAccount"
],
"summary": "Queries for an ExecutionCountAccount object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryExecutionCountAccount",
"requestBody": {
"description": " Possible properties include: environmentId, atomId, processDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n 2016-05-01 \n 2016-08-31 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n ...\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionCountAccount/queryMore": {
"post": {
"tags": [
"ExecutionCountAccount"
],
"summary": "Retrieves additional results for an ExecutionCountAccount query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreExecutionCountAccount",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionCountAccount~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionCountAccount~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionCountAccountGroup/query": {
"post": {
"tags": [
"ExecutionCountAccountGroup"
],
"summary": "Queries for an ExecutionCountAccountGroup object(s)",
"description": "The authenticating user for a QUERY operation must have the Dashboard privilege. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryExecutionCountAccountGroup",
"requestBody": {
"description": " Possible properties include: accountGroupId, processDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n fedcba98-7654-3210-fedc-ba9876543210 \n \n \n 2016-05-01 \n 2016-08-31 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n fedcba98-7654-3210-fedc-ba9876543210 \n \n \n another-value \n \n \n \n ...\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionCountAccountGroup/queryMore": {
"post": {
"tags": [
"ExecutionCountAccountGroup"
],
"summary": "Retrieves additional results for an ExecutionCountAccountGroup query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreExecutionCountAccountGroup",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionCountAccountGroup~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionCountAccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionCountAccountGroup~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionRecord/async/{id}": {
"get": {
"tags": [
"ExecutionRecord"
],
"summary": "Retrieves an instance of an ExecutionRecord object",
"description": "- Use the GET operation with the [Execution Request object](/docs/api/platformapi/ExecutionRequest). 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. \n- The **Execution Request object** POST response returns a *requestId*. Use the requestId in a subsequent call to the Execution Record object, which provides a record of the successful process run. \n- Repeatedly poll the Execution Record object with *requestId* until the run record is available. If the `ExecutionRecord` is not available, it returns an HTTP 202 status code. When the `ExecutionRecord` is available, it returns the Execution Record object's payload. \n\n >**Note:** For long running processes, you may need to continue to poll `ExecutionRecord` until it returns a completed status such as *COMPLETE* or *ERROR*.",
"operationId": "AsyncGetResponseExecutionRecord",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRecord"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionRecord"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionRecord/query": {
"post": {
"tags": [
"ExecutionRecord"
],
"summary": "Queries for an ExecutionRecord object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryExecutionRecord",
"requestBody": {
"description": " Possible properties include: executionId, originalExecutionId, account, executionTime, status, executionType, processName, processId, atomName, atomId, inboundDocumentCount, outboundDocumentCount, executionDuration, message, reportKey, launcherId, nodeId, recordedDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"5c94d512-4dfe-404b-b32a-8063259436f7"
],
"operator": "EQUALS",
"property": "processId"
}
},
"QuerySort": {
"sortField": [
{
"fieldName": "executionTime",
"sortOrder": "DESC"
}
]
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"5c94d512-4dfe-404b-b32a-8063259436f7"
],
"operator": "EQUALS",
"property": "processId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
},
"QuerySort": {
"sortField": [
{
"fieldName": "executionTime",
"sortOrder": "DESC"
}
]
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 7b9087ee-11f4-4df4-9abc-0db3c06e0dd1 \n \n \n 10a93d39-3c27-45a8-9abb-c1f0c8925222 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 7b9087ee-11f4-4df4-9abc-0db3c06e0dd1 \n \n \n another-value \n \n \n \n execution-88256f34-f3e1-4903-bdb6-1ba682bb40fe-2023.06.05 \n boomi-K189RY \n 2023-06-05T07:15:22Z \n COMPLETE \n sub_process \n TestStatusCheck \n 7b9087ee-11f4-4df4-9abc-0db3c06e0dd1 \n Biggie \n 46c0f0b4-3add-40e9-b364-283b4c44f9bf \n 1 \n 0 \n 0 \n 338 \n execution-c07dbe8d-17f7-4354-8162-c324509d1118-2023.06.05 \n execution-c8a905f7-7df0-4840-9720-4eaa1601662c-2023.06.05 \n 0 \n 0 \n 172_16_22_224[execution-c8a905f7-7df0-4840-9720-4eaa1601662c-2023.06.05] \n \n ...\n \n execution-a7d4eda9-28fa-4d11-8275-d55817f5d5aa-2023.07.06 \n boomi-K189RY \n 2023-07-06T18:19:12Z \n COMPLETE \n sub_process \n Run Test Case Reporting via API \n 10a93d39-3c27-45a8-9abb-c1f0c8925222 \n Biggie \n 46c0f0b4-3add-40e9-b364-283b4c44f9bf \n 1 \n 0 \n 1 \n 95065 \n execution-66630301-0bd9-42ee-92c3-d8d4d896656a-2023.07.06 \n 0 \n 304 \n 172_16_22_223[execution-66630301-0bd9-42ee-92c3-d8d4d896656a-2023.07.06] \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionRecord/queryMore": {
"post": {
"tags": [
"ExecutionRecord"
],
"summary": "Retrieves additional results for an ExecutionRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreExecutionRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionRequest": {
"post": {
"tags": [
"ExecutionRequest"
],
"summary": "Creates an ExecutionRequest object",
"description": "Submits the process to run and returns results immediately. The operation does not wait for the run to complete. \n\n - The Execution Request response returns a requestID, which you use to make a subsequent call to the [Execution Record object](/docs/api/platformapi/ExecutionRecord) to retrieve detailed information about the process run.\n- This operation returns an error when the client:\n - Fails authentication or does not have the correct permissions\n - Supplies an invalid Account ID\n - Supplies an invalid Runtime ID\n - Attempts to reach a deleted Atom\n - Supplies an invalid Process ID\n - Missing privileges to run processes on the given Runtime or its associated Environment.",
"operationId": "CreateExecutionRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRequest"
},
"example": {
"@type": "ExecutionRequest",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"DynamicProcessProperties": {
"DynamicProcessProperty": [
{
"name": "property1",
"value": "value1"
}
]
},
"ProcessProperties": {
"ProcessProperty": [
{
"componentId": "456789a-bcde-f0123-4567-89abcdef012",
"ProcessPropertyValue": [
{
"key": "key1",
"value": "property1"
}
]
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionRequest"
},
"example": "\n \n \n \n \n \n \n\t\n\t\n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionRequest"
},
"example": {
"@type": "ExecutionRequest",
"DynamicProcessProperties": {
"@type": "ExecutionRequestDynamicProcessProperties",
"DynamicProcessProperty": [
{
"@type": "",
"name": "property1",
"value": "value1"
}
]
},
"ProcessProperties": {
"@type": "ExecutionRequestProcessProperties",
"ProcessProperty": [
{
"@type": "",
"ProcessPropertyValue": [
{
"@type": "",
"key": "key1",
"value": "value1"
}
],
"componentId": "456789a-bcde-f0123-4567-89abcdef012"
}
]
},
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"requestId": "executionrecord-110b23f4-567a-8d90-1234-56789e0b123d",
"recordUrl": "http://localhost:8081/api/rest/v1/account1234/ExecutionRecord/async/executionrecord-110b23f4-567a-8d90-1234-56789e0b123d"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionRequest"
},
"example": "\n \n \n \n \n \n \n\t\n\t\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionSummaryRecord/query": {
"post": {
"tags": [
"ExecutionSummaryRecord"
],
"summary": "Queries for an ExecutionSummaryRecord object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryExecutionSummaryRecord",
"requestBody": {
"description": "Possible properties include: processId, timeBlock, atomId, status, reportKey, launcherId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionSummaryRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "processId"
},
{
"argument": [
"2016-05-01T00:00:00Z",
"2016-08-31T23:59:59Z"
],
"operator": "BETWEEN",
"property": "timeBlock"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "processId"
},
{
"argument": [
"2016-05-01T00:00:00Z",
"2016-08-31T23:59:59Z"
],
"operator": "BETWEEN",
"property": "timeBlock"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionSummaryRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 789abcde-f012-3456-789a-bcdef0123456 \n \n \n 2016-05-01T00:00:00Z \n 2016-08-31T23:59:59Z \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 789abcde-f012-3456-789a-bcdef0123456 \n \n \n another-value \n \n \n \n ...\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ExecutionSummaryRecord/queryMore": {
"post": {
"tags": [
"ExecutionSummaryRecord"
],
"summary": "Retrieves additional results for an ExecutionSummaryRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreExecutionSummaryRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExecutionSummaryRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionSummaryRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ExecutionSummaryRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1ExecutionSummaryRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Folder": {
"post": {
"tags": [
"Folder"
],
"summary": "Creates a Folder object",
"description": "- When using the CREATE operation, you can create a new folder within the parent folder.\n\n- 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.\n\n- `parentId` must be a valid, non-deleted folder. If omitted or blank, it defaults to the root folder.\n\n- To Restore a folder you need to use the CREATE operation call, using a valid GUID for a deleted item. This will also restore any deleted components within that folder.",
"operationId": "CreateFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": {
"@type": "Folder",
"PermittedRoles": {
"@type": "PermittedRoles",
"RoleReference": [
{
"id": "fcb6dd44-0ca8-11e2-a477-1231381987a5"
}
]
},
"name": "Folder123",
"parentId": "Rjo5NjEyNTg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": "\n \n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": {
"@type": "Folder",
"PermittedRoles": {
"@type": "PermittedRoles",
"RoleReference": [
{
"@type": "RoleReference",
"id": "fcb6dd44-0ca8-11e2-a477-1231381987a5",
"name": "Administrator"
}
]
},
"id": "RjoxMDU2NjMx",
"name": "Folder123",
"fullPath": "User/Folder1/Folder123",
"deleted": false,
"parentId": "Rjo5NjEyNTg",
"parentName": "Folder1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": "\n\n \n \n \n \n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Folder/{id}": {
"get": {
"tags": [
"Folder"
],
"summary": "Retrieves an instance of a Folder object",
"description": "Retrieves the folder with the particular ID.",
"operationId": "GetFolder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Required. Read only. The system-generated, unique identifier of the folder."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": {
"@type": "Folder",
"id": "folderId123",
"name": "Folder-Name",
"fullPath": "Platform API/Folder/Tests/Folder-Name",
"deleted": false
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"Folder"
],
"summary": "Modifies or updates a Folder object",
"description": "You can update by changing the name of the folder and following the same considerations for the CREATE parameters.",
"operationId": "UpdateFolder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Required. Read only. The system-generated, unique identifier of the folder."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": {
"@type": "Folder",
"PermittedRoles": {
"@type": "PermittedRoles",
"RoleReference": [
{
"id": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
}
]
},
"id": "RjoxMDU2NTM5",
"name": "Folder456"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": "\n \n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": {
"@type": "Folder",
"PermittedRoles": {
"@type": "PermittedRoles",
"RoleReference": [
{
"@type": "RoleReference",
"id": "fcb6e2d0-0ca8-11e2-a477-1231381987a5",
"name": "Standard User"
}
]
},
"id": "RjoxMDU2NTM5",
"name": "Folder456",
"fullPath": "User/Folder456",
"deleted": false,
"parentId": "Rjo5NTk0OTc",
"parentName": "User"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Folder"
},
"example": "\n\n\n\n \n \n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"Folder"
],
"summary": "Deletes a Folder object",
"description": "- Deleting a folder will delete the folder and its contents including all components and sub-folders. \n - The root folder cannot be deleted. \n - Folders containing actively deployed processes or other deployable components cannot be deleted. \n >**Note:** You can restore a deleted folder by requesting a CREATE operation and specifying the ID of the deleted folder.",
"operationId": "DeleteFolder",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Required. Read only. The system-generated, unique identifier of the folder."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Folder/bulk": {
"post": {
"tags": [
"Folder"
],
"summary": "Retrieves multiple Folder objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkFolder",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderBulkRequest"
},
"example": {
"BulkRequest": {
"type": "GET",
"request": [
{
"xsi_type": "BulkId",
"id": "folderId123"
},
{
"xsi_type": "BulkId",
"id": "folderId456"
},
{
"xsi_type": "BulkId",
"id": "folderId789"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/FolderBulkRequest"
},
"example": "\n \t\n \t\n \t\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderBulkResponse"
},
"example": {
"BulkResult": {
"response": [
{
"statusCode": "200",
"Result": {
"xsi_type": "Folder",
"id": "folderId123",
"name": "Folder-Name",
"fullPath": "Platform API/Folder/Tests/Folder-Name",
"deleted": "false"
}
},
{
"statusCode": "200",
"Result": {
"xsi_type": "Folder",
"id": "folderId456",
"name": "Folder-Name",
"fullPath": "Platform API/Folder/Tests/Folder-Name",
"deleted": "false"
}
},
{
"statusCode": "200",
"Result": {
"xsi_type": "Folder",
"id": "folderId789",
"name": "Folder-Name",
"fullPath": "Platform API/Folder/Tests/Folder-Name",
"deleted": "false"
}
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/FolderBulkResponse"
},
"example": "\n\t\n\t\t\n\t \n\t\n\t\t\n\t \n\t\n\t\t\n\t \n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Folder/query": {
"post": {
"tags": [
"Folder"
],
"summary": "Queries for a Folder object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n- You can perform the QUERY operation for the Folder object by id, name, and deleted.\n\n- The QUERY MORE operation is also available for the Folder object.\n\n- You can perform an empty QUERY to return all folders.\n\n- If no filter is specified, both non-deleted and deleted records are returned.",
"operationId": "QueryFolder",
"requestBody": {
"description": " Possible properties include: accountId, id, name, deleted, parentId, parentName, permittedRoles",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "name",
"argument": [
"SOAP and Platform API Connector"
]
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "name",
"argument": [
"SOAP and Platform API Connector"
]
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/FolderQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n SOAP and {conKeyRefs.AtomSphere_BoomiEnterprisePlatform} API Connector \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n SOAP and {conKeyRefs.AtomSphere_BoomiEnterprisePlatform} API Connector \n \n \n another-value \n \n \n \t\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Folder/queryMore": {
"post": {
"tags": [
"Folder"
],
"summary": "Retrieves additional results for a Folder query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreFolder",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FolderQueryResponse"
},
"example": {
"$ref": "#/paths/~1Folder~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/FolderQueryResponse"
},
"example": {
"$ref": "#/paths/~1Folder~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/GenericConnectorRecord/{id}": {
"get": {
"tags": [
"GenericConnectorRecord"
],
"summary": "Retrieves an instance of a GenericConnectorRecord object",
"description": "Allows you to view document metadata for exactly one document based on the provided id.",
"operationId": "GetGenericConnectorRecord",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the GenericConnectorRecord. You obtain this ID from querying the GenericConnectorRecord object."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecord"
},
"example": {
"@type": "GenericConnectorRecord",
"id": "A0BCD0EFIj5kLmNO2P4QRS1tUlvwx1yZDlkNWMwZC01N2MzL...",
"executionConnectorId": "RVhFQ19DT05OZmFsc2U6U2VuZDp0cmFkaW5ncGFydG5l...",
"executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"dateProcessed": "2021-02-23T16:44:50Z",
"actionType": "Get",
"connectorType": "http",
"connectionName": "Runtime API Endpoint: https://boomi.com/api/rest/v1/account123/Atom",
"operationName": "Get",
"connectionId": "1a2c34f5-fbf6-789b-01ea-234a56e7b890",
"operationId": "567b89e1-c234-5678-abff-9f01aee2345a",
"documentIndex": 0,
"incrementalDocumentIndex": 3,
"status": "SUCCESS",
"startShape": false,
"retryable": false,
"size": 133
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecord"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/GenericConnectorRecord/bulk": {
"post": {
"tags": [
"GenericConnectorRecord"
],
"summary": "Retrieves multiple GenericConnectorRecord objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkGenericConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/GenericConnectorRecord/query": {
"post": {
"tags": [
"GenericConnectorRecord"
],
"summary": "Queries for a GenericConnectorRecord object(s)",
"description": "- The QUERY operation allows you to view document metadata for all documents in the run. You must query by exactly one `executionId`. \n - You cannot query `connectorFields`. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryGenericConnectorRecord",
"requestBody": {
"description": " Possible properties include: id, executionConnectorId, executionId, connectionId, operationId, actionType, connectorType, atomId, dateProcessed, connectionName, operationName, errorMessage, status, documentIndex, incrementalDocumentIndex, size, startShape, retryable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01 \n \n \n {conKeyRefs.AtomSphere_BoomiEnterprisePlatform} API Connection \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01 \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/GenericConnectorRecord/queryMore": {
"post": {
"tags": [
"GenericConnectorRecord"
],
"summary": "Retrieves additional results for a GenericConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreGenericConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1GenericConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/GenericConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1GenericConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/getAssignableRoles": {
"get": {
"tags": [
"getAssignableRoles"
],
"summary": "Retrieve assignable roles",
"description": "You can use the getAssignableRoles operation to retrieve a list of roles that are assignable under an account.",
"operationId": "ListAssignableRoles",
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roles"
},
"example": {
"@type": "",
"Role": [
{
"@type": "Role",
"description": "Boomi Default Administrator role.",
"id": "fcb6dd44-0ca8-11e2-a477-1231381987a5",
"accountId": "1",
"name": "Administrator",
"parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
},
{
"@type": "Role",
"description": "Boomi Default Production Support User role.",
"id": "fcb6e3b6-0ca8-11e2-a477-1231381987a5",
"accountId": "1",
"name": "Production Support",
"parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
},
{
"@type": "Role",
"description": "Boomi Default Standard User role.",
"id": "fcb6e2d0-0ca8-11e2-a477-1231381987a5",
"accountId": "1",
"name": "Standard User",
"parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
},
{
"@type": "Role",
"description": "Boomi Default Basic Support User role.",
"id": "fcb6e474-0ca8-11e2-a477-1231381987a5",
"accountId": "1",
"name": "Support",
"parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
},
{
"@type": "Role",
"description": "",
"id": "01234567-89ab-cdef-0123-456789abcdef",
"accountId": "account-123456",
"name": "TestRole",
"parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
},
{
"@type": "Role",
"description": "",
"id": "fedcba98-7654-3210-fedc-ba9876543210",
"accountId": "account-123456",
"name": "Test2",
"parentId": "fcb6e2d0-0ca8-11e2-a477-1231381987a5"
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Roles"
},
"example": "\n \n Boomi Default Administrator role.\n \n Boomi Default Production Support User role.\n \n Boomi Default Standard User role.\n \n Boomi Default Basic Support User role.\n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/HL7ConnectorRecord/query": {
"post": {
"tags": [
"HL7ConnectorRecord"
],
"summary": "Queries for a HL7ConnectorRecord object(s)",
"description": "To filter by a customField, 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 [CustomTrackedField object](/docs/api/platformapi/CustomTrackedField). \n\n The STARTS_WITH operator accepts values that do not include spaces. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryHL7ConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HL7ConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/HL7ConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14 \n \n \n another-value \n \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2019-09-14T06:24:12Z \n connector-abcdef01-2345-6789-abcd-ef0123456789 \n Listen \n hl7 \n Start \n Sample HL7 Listen Operation \n 0 \n true \n 3138 \n \n 13 \n 2019-09-14T10:53:59-0400 \n sample \n \n Commit Error \n Acknowledgment Report for Interchange Control Number 000139776
\n Date: 190914
\n Time: 1031
\n Acknowledgment Status: Accepted with Errors
\n Note: Invalid Interchange Receiver ID \n Application Error \n Group Control #: 139776
Acknowledgement Status: A \n mcapp33382 \n mcf33382 \n tpapp33382 \n tpf33382 \n 1018015 \n ADT_A01 \n v27 \n false \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.09.14 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2019-09-14T06:25:02Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Listen \n hl7 \n Start \n Sample HL7 Listen Operation \n 49 \n true \n 2781 \n \n 55 \n 2019-09-14T10:57:14-0400 \n sample \n \n Commit Accept \n Success \n Application Accept \n Group Control #: 139776
Acknowledgement Status: A \n mcapp33382 \n mcf33382 \n tpapp33382 \n tpf33382 \n 1018016 \n ADT_A01 \n v27 \n true \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/HL7ConnectorRecord/queryMore": {
"post": {
"tags": [
"HL7ConnectorRecord"
],
"summary": "Retrieves additional results for a HL7ConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreHL7ConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HL7ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1HL7ConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/HL7ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1HL7ConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/InstallerToken": {
"post": {
"tags": [
"InstallerToken"
],
"summary": "Creates an InstallerToken object",
"description": "Creates an installer token of a specific type that is valid for a specific number of minutes.",
"operationId": "CreateInstallerToken",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallerToken"
},
"example": {
"installType": "MOLECULE",
"durationMinutes": 30
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InstallerToken"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstallerToken"
},
"example": {
"@type": "InstallerToken",
"installType": "MOLECULE",
"token": "molecule-963f3eb3-0eaa-4f5c-8b8b-8bff84343cb5",
"expiration": "2017-02-07T23:02:51.207Z",
"created": "2017-02-07T22:32:51.207Z",
"accountId": "fakeAccountId",
"durationMinutes": 30,
"cloudId": "3ca45d71-7794-40e2-b94b-182aef8ce5c2"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/InstallerToken"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPack/{id}": {
"get": {
"tags": [
"IntegrationPack"
],
"summary": "Retrieves an instance of an IntegrationPack object",
"description": "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.",
"operationId": "GetIntegrationPack",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the integration pack."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPack"
},
"example": {
"@type": "IntegrationPack",
"Description": "Order Intake Ipack",
"id": "89abcdef-0123-4567-89ab-cdef01234567",
"name": "Order Intake",
"installationType": "SINGLE"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPack"
},
"example": " \n Order Intake Ipack \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPack/bulk": {
"post": {
"tags": [
"IntegrationPack"
],
"summary": "Retrieves multiple IntegrationPack objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPack/query": {
"post": {
"tags": [
"IntegrationPack"
],
"summary": "Queries for an IntegrationPack object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryIntegrationPack",
"requestBody": {
"description": " Possible properties include: name, id, installationType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"Single"
],
"operator": "EQUALS",
"property": "installationType"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"Single"
],
"operator": "EQUALS",
"property": "installationType"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n SINGLE \n \n \n "
},
"GroupingExpression": {
"value": "\n \n SINGLE \n \n \n another-value \n \n \n \n Order Intake Ipack \n \n \n Order Processing Ipack \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPack/queryMore": {
"post": {
"tags": [
"IntegrationPack"
],
"summary": "Retrieves additional results for an IntegrationPack query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreIntegrationPack",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPack~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPack~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackAtomAttachment": {
"post": {
"tags": [
"IntegrationPackAtomAttachment"
],
"summary": "Creates an IntegrationPackAtomAttachment object",
"description": "Attaches an integration pack instance having the specified ID to the Runtime having the specified ID.",
"operationId": "CreateIntegrationPackAtomAttachment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachment"
},
"example": {
"integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98",
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachment"
},
"example": {
"@type": "IntegrationPackAtomAttachment",
"integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98",
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackAtomAttachment/query": {
"post": {
"tags": [
"IntegrationPackAtomAttachment"
],
"summary": "Queries for an IntegrationPackAtomAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryIntegrationPackAtomAttachment",
"requestBody": {
"description": " Possible properties include: atomId, integrationPackInstanceId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"3456789a-bcde-f012-3456-789abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f012-3456-789abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackAtomAttachment/queryMore": {
"post": {
"tags": [
"IntegrationPackAtomAttachment"
],
"summary": "Retrieves additional results for an IntegrationPackAtomAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreIntegrationPackAtomAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPackAtomAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPackAtomAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackAtomAttachment/{id}": {
"delete": {
"tags": [
"IntegrationPackAtomAttachment"
],
"summary": "Deletes an IntegrationPackAtomAttachment object",
"description": "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.",
"operationId": "DeleteIntegrationPackAtomAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The object’s conceptual ID, which is synthesized from the Runtime and integration pack instance IDs."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackEnvironmentAttachment": {
"post": {
"tags": [
"IntegrationPackEnvironmentAttachment"
],
"summary": "Creates an IntegrationPackEnvironmentAttachment object",
"description": "Attaches an integration pack instance having the specified ID to the environment having the specified ID.",
"operationId": "CreateIntegrationPackEnvironmentAttachment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachment"
},
"example": {
"integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachment"
},
"example": {
"@type": "IntegrationPackEnvironmentAttachment",
"integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackEnvironmentAttachment/query": {
"post": {
"tags": [
"IntegrationPackEnvironmentAttachment"
],
"summary": "Queries for an IntegrationPackEnvironmentAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryIntegrationPackEnvironmentAttachment",
"requestBody": {
"description": " Possible properties include: environmentId, integrationPackInstanceId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackEnvironmentAttachment/queryMore": {
"post": {
"tags": [
"IntegrationPackEnvironmentAttachment"
],
"summary": "Retrieves additional results for an IntegrationPackEnvironmentAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreIntegrationPackEnvironmentAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPackEnvironmentAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackEnvironmentAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPackEnvironmentAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackEnvironmentAttachment/{id}": {
"delete": {
"tags": [
"IntegrationPackEnvironmentAttachment"
],
"summary": "Deletes an IntegrationPackEnvironmentAttachment object",
"description": "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`.",
"operationId": "DeleteIntegrationPackEnvironmentAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The conceptual Integration Pack Environment Attachment object ID"
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackInstance": {
"post": {
"tags": [
"IntegrationPackInstance"
],
"summary": "Creates an IntegrationPackInstance object",
"description": "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.",
"operationId": "CreateIntegrationPackInstance",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstance"
},
"example": {
"integrationPackOverrideName": "Domestic Order Intake",
"integrationPackId": "89abcdef-0123-4567-89ab-cdef01234567"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstance"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstance"
},
"example": {
"@type": "IntegrationPackInstance",
"ProcessId": [
{
"@type": "ProcessId",
"originalProcessId": "bc407c7d-cacc-48da-a430-c6a4d2835a83",
"wrapperProcessId": "52896de8-229a-449a-ae5d-ecfe8fc2e770",
"name": "Domestic Order Intake test1 - INT"
},
{
"@type": "ProcessId",
"originalProcessId": "f23ce1b1-7440-4535-a534-685a17a41607",
"wrapperProcessId": "4dbfb44f-2676-488c-beb8-1121677117a3",
"name": "Domestic Order Intake test1 - New Process 3"
}
],
"integrationPackId": "89abcdef-0123-4567-89ab-cdef01234567",
"integrationPackOverrideName": "Domestic Order Intake test1",
"id": "SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UyNQ"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstance"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackInstance/{id}": {
"get": {
"tags": [
"IntegrationPackInstance"
],
"summary": "Retrieves an instance of an IntegrationPackInstance object",
"description": "Retrieves the properties of the integration pack instance having the specified ID. \n\n 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.",
"operationId": "GetIntegrationPackInstance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The integration pack instance ID."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstance"
},
"example": {
"@type": "IntegrationPackInstance",
"ProcessId": [
{
"@type": "ProcessId",
"originalProcessId": "bc407c7d-cacc-48da-a430-c6a4d2835a83",
"wrapperProcessId": "0331193a-2675-4f33-97fc-e050a4fd4eec",
"name": "Domestic Order Intake - INT"
},
{
"@type": "ProcessId",
"originalProcessId": "f23ce1b1-7440-4535-a534-685a17a41607",
"wrapperProcessId": "ea975f03-592f-49e5-84cb-49f69f75adb4",
"name": "Domestic Order Intake - New Process 3"
}
],
"integrationPackId": "a3c4917d-9622-4c5f-978c-0f02b5f5457a",
"integrationPackOverrideName": "Domestic Order Intake",
"id": "SW50ZWdyYXRpb25QYWNrSW5zdGFuY2UyMA"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstance"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"IntegrationPackInstance"
],
"summary": "Deletes an IntegrationPackInstance object",
"description": "Uninstalls the integration pack instance having a specified ID from the requesting account. You can obtain this ID from a QUERY operation.",
"operationId": "DeleteIntegrationPackInstance",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The integration pack instance ID."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackInstance/bulk": {
"post": {
"tags": [
"IntegrationPackInstance"
],
"summary": "Retrieves multiple IntegrationPackInstance objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkIntegrationPackInstance",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackInstance/query": {
"post": {
"tags": [
"IntegrationPackInstance"
],
"summary": "Queries for an IntegrationPackInstance object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryIntegrationPackInstance",
"requestBody": {
"description": " Possible properties include: integrationPackOverrideName, integrationPackName, integrationPackId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"Order Intake"
],
"operator": "EQUALS",
"property": "integrationPackName"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"Order Intake"
],
"operator": "EQUALS",
"property": "integrationPackName"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n Order Intake \n \n \n "
},
"GroupingExpression": {
"value": "\n \n Order Intake \n \n \n another-value \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IntegrationPackInstance/queryMore": {
"post": {
"tags": [
"IntegrationPackInstance"
],
"summary": "Retrieves additional results for an IntegrationPackInstance query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreIntegrationPackInstance",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPackInstance~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/IntegrationPackInstanceQueryResponse"
},
"example": {
"$ref": "#/paths/~1IntegrationPackInstance~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/JavaRollback/execute/{id}": {
"post": {
"tags": [
"JavaRollback"
],
"summary": "Executes an action on a JavaRollback object",
"description": "Returns a Runtime, Runtime cluster, Runtime cloud, Authentication Broker, or Gateway to use the previous version of Java with an EXECUTE operation. \n\n - 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:\n\n - For Runtimes, Runtime clusters, and Runtime clouds — the **Runtime Information** panel (**Manage** > **Runtime Management** of the user interface).\n\n - For Brokers — the **Broker Information** panel (**Configure Server** > **Authentication** of the user interface).\n\n - For API Gateways — the **Gateway Information** panel (**Configure Server** > **Gateways** of the user interface).\n\n To verify a successful rollback on a Runtime using the user interface, you can also navigate to **Runtime Management** > **Startup Properties** and reference the Java version number listed in the **Java Home** field.\n\n- The container must be online to use the Rollback Java operation.\n\n >**Important:** Only the node that runs upgrades (typically the head node) restarts automatically to run the updated Java version for Runtimes, Runtime clusters, and Runtime clouds. You must restart all other cluster nodes to successfully return to a previous version of Java. \n > To successfully return to a previous version of Java for API Management Gateways and Authentication Brokers, you must restart all Gateways and Brokers.",
"operationId": "ExecuteJavaRollback",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The unique ID assigned by the system to the container.\n\n1. Use the Runtime ID for Runtimes, Runtime clusters, and Runtime clouds found in the user interface by navigating to **Manage** > **Runtime Management** and viewing the Runtime Information panel for a selected container.\n\n2. Use the Gateway ID found in the user interface by navigating to **Configure Server** > **Gateways** > `` > Gateway Information panel.\n\n3. Use the Broker ID found in the user interface by navigating to **Configure Server** > **Authentication** > `` > Broker Information panel."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JavaRollback"
},
"example": {
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/JavaRollback"
},
"example": "\n\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JavaRollback"
},
"example": {
"@type": "JavaRollback",
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/JavaRollback"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/JavaUpgrade": {
"post": {
"tags": [
"JavaUpgrade"
],
"summary": "Creates a JavaUpgrade object",
"description": "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. \n\n - 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:\n - For Runtimes, Runtime clusters, and Runtime clouds — the **Runtime Information** panel (**Manage** > **Runtime Management** of the user interface).\n - For API Gateways — the **Gateway Information** panel (**Configure Server** > **Gateways** of the user interface).\n - You must have the **Runtime Management** privilege to perform the CREATE operation. If you have the **Runtime Management Read Access** privilege, you cannot use this operation to upgrade your container.\n - The container must be online to use the Upgrade Java operation.\n- The container must be eligible for upgrade.\n\n >**Important:** Only the node that runs upgrades (typically the head node) restarts automatically to run the updated Java version. Therefore, you must restart all other cluster nodes to install the upgrade.",
"operationId": "CreateJavaUpgrade",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JavaUpgrade"
},
"example": {
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "FIRST",
"dayOfWeek": "TUESDAY",
"hourOfDay": "13",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
"migrateCertificate": true,
"cacertsPath": "/cacerts/path1",
"externalJDKPath": "/external/JDK/path1",
"prefJreLocation": "EXTERNAL"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/JavaUpgrade"
},
"example": "\n\n \n true \n /boomi_atom/jre \n /usr/java/latest \n external \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JavaUpgrade"
},
"example": {
"@type": "JavaUpgradeSchedule",
"atomId": "01f3696e-6d92-4668-8019-061fec55264c",
"scheduleType": "FIRST",
"dayOfWeek": "TUESDAY",
"hourOfDay": "13",
"timeZone": "America/New_York",
"JavaUpgradeOptions": {
"migrateCertificate": true,
"cacertsPath": "/cacerts/path1",
"externalJDKPath": "/external/JDK/path1",
"prefJreLocation": "EXTERNAL"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/JavaUpgrade"
},
"example": "\n \n true \n /boomi_atom/jre \n external \n /usr/java/latest \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/MergeRequest": {
"post": {
"tags": [
"MergeRequest"
],
"summary": "Creates a MergeRequest object",
"description": "You can use the Merge Request object to merge a development branch into the main branch. \n\n - 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.\n\n- There are two merge request strategies you can choose from: OVERRIDE or CONFLICT_RESOLVE. An override merge automatically resolves any merge conflicts by prioritizing the branch specified in the `priorityBranch` field. If you choose the CONFLICT_RESOLVE strategy, you have the opportunity to review any conflicts and choose which version you want to keep.",
"operationId": "CreateMergeRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": {
"sourceBranchId": "QjoyMDI1OTk",
"destinationBranchId": "QjoyMDI1OTg",
"strategy": "OVERRIDE",
"priorityBranch": "SOURCE"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": {
"@type": "MergeRequest",
"id": "TVI6NTB9",
"sourceBranchId": "QjoyMDI1OTk",
"sourceBranchName": "branch-1",
"destinationBranchId": "QjoyMDI1OTg",
"destinationBranchName": "main",
"strategy": "OVERRIDE",
"stage": "DRAFTING",
"priorityBranch": "SOURCE",
"previousStage": "NOT_EXIST",
"modifiedBy": "userboomi.com",
"modifiedDate": "2024-05-17T19:00:30Z",
"createdBy": "userboomi.com",
"createdDate": "2024-05-17T19:00:30Z"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/MergeRequest/{id}": {
"get": {
"tags": [
"MergeRequest"
],
"summary": "Retrieves an instance of a MergeRequest object",
"description": "Retrieve more information about the recently performed merge. \n\n - 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:\n\n - OVERRIDE: The source branch has taken priority\n - KEEP_DESTINATION: The destination branch has taken priority\n - The `changeType` parameter is generated from a branch diff that is performed on merge and can be one of the following values:\n - ADDED: A component was added to the source branch\n - MODIFIED: A component was modified in the source branch\n - DELETED: A component was deleted in the source branch \n\n After performing a merge request between two branches, you can use the merge request’s ID to retrieve more information about the recently performed merge. The following example shows a merge between two branches where something was deleted in the source branch: \n\n Send an HTTP GET to `https://api.boomi.com/api/rest/v1/{accountId}/MergeRequest/{mergeRequestId}` where `{accountId}` is the ID of the authenticating account and `{mergeRequestId}` is the ID of the merge request. \n\n You can also use the GET operation to view a user's current working branch: \n\n Send an HTTP GET to `https://api.boomi.com/api/rest/v1/{accountId}/UserAccountProperty/defaultWorkingBranch` where the `{accountId}` is the ID of the account for which you want to view the working branch.",
"operationId": "GetMergeRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the merge request."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": {
"UserAccountProperty": {
"propertyName": "defaultWorkingBranch",
"propertyValue": "QjoyMDI1OTk"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"MergeRequest"
],
"summary": "Modifies or updates a MergeRequest object",
"description": "Modifies or updates a MergeRequest object",
"operationId": "UpdateMergeRequest",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the merge request."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": {
"id": "TVI6NjY3",
"strategy": "CONFLICT_RESOLVE",
"MergeRequestDetails": {
"MergeRequestDetail": {
"componentGuid": "50e9d4f5-fea6-4ab0-91b1-d8b683ede8c0",
"resolution": "KEEP_DESTINATION"
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": "\n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": {
"@type": "MergeRequest",
"id": "TVI6NTQ5",
"sourceBranchId": "QjoyMDI1OTk",
"sourceBranchName": "branch-1",
"destinationBranchId": "QjoyMDI1OTg",
"destinationBranchName": "main",
"strategy": "OVERRIDE",
"stage": "MERGING",
"priorityBranch": "DESTINATION",
"previousStage": "REVIEWING",
"modifiedBy": "anuja.vermaboomi.com",
"modifiedDate": "2024-09-24T13:15:27Z",
"createdBy": "userboomi.com",
"createdDate": "2024-09-24T05:36:59Z",
"MergeRequestDetails": {
"MergeRequestDetail": {
"componentGuid": "b6fc8152-bfbe-44b7-b96b-4959db06e23a",
"sourceRevision": "2",
"changeType": "ADDED",
"conflict": "false",
"stage": "DRAFTED",
"modifiedBy": "userboomi.com",
"modifiedDate": "2024-09-24T13:15:23Z",
"createdBy": "userboomi.com",
"createdDate": "2024-09-24T13:15:23Z"
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequest"
},
"example": "\n\n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/MergeRequest/query": {
"post": {
"tags": [
"MergeRequest"
],
"summary": "Queries for a MergeRequest object",
"description": "- You can query a branch to retrieve a list of all active merge request IDs.\n - You must include the destination or source branch as a parameter. Only EQUALS is allowed for these parameters.\n - Optional parameters include: \n - `createdDate` \n - `createdBy` \n - `stage` \n - `modifiedDate` \n - `modifiedBy` \n- You can use the `queryMore` request to return more than 100 results.\n\nFor more information about query filters, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters).",
"operationId": "QueryMergeRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequestQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"MERGED"
],
"operator": "EQUALS",
"property": "stage"
},
{
"argument": [
"QjoxMDU"
],
"operator": "EQUALS",
"property": "sourceBranchId"
},
{
"argument": [
"Qjox"
],
"operator": "EQUALS",
"property": "destinationBranchId"
},
{
"argument": [
"admin@boomi.com"
],
"operator": "EQUALS",
"property": "createdBy"
},
{
"argument": [
"admin@boomi.com"
],
"operator": "EQUALS",
"property": "modifiedBy"
},
{
"argument": [
"2024-05-22T15:11:39Z"
],
"operator": "EQUALS",
"property": "modifiedDate"
},
{
"argument": [
"2024-05-22T15:07:37Z"
],
"operator": "EQUALS",
"property": "createdDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"MERGED"
],
"operator": "EQUALS",
"property": "stage"
},
{
"argument": [
"QjoxMDU"
],
"operator": "EQUALS",
"property": "sourceBranchId"
},
{
"argument": [
"Qjox"
],
"operator": "EQUALS",
"property": "destinationBranchId"
},
{
"argument": [
"admin@boomi.com"
],
"operator": "EQUALS",
"property": "createdBy"
},
{
"argument": [
"admin@boomi.com"
],
"operator": "EQUALS",
"property": "modifiedBy"
},
{
"argument": [
"2024-05-22T15:11:39Z"
],
"operator": "EQUALS",
"property": "modifiedDate"
},
{
"argument": [
"2024-05-22T15:07:37Z"
],
"operator": "EQUALS",
"property": "createdDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequestQueryConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequestQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "MergeRequest",
"id": "TVI6Mg",
"sourceBranchId": "QjoxMDU",
"destinationBranchId": "Qjox",
"stage": "MERGED",
"modifiedBy": "admin@boomi.com",
"modifiedDate": "2024-05-22T15:11:39Z",
"createdBy": "admin@boomi.com",
"createdDate": "2024-05-22T15:07:37Z"
}
],
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequestQueryResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/MergeRequest/queryMore": {
"post": {
"tags": [
"MergeRequest"
],
"summary": "Retrieves additional results for a MergeRequest query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreMergeRequest",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergeRequestQueryResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MergeRequestQueryResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/MoveQueueRequest": {
"post": {
"tags": [
"MoveQueueRequest"
],
"summary": "Creates a MoveQueueRequest object",
"description": "Moves messages from one Runtime queue to another. \n\n - You must have the **Runtime Management** privilege to use the Move queue request operation.\n- 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.\n- Any Runtime queues that you specify in the request must currently exist on the Runtime. For clarification, you cannot create a new endpoint using the CREATE operation.\n- You must supply the *AtomID*, *SourceQueue*, *QueueName*, *DLQ*, and *DestinationQueue* fields in the request.\n- If the operation returns an error, it logs a message in the Runtime, Runtime cluster, or Runtime cloud, but is not sent to the platform.\n- You cannot track move updates directly through this operation. Instead, to see if the action is in progress or complete, use the Queue Management API or the ListQueues API to observe the number of messages in the queue.",
"operationId": "CreateMoveQueueRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveQueueRequest"
},
"example": {
"AtomId": "Atom_ID",
"SourceQueue": {
"QueueName": "queue1",
"SubscriberName": "SUBSCRIBER_ID",
"DLQ": "true"
},
"DestinationQueue": {
"QueueName": "pubsub1",
"SubscriberName": "SUBSCRIBER_ID",
"DLQ": "false"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MoveQueueRequest"
},
"example": "\n \n\t \n\t \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveQueueRequest"
},
"example": {
"@type": "QueueMessageResponse",
"message": "Request submitted to atom id: to move queue messages from to "
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/MoveQueueRequest"
},
"example": "\n \n node1 \n node2 \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NodeOffboard"
},
"example": {
"@type": "NodeOffboard",
"nodeId": [
"node1"
],
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/NodeOffboard"
},
"example": "\n \n node1 \n node2 \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ODETTEConnectorRecord/query": {
"post": {
"tags": [
"ODETTEConnectorRecord"
],
"summary": "Queries for an ODETTEConnectorRecord object(s).",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryODETTEConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ODETTEConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-7322d483-b661-4102-b49c-4b3d697591d1-2023.02.13"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-7322d483-b661-4102-b49c-4b3d697591d1-2023.02.13"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ODETTEConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n \n \n execution-7322d483-b661-4102-b49c-4b3d697591d1-2023.02.13 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-7322d483-b661-4102-b49c-4b3d697591d1-2023.02.13 \n \n \n another-value \n \n \n \n boomi-internal \n execution-7322d483-b661-4102-b49c-4b3d697591d1-2023.02.13 \n 13d6a926-ccff-4eb5-8b60-28ffe33981c9 \n 2023-02-13T22:22:32Z \n connector-0f7e5065-5370-4503-a6c5-4636aed057d2 \n Send \n odette \n Trading Partner \n shape3~e40acd5f-8771-419f-8844-4a15e72c9326 \n 2 \n true \n 30 \n 1111 \n 6 \n 1 \n 230213 \n 1722 \n N/A \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ODETTEConnectorRecord/queryMore": {
"post": {
"tags": [
"ODETTEConnectorRecord"
],
"summary": "Retrieves additional results for an ODETTEConnectorRecord query.",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreODETTEConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ODETTEConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1ODETTEConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ODETTEConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1ODETTEConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OFTP2ConnectorRecord/query": {
"post": {
"tags": [
"OFTP2ConnectorRecord"
],
"summary": "Queries for an OFTP2ConnectorRecord object",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\nTo filter by a custom field, 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 [Custom Tracked Field](/docs/api/platformapi/CustomTrackedField) object. \n\n \n\n The STARTS_WITH operator accepts only values that do not include spaces. \n\n Sorting of the QUERY results are by the dateProcessed field value, from the oldest to the newest.",
"operationId": "QueryOFTP2ConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OFTP2ConnectorRecordQueryConfig"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OFTP2ConnectorRecordQueryConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OFTP2ConnectorRecordQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "OFTP2ConnectorRecord",
"sfiddsn": "SHARED",
"sfiddate": "2023-06-07",
"sfidtime": "10:06:46.2389",
"sfiddest": "O0166SHAREDSERVER",
"ssidcode": "O01BOOMI",
"status": "success",
"account": "boomi-internal",
"executionId": "execution-003c07c1-969f-4331-96d3-d7af1ca6e1f7-2023.06.07",
"atomId": "92c4bf82-af93-4607-83d8-10a6c7fc7169",
"dateProcessed": "2023-06-07T14:09:40Z",
"id": "connector-1ccb87c7-13f7-41f2-be3b-93778837f641",
"actionType": "Listen",
"connectorType": "oftpserver",
"connectorName": "oftpserver Connector",
"operationName": "OFTP Server Connector Operation",
"documentIndex": 1,
"successful": true,
"size": [
"Long",
6
]
}
],
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OFTP2ConnectorRecordQueryResponse"
},
"example": "\n \n SHARED \n 2023-06-07 \n 10:06:46.2389 \n O0166SHAREDSERVER \n O01BOOMI \n success \n boomi-internal \n execution-003c07c1-969f-4331-96d3-d7af1ca6e1f7-2023.06.07 \n 92c4bf82-af93-4607-83d8-10a6c7fc7169 \n 2023-06-07T14:09:40Z \n connector-1ccb87c7-13f7-41f2-be3b-93778837f641 \n Listen \n oftpserver \n oftpserver Connector \n OFTP Server Connector Operation \n 1 \n true \n 6 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OFTP2ConnectorRecord/queryMore": {
"post": {
"tags": [
"OFTP2ConnectorRecord"
],
"summary": "Retrieves additional results for an OFTP2ConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreOFTP2ConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OFTP2ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1OFTP2ConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OFTP2ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1OFTP2ConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponent": {
"post": {
"tags": [
"PackagedComponent"
],
"summary": "Creates a PackagedComponent object",
"description": "- 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.\n - **To create a new packaged component**, you must include a component ID in the request body. You create a packaged component for the specified componentId. Optionally, you can specify a packageVersion value and notes about the package version.\n >**Note:** You cannot add package versions and notes after creating the packaged component. However, if not specified, automatically assigns a numerical version number to your new packaged component.\n - **To restore or recover a deleted packaged component**, you must specify the packageId, componentId, and packageVersion. You can query the Packaged Component object for a list of deleted packaged components. \n - Specify a `branchName` to create a packaged component on a particular branch. If `branchName` is not provided, the default working branch is used.",
"operationId": "CreatePackagedComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponent"
},
"example": {
"componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
"packageVersion": "1.2",
"notes": "Package for deployment"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponent"
},
"example": "\n 66d665d1-3ec7-479c-9e24-8df3fa728cf8 \n 357f7a90-7708-45f9-9f28-a83bc74d49a6 \n 1.2 \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponent"
},
"example": {
"@type": "PackagedComponent",
"packageId": "357f7a90-7708-45f9-9f28-a83bc74d49a6",
"packageVersion": "1.3",
"componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
"componentVersion": "2.0",
"componentType": "process",
"createdDate": "2017-11-01T18:40:55Z",
"createdBy": "user@boomi.com",
"shareable": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponent"
},
"example": "\n \n 357f7a90-7708-45f9-9f28-a83bc74d49a6 \n 1.2 \n 66d665d1-3ec7-479c-9e24-8df3fa728cf8 \n 6 \n process \n 2021-01-20T18:52:13Z \n user@boomi.com \n false \n false \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponent/{id}": {
"get": {
"tags": [
"PackagedComponent"
],
"summary": "Retrieves an instance of a PackagedComponent object",
"description": "Retrieves the packaged component with the specified ID.",
"operationId": "GetPackagedComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponent"
},
"example": {
"@type": "PackagedComponent",
"packageId": "e8dbc278-e970-49e5-84bd-af39d7d38140",
"packageVersion": "2.0",
"componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
"componentVersion": "2.0",
"componentType": "process",
"createdDate": "2017-03-16T13:34:01Z",
"createdBy": "user@boomi.com",
"notes": "Created for component publication with GUID f7f6ddb6-9437-4a90-9655-f01970068ca8 and version 2.",
"shareable": true,
"deleted": false
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponent"
},
"example": "\n e8dbc278-e970-49e5-84bd-af39d7d38140 \n 2.0 \n 66d665d1-3ec7-479c-9e24-8df3fa728cf8 \n 2.0 \n process \n 2017-03-16T13:34:01Z \n user@boomi.com \n Created for component publication with GUID f7f6ddb6-9437-4a90-9655-f01970068ca8 and version 2. \n true \n false \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"PackagedComponent"
],
"summary": "Deletes a PackagedComponent object",
"description": "- 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.\n >**Note:** You can restore deleted packaged components using the CREATE operation. Refer to the section **Using the CREATE operation** for more details.\n\n- You cannot delete a packaged component if it is already in use. If currently deployed, a packaged component is considered in use if it is used in the **Process Library** or as part of an integration pack.",
"operationId": "DeletePackagedComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponent/bulk": {
"post": {
"tags": [
"PackagedComponent"
],
"summary": "Retrieves multiple PackagedComponent objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkPackagedComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponent/query": {
"post": {
"tags": [
"PackagedComponent"
],
"summary": "Queries for a PackagedComponent object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryPackagedComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"process"
],
"operator": "EQUALS",
"property": "componentType"
},
{
"argument": [
"66d665d1-3ec7-479c-9e24-8df3fa728cf8"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"1.0"
],
"operator": "EQUALS",
"property": "packageVersion"
},
{
"argument": [
"true"
],
"operator": "EQUALS",
"property": "shareable"
},
{
"argument": [
"user@boomi.com"
],
"operator": "EQUALS",
"property": "createdBy"
},
{
"argument": [
"2017-01-01T00:00:00Z",
"2017-11-02T00:00:00Z"
],
"operator": "BETWEEN",
"property": "createdDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"process"
],
"operator": "EQUALS",
"property": "componentType"
},
{
"argument": [
"66d665d1-3ec7-479c-9e24-8df3fa728cf8"
],
"operator": "EQUALS",
"property": "componentId"
},
{
"argument": [
"1.0"
],
"operator": "EQUALS",
"property": "packageVersion"
},
{
"argument": [
"true"
],
"operator": "EQUALS",
"property": "shareable"
},
{
"argument": [
"user@boomi.com"
],
"operator": "EQUALS",
"property": "createdBy"
},
{
"argument": [
"2017-01-01T00:00:00Z",
"2017-11-02T00:00:00Z"
],
"operator": "BETWEEN",
"property": "createdDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n process \n \n \n 66d665d1-3ec7-479c-9e24-8df3fa728cf8 \n \n \n 1.0 \n \n \n true \n \n \n user@boomi.com \n \n \n 2017-01-01T00:00:00Z \n 2017-11-01T00:00:00Z \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n process \n \n \n another-value \n \n \n \n a4543ff8-5acf-4090-8094-ec8dbb6a7406 \n 1.0 \n 66d665d1-3ec7-479c-9e24-8df3fa728cf8 \n 2.0 \n process \n 2017-01-12T17:29:55Z \n user@boomi.com \n Created for component publication with GUID xxx \n true \n false \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponent/queryMore": {
"post": {
"tags": [
"PackagedComponent"
],
"summary": "Retrieves additional results for a PackagedComponent query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMorePackagedComponent",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentQueryResponse"
},
"example": {
"$ref": "#/paths/~1PackagedComponent~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentQueryResponse"
},
"example": {
"$ref": "#/paths/~1PackagedComponent~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponentManifest/{packageId}": {
"get": {
"tags": [
"PackagedComponentManifest"
],
"summary": "Retrieves an instance of a PackagedComponentManifest object",
"description": "Retrieve a list of the included components and their summary metadata for a single version of a packaged component.",
"operationId": "GetPackagedComponentManifest",
"parameters": [
{
"name": "packageId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the packaged component."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentManifest"
},
"example": {
"@type": "PackagedComponent",
"packageId": "e8dbc278-e970-49e5-84bd-af39d7d38140",
"packageVersion": "2.0",
"componentId": "66d665d1-3ec7-479c-9e24-8df3fa728cf8",
"componentVersion": "2.0",
"componentType": "process",
"createdDate": "2017-03-16T13:34:01Z",
"createdBy": "user@boomi.com",
"notes": "Created for component publication with GUID f7f6ddb6-9437-4a90-9655-f01970068ca8 and version 2.",
"shareable": true,
"deleted": false
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentManifest"
},
"example": "\n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PackagedComponentManifest/bulk": {
"post": {
"tags": [
"PackagedComponentManifest"
],
"summary": "Retrieves multiple PackagedComponentManifest objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkPackagedComponentManifest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentManifestBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentManifestBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentManifestBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PackagedComponentManifestBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PersistedProcessProperties/{id}": {
"post": {
"tags": [
"PersistedProcessProperties"
],
"summary": "Modifies or updates a PersistedProcessProperties object",
"description": "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.\n\n>**Note:** You can update the Persisted Process properties if you have either the Runtime Management privilege or the Runtime Management Read Access, along with the Persisted Process Property Read and Write Access privilege.",
"operationId": "UpdatePersistedProcessProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the Runtime."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedProcessProperties"
},
"example": {
"@type": "PersistedProcessProperties",
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"Process": [
{
"@type": "DeployedProcess",
"processId": "6841b8e2-755e-4ab1-bd31-fcfc9bf7893d",
"ProcessProperties": {
"@type": ""
}
},
{
"@type": "DeployedProcess",
"processId": "1ebcc68e-a1f6-42f5-95a0-a01635e6e3a4",
"ProcessProperties": {
"@type": "",
"ProcessProperty": [
{
"@type": "",
"Name": "property1",
"Value": "157"
},
{
"@type": "",
"Name": "property2",
"Value": "158"
},
{
"@type": "",
"Name": "property3",
"Value": "159"
}
]
}
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PersistedProcessProperties"
},
"example": "\n\n 3456789a-bcde-f012-3456-789abcdef012 \n \n 6841b8e2-755e-4ab1-bd31-fcfc9bf7893d \n \n \n 1ebcc68e-a1f6-42f5-95a0-a01635e6e3a4 \n \n \n property1 \n 157 \n \n \n property2 \n 158 \n \n \n property3 \n 159 \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedProcessProperties"
},
"example": {
"@type": "PersistedProcessProperties",
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"Process": [
{
"@type": "DeployedProcess",
"processId": "6841b8e2-755e-4ab1-bd31-fcfc9bf7893d",
"ProcessProperties": {
"@type": "",
"ProcessProperty": []
}
},
{
"@type": "DeployedProcess",
"processId": "1ebcc68e-a1f6-42f5-95a0-a01635e6e3a4",
"ProcessProperties": {
"@type": "",
"ProcessProperty": [
{
"@type": "",
"Name": "property1",
"Value": "157"
},
{
"@type": "",
"Name": "property2",
"Value": "158"
},
{
"@type": "",
"Name": "property3",
"Value": "159"
}
]
}
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PersistedProcessProperties"
},
"example": "\n\n 3456789a-bcde-f012-3456-789abcdef012 \n \n 6841b8e2-755e-4ab1-bd31-fcfc9bf7893d \n \n \n 1ebcc68e-a1f6-42f5-95a0-a01635e6e3a4 \n \n \n property1 \n 157 \n \n \n property2 \n 158 \n \n \n property3 \n 159 \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Process/{id}": {
"get": {
"tags": [
"Process"
],
"summary": "Retrieves an instance of a Process object",
"description": "Retrieves the properties of the process having the specified ID. \n\n 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.",
"operationId": "GetProcess",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the process. For deployed processes and processes belonging to single-install integration packs, this value is the process component ID. For processes belonging to multi-install integration packs, this is an synthetic ID and does not match an actual process component. You can use this value as the `extensionGroupId` when querying the Environment Extensions object."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Process"
},
"example": {
"@type": "Process",
"IntegrationPack": [
{
"@type": "ProcessIntegrationPackInfo",
"integrationPackId": "89abcdef-0123-4567-89ab-cdef01234567",
"integrationPackInstanceId": "76543210FEDCBA9876543210FEDCBA98"
}
],
"Description": "string",
"name": "Order Intake",
"id": "56789abc-def0-1234-5678-9abcdef01234"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Process"
},
"example": "\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Process/bulk": {
"post": {
"tags": [
"Process"
],
"summary": "Retrieves multiple Process objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkProcess",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Process/query": {
"post": {
"tags": [
"Process"
],
"summary": "Queries for a Process object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryProcess",
"requestBody": {
"description": " Possible properties include: name, id, integrationPackId, integrationPackInstanceId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"Order Intake"
],
"operator": "EQUALS",
"property": "name"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"Order Intake"
],
"operator": "EQUALS",
"property": "name"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n Order Intake \n \n \n "
},
"GroupingExpression": {
"value": "\n \n Order Intake \n \n \n another-value \n \n \n \n \n \n ...\n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Process/queryMore": {
"post": {
"tags": [
"Process"
],
"summary": "Retrieves additional results for a Process query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreProcess",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessQueryResponse"
},
"example": {
"$ref": "#/paths/~1Process~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessQueryResponse"
},
"example": {
"$ref": "#/paths/~1Process~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessAtomAttachment": {
"post": {
"tags": [
"ProcessAtomAttachment"
],
"summary": "Creates a ProcessAtomAttachment object",
"description": "Attaches a process having the specified ID to the Runtime having the specified ID.",
"operationId": "CreateProcessAtomAttachment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachment"
},
"example": {
"processId": "56789abc-def0-1234-5678-9abcdef01234",
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachment"
},
"example": {
"@type": "ProcessAtomAttachment",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"processId": "56789abc-def0-1234-5678-9abcdef01234",
"componentType": "process",
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessAtomAttachment/query": {
"post": {
"tags": [
"ProcessAtomAttachment"
],
"summary": "Queries for a ProcessAtomAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryProcessAtomAttachment",
"requestBody": {
"description": " Possible properties include: atomId, processId, componentType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"3456789a-bcde-f012-3456-789abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f012-3456-789abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessAtomAttachment/queryMore": {
"post": {
"tags": [
"ProcessAtomAttachment"
],
"summary": "Retrieves additional results for a ProcessAtomAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreProcessAtomAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessAtomAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessAtomAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessAtomAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessAtomAttachment/{id}": {
"delete": {
"tags": [
"ProcessAtomAttachment"
],
"summary": "Deletes a ProcessAtomAttachment object",
"description": "Detaches a process from a Runtime where the attachment is specified by the conceptual Process Atom Attachment object ID.",
"operationId": "DeleteProcessAtomAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessEnvironmentAttachment": {
"post": {
"tags": [
"ProcessEnvironmentAttachment"
],
"summary": "Creates a ProcessEnvironmentAttachment object",
"description": "Attaches a process having the specified ID to the environment having the specified ID.",
"operationId": "CreateProcessEnvironmentAttachment",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachment"
},
"example": {
"processId": "56789abc-def0-1234-5678-9abcdef01234",
"componentType": "process",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachment"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachment"
},
"example": {
"@type": "ProcessEnvironmentAttachment",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"processId": "56789abc-def0-1234-5678-9abcdef01234",
"componentType": "process",
"environmentId": "456789ab-cdef-0123-4567-89abcdef0123"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachment"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessEnvironmentAttachment/query": {
"post": {
"tags": [
"ProcessEnvironmentAttachment"
],
"summary": "Queries for a ProcessEnvironmentAttachment object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryProcessEnvironmentAttachment",
"requestBody": {
"description": " Possible properties include: environmentId, processId, componentType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"456789ab-cdef-0123-4567-89abcdef0123"
],
"operator": "EQUALS",
"property": "environmentId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachmentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 456789ab-cdef-0123-4567-89abcdef0123 \n \n \n another-value \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessEnvironmentAttachment/queryMore": {
"post": {
"tags": [
"ProcessEnvironmentAttachment"
],
"summary": "Retrieves additional results for a ProcessEnvironmentAttachment query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreProcessEnvironmentAttachment",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessEnvironmentAttachment~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessEnvironmentAttachmentQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessEnvironmentAttachment~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessEnvironmentAttachment/{id}": {
"delete": {
"tags": [
"ProcessEnvironmentAttachment"
],
"summary": "Deletes a ProcessEnvironmentAttachment object",
"description": "Detaches a process from an environment where the attachment is specified by the conceptual Process Environment Attachment object ID.",
"operationId": "DeleteProcessEnvironmentAttachment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessLog": {
"post": {
"tags": [
"ProcessLog"
],
"summary": "Creates a ProcessLog object",
"description": "Download process run logs.",
"operationId": "CreateProcessLog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessLog"
},
"example": {
"executionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01",
"logLevel": "ALL"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessLog"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": {
"@type": "LogDownload",
"url": "http://localhost:8081/account/account-123456/api/download/ProcessLog-89abcdef-0123-4567-89ab-cdef01234567",
"message": "Beginning download.",
"statusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/LogDownload"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessScheduleStatus/{id}": {
"get": {
"tags": [
"ProcessScheduleStatus"
],
"summary": "Retrieves an instance of a ProcessScheduleStatus object",
"description": "Retrieves the Process Schedule Status object with a specified conceptual ID. \n\n 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.",
"operationId": "GetProcessScheduleStatus",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The object’s conceptual ID, which is synthesized from the process and Runtime IDs."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatus"
},
"example": {
"@type": "ProcessScheduleStatus",
"enabled": true,
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatus"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatus"
},
"example": {
"@type": "ProcessScheduleStatus",
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
"enabled": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatus"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessScheduleStatus/bulk": {
"post": {
"tags": [
"ProcessScheduleStatus"
],
"summary": "Retrieves multiple ProcessScheduleStatus objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkProcessScheduleStatus",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessScheduleStatus/query": {
"post": {
"tags": [
"ProcessScheduleStatus"
],
"summary": "Queries for a ProcessScheduleStatus object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n >**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.",
"operationId": "QueryProcessScheduleStatus",
"requestBody": {
"description": " Possible properties include: processId, atomId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "processId"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "processId"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n 789abcde-f012-3456-789a-bcdef0123456 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessScheduleStatus/queryMore": {
"post": {
"tags": [
"ProcessScheduleStatus"
],
"summary": "Retrieves additional results for a ProcessScheduleStatus query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreProcessScheduleStatus",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessScheduleStatus~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessScheduleStatusQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessScheduleStatus~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessSchedules/{id}": {
"get": {
"tags": [
"ProcessSchedules"
],
"summary": "Retrieves an instance of a ProcessSchedules object",
"description": "Retrieves the Process Schedules object with a specific conceptual ID. \n\n 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.",
"operationId": "GetProcessSchedules",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The object’s conceptual ID, which is synthesized from the process and Runtime IDs."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedules"
},
"example": {
"@type": "ProcessSchedules",
"Schedule": [
{
"@type": "Schedule",
"minutes": "0-59/15",
"hours": "8-18",
"daysOfWeek": "2,3,4,5,6",
"daysOfMonth": "*",
"months": "*",
"years": "*"
},
{
"@type": "Schedule",
"minutes": "0-59/15",
"hours": "19-23",
"daysOfWeek": "1",
"daysOfMonth": "*",
"months": "*",
"years": "*"
}
],
"Retry": {
"@type": "ScheduleRetry",
"Schedule": [
{
"@type": "Schedule",
"minutes": "0-10/5",
"hours": "19-23",
"daysOfWeek": "7",
"daysOfMonth": "*",
"months": "*",
"years": "*"
},
{
"@type": "Schedule",
"minutes": "0-59/20",
"hours": "8-18",
"daysOfWeek": "2,3,4,5,6",
"daysOfMonth": "*",
"months": "*",
"years": "*"
}
],
"maxRetry": 2
},
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedules"
},
"example": "\n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"ProcessSchedules"
],
"summary": "Modifies or updates a ProcessSchedules object",
"description": "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.\n\nA Process Schedules object exists for every deployed process. If you do not update the schedule, the object is empty and a run schedule is not in effect.\n\n>**Note:** Listener processes cannot be scheduled. If a listener process is referenced, the call will fail with a 400 status code.\n\nYou must have the **Runtime Management** privilege and the **Scheduling** privilege to perform the UPDATE operation. If you have the **Runtime Management Read Access** privilege, you cannot update process run schedules.\n\n>**Note:** After you update run schedules for a process on a Runtime, those schedules appear in the **Scheduling** dialog using the Advanced (cron) syntax.\n\nYou can additionally employ a Bulk UPDATE operation for the Process Schedules object. Refer to the related links for more information about performing a Bulk UPDATE operation.",
"operationId": "UpdateProcessSchedules",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The object’s conceptual ID, which is synthesized from the process and Runtime IDs."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedules"
},
"example": {
"Schedule": [
{
"minutes": "0-59/15",
"hours": "8-18",
"daysOfWeek": "2,3,4,5,6",
"daysOfMonth": "*",
"months": "*",
"years": "*"
},
{
"minutes": "0-59/15",
"hours": "19-23",
"daysOfWeek": "1",
"daysOfMonth": "*",
"months": "*",
"years": "*"
}
],
"Retry": {
"Schedule": [
{
"minutes": "0-10/5",
"hours": "19-23",
"daysOfWeek": "7",
"daysOfMonth": "*",
"months": "*",
"years": "*"
},
{
"minutes": "0-59/20",
"hours": "8-18",
"daysOfWeek": "2,3,4,5,6",
"daysOfMonth": "*",
"months": "*",
"years": "*"
}
],
"maxRetry": 2
},
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedules"
},
"example": "\n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedules"
},
"example": {
"@type": "ProcessSchedules",
"Schedule": [
{
"@type": "Schedule",
"minutes": "0-59/15",
"hours": "8-18",
"daysOfWeek": "2,3,4,5,6",
"daysOfMonth": "*",
"months": "*",
"years": "*"
},
{
"@type": "Schedule",
"minutes": "0-59/15",
"hours": "19-23",
"daysOfWeek": "1",
"daysOfMonth": "*",
"months": "*",
"years": "*"
}
],
"Retry": {
"@type": "ScheduleRetry",
"Schedule": [
{
"@type": "Schedule",
"minutes": "0-10/5",
"hours": "19-23",
"daysOfWeek": "7",
"daysOfMonth": "*",
"months": "*",
"years": "*"
},
{
"@type": "Schedule",
"minutes": "0-59/20",
"hours": "8-18",
"daysOfWeek": "2,3,4,5,6",
"daysOfMonth": "*",
"months": "*",
"years": "*"
}
],
"maxRetry": 2
},
"processId": "789abcde-f012-3456-789a-bcdef0123456",
"atomId": "3456789a-bcde-f0123-4567-89abcdef012",
"id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedules"
},
"example": "\n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessSchedules/bulk": {
"post": {
"tags": [
"ProcessSchedules"
],
"summary": "Retrieves multiple ProcessSchedules objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkProcessSchedules",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessSchedules/query": {
"post": {
"tags": [
"ProcessSchedules"
],
"summary": "Queries for a ProcessSchedules object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n >**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.",
"operationId": "QueryProcessSchedules",
"requestBody": {
"description": " Possible properties include: processId, atomId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "processId"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property": "atomId"
},
{
"argument": [
"789abcde-f012-3456-789a-bcdef0123456"
],
"operator": "EQUALS",
"property": "processId"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n 789abcde-f012-3456-789a-bcdef0123456 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ProcessSchedules/queryMore": {
"post": {
"tags": [
"ProcessSchedules"
],
"summary": "Retrieves additional results for a ProcessSchedules query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreProcessSchedules",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessSchedules~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ProcessSchedulesQueryResponse"
},
"example": {
"$ref": "#/paths/~1ProcessSchedules~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RerunDocument": {
"post": {
"tags": [
"RerunDocument"
],
"summary": "Creates a RerunDocument object",
"description": "Allows you to reprocess one or more documents from a previous run.",
"operationId": "CreateRerunDocument",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RerunDocument"
},
"example": {
"@type": "RerunDocument",
"AllDocuments": {
"@type": "AllDocuments",
"documentStatus": "ANY"
},
"originalExecutionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RerunDocument"
},
"example": "\n \n \n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RerunDocument"
},
"example": {
"@type": "RerunDocument",
"AllDocuments": {
"@type": "AllDocuments",
"documentStatus": "ANY"
},
"originalExecutionId": "execution-3456789a-bcde-f012-3456-789abcdef012-2015.01.01"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RerunDocument"
},
"example": "\n\n \n \n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Role": {
"post": {
"tags": [
"Role"
],
"summary": "Creates a Role object",
"description": "Creates a Role object based on the supplied values.",
"operationId": "CreateRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": {
"Description": "This is a custom role added",
"Privileges": {
"Privilege": [
{
"name": "API"
},
{
"name": "EXECUTE"
},
{
"name": "BUILD"
}
]
},
"accountId": "accountId-12345",
"name": "myRole",
"parentId": "ca7f37b3-f976-4d06-b885-81520b467a69"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": "This is a custom role added\n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": {
"@type": "Role",
"Description": "Live and direct via API!",
"Privileges": {
"@type": "Privileges",
"Privilege": [
{
"@type": "",
"name": "EMBED"
},
{
"@type": "",
"name": "EXECUTE"
},
{
"@type": "",
"name": "ATOM_MANAGEMENT"
},
{
"@type": "",
"name": "VIEW_RESULT"
}
]
},
"id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
"accountId": "account-12345",
"name": "JsonRole",
"parentId": "ca7f37b3-f976-4d06-b885-81520b467a69"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": "This is a custom role added \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Role/{id}": {
"get": {
"tags": [
"Role"
],
"summary": "Retrieves an instance of a Role object",
"description": "Returns a single Role object based on the supplied role ID.",
"operationId": "GetRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": {
"@type": "Role",
"Description": "Updated Role",
"Privileges": {
"@type": "Privileges",
"Privilege": [
{
"@type": "",
"name": "DEPLOY"
},
{
"@type": "",
"name": "SCHEDULE_MAINTENANCE"
}
]
},
"id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
"accountId": "account-12345",
"name": "Soap Role",
"parentId": "ca7f37b3-f976-4d06-b885-81520b467a69"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": "my role\n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"Role"
],
"summary": "Modifies or updates a Role object",
"description": "Updates a role as identified by its role ID.",
"operationId": "UpdateRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": {
"Description": "Updated custom role",
"Privileges": {
"Privilege": [
{
"name": "API"
},
{
"name": "EXECUTE"
},
{
"name": "BUILD"
}
]
},
"accountId": "accountId-12345",
"name": "newRoleName",
"id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
"parentId": "ca7f37b3-f976-4d06-b885-81520b467a69f"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": "\n Updated custom role \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": {
"@type": "Role",
"Description": "my updated role",
"Privileges": {
"@type": "Privileges",
"Privilege": [
{
"@type": "",
"name": "EMBED"
}
]
},
"id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
"accountId": "account-12345",
"name": "JsonRole",
"parentId": "ca7f37b3-f976-4d06-b885-81520b467a69f"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/Role"
},
"example": "\n Updated custom role \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"Role"
],
"summary": "Deletes a Role object",
"description": "Deletes a Role object based on the supplied role ID.",
"operationId": "DeleteRole",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Role/bulk": {
"post": {
"tags": [
"Role"
],
"summary": "Retrieves multiple Role objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkRole",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RoleBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RoleBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Role/query": {
"post": {
"tags": [
"Role"
],
"summary": "Queries for a Role object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryRole",
"requestBody": {
"description": " Possible properties include: name, parentId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleQueryConfig"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RoleQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n myRole \n \n \n ca7f37b3-f976-4d06-b885-81520b467a69f \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n myRole \n \n \n another-value \n \n \n \n my role description \n \n \n \n \n \n \n This is a custom role \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Role/queryMore": {
"post": {
"tags": [
"Role"
],
"summary": "Retrieves additional results for a Role query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreRole",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1Role~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RoleQueryResponse"
},
"example": {
"$ref": "#/paths/~1Role~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RosettaNetConnectorRecord/query": {
"post": {
"tags": [
"RosettaNetConnectorRecord"
],
"summary": "Queries for a RosettaNetConnectorRecord object(s)",
"description": "- To filter by a customField, 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 [Custom Tracked Field object](/docs/api/platformapi/CustomTrackedField). \n - The STARTS_WITH operator accepts values that do not include spaces only. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryRosettaNetConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RosettaNetConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RosettaNetConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05 \n \n \n another-value \n \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2018-09-05T06:24:12Z \n connector-abcdef01-2345-6789-abcd-ef0123456789 \n Listen \n rosettanet \n Start \n Sample RosettaNet Listen Operation \n 0 \n true \n 654 \n \n 13 \n 2018-09-05T10:53:59-0400 \n sample \n \n Acknowledged \n Success \n 951751851 \n 928523723 \n 951751851 \n 2.0 \n 3A4 \n V02.00.00 \n N/A \n N/A \n N/A \n Seller \n 42 \n Seller Service \n Buyer Service \n Request Purchase Order \n N/A \n 9 \n 2 \n Purchase Order Request \n 9 \n Test \n N/A \n 20180905T062412.327Z \n Yes \n N/A \n N/A \n N/A \n \n ...\n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2018.09.05 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2018-09-05T06:25:02Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Listen \n rosettanet \n Start \n Sample RosettaNet Listen Operation \n 49 \n true \n 564 \n \n 55 \n 2018-09-05T10:57:14-0400 \n sample \n \n Acknowledged \n Success \n 951751851 \n 928523723 \n 951751851 \n 2.0 \n 3A4 \n V02.00.00 \n N/A \n N/A \n N/A \n Seller \n 42 \n Seller Service \n Buyer Service \n Request Purchase Order \n N/A \n 9 \n 2 \n Purchase Order Request \n 9 \n Test \n N/A \n 20180905T062502.327Z \n Yes \n N/A \n N/A \n N/A \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RosettaNetConnectorRecord/queryMore": {
"post": {
"tags": [
"RosettaNetConnectorRecord"
],
"summary": "Retrieves additional results for a RosettaNetConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreRosettaNetConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RosettaNetConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1RosettaNetConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RosettaNetConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1RosettaNetConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeReleaseSchedule": {
"post": {
"tags": [
"RuntimeReleaseSchedule"
],
"summary": "Creates a RuntimeReleaseSchedule object",
"description": "The CREATE operation sets a schedule for receiving updates with the scheduleType, dayOfWeek, hourOfDay, and timeZone fields.",
"operationId": "CreateRuntimeReleaseSchedule",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": {
"atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
"scheduleType": "LAST",
"dayOfWeek": "SATURDAY",
"hourOfDay": 17,
"timeZone": "Australia/Queensland"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": "\n\n 407e55c8-b4b8-452a-8163-8e8989e64bc8 \n LAST \n FRIDAY \n 0 \n Australia/Queensland \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": {
"@type": "RuntimeReleaseSchedule",
"atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
"scheduleType": "LAST",
"dayOfWeek": "SATURDAY",
"hourOfDay": 17,
"timeZone": "Australia/Queensland"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": "\n\n c2eed3ce-8caf-4c4c-9420-9af3fab0c3ed \n LAST \n FRIDAY \n 0 \n Australia/Queensland \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeReleaseSchedule/{id}": {
"get": {
"tags": [
"RuntimeReleaseSchedule"
],
"summary": "Retrieves an instance of a RuntimeReleaseSchedule object",
"description": "The GET operation returns the current schedule for receiving updates on a specified Runtime, Runtime cluster, or Runtime cloud.",
"operationId": "GetRuntimeReleaseSchedule",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the container for which you want to set a schedule."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": {
"@type": "RuntimeReleaseSchedule",
"atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
"scheduleType": "LAST",
"dayOfWeek": "SATURDAY",
"hourOfDay": 17,
"timeZone": "Australia/Queensland"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": "\n\n c2eed3ce-8caf-4c4c-9420-9v4sfab0c3ed \n NEVER \n 0 \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"RuntimeReleaseSchedule"
],
"summary": "Modifies or updates a RuntimeReleaseSchedule object",
"description": "The UPDATE operation modifies a set schedule for receiving updates.",
"operationId": "UpdateRuntimeReleaseSchedule",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the container for which you want to set a schedule."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": {
"atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
"scheduleType": "LAST",
"dayOfWeek": "FRIDAY",
"hourOfDay": 0,
"timeZone": "Australia/Queensland"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": "\n\n 407e55c8-b4b8-452a-8163-8e8989e64bc8 \n LAST \n FRIDAY \n 0 \n Australia/Queensland \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": {
"@type": "RuntimeReleaseSchedule",
"atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
"scheduleType": "LAST",
"dayOfWeek": "FRIDAY",
"hourOfDay": 0,
"timeZone": "Australia/Queensland"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeReleaseSchedule"
},
"example": "c2eed3ce-8caf-4c4c-9420-9af3fab0c3ed LAST FRIDAY 0 Australia/Queensland "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"SharedServerInformation"
],
"summary": "Modifies or updates a SharedServerInformation object",
"description": "Updates a Shared Server Information object based on the supplied Runtime ID. \n\n - 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. \n\n You must have the Runtime Management privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update shared server information. \n\n It is not possible to set authToken through this operation. This operation generates a token if it requires authentication, but a token does not currently exist. The new authToken appears in the response. \n - If you specify sslCertificateId, the certificate must be accessible by the account making the request. \n -If you do not configure the Authentication Type and Ports, using the Shared Server Information object to update only the API Type of a Runtime fails. If you are the owner of a Runtime, Runtime cluster, or Runtime cloud, you must update the API Type, Authentication Type, and HTTP Port or HTTPS Port through the Shared Server Information object for the API to succeed. Runtime cloud attachments cannot update the HTTP Port or HTTPS Port. \n - If you configure the Authentication Type and Ports, you can use the Shared Server Information object to update only the API Type of a Runtime. \n - This API does not support the configuration of multiple authentication types on a Runtime.",
"operationId": "UpdateSharedServerInformation",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The ID of the Runtime that is hosting the shared web server."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformation"
},
"example": {
"maxThreads": 100,
"atomId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformation"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformation"
},
"example": {
"@type": "SharedServerInformation",
"maxThreads": 250,
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"apiType": "basic",
"url": "http://system.sub.domain.tld:9090",
"overrideUrl": false,
"authToken": "bcdef012-3456-789a-bcde-f0123456789a",
"httpPort": 9090,
"httpsPort": 9093,
"minAuth": "basic",
"internalHost": "127.0.0.1",
"externalHost": "",
"externalHttpPort": 0,
"externalHttpsPort": 0,
"checkForwardedHeaders": false,
"sslCertificateId": "6789abcd-ef01-2345-6789-abcdef012345",
"auth": "basic"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformation"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedServerInformation/bulk": {
"post": {
"tags": [
"SharedServerInformation"
],
"summary": "Retrieves multiple SharedServerInformation objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkSharedServerInformation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformationBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformationBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformationBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedServerInformationBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedWebServer/{id}": {
"get": {
"tags": [
"SharedWebServer"
],
"summary": "Retrieves an instance of a SharedWebServer object",
"description": "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.",
"operationId": "GetSharedWebServer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedWebServer"
},
"example": {
"@type": "SharedWebServer",
"atomId": "ea19beb4-3f9f-407e-b019-ac508c0aa73b",
"generalSettings": {
"@type": "SharedWebServerGeneral",
"apiType": "ADVANCED",
"authentication": {
"@type": "SharedWebServerAuthentication",
"authType": "CUSTOM",
"loginModuleClassName": "as",
"cacheAuthorizationCredentials": false,
"loginModuleOptions": {
"@type": "SharedWebServerLoginModuleConfiguration"
},
"cacheAuthenticationTimeout": 0
},
"overrideUrl": false,
"baseUrl": "http://dd:9090",
"examineForwardHeaders": false,
"externalHost": "dd",
"internalHost": "",
"listenerPorts": {
"@type": "ListenerPortConfiguration",
"port": [
{
"@type": "SharedWebServerPort",
"enablePort": true,
"port": 9090,
"ssl": false,
"authType": "CUSTOM",
"externalPort": 0,
"externalSSL": false,
"defaultPort": true,
"baseUrlForRequest": "http://dd:9090"
},
{
"@type": "SharedWebServerPort",
"enablePort": true,
"port": 9091,
"ssl": false,
"authType": "BASIC",
"externalPort": 10,
"externalSSL": false,
"defaultPort": false,
"baseUrlForRequest": "http://dd:10"
}
]
},
"maxNumberOfThreads": 250,
"protectedHeaders": {
"@type": "SharedWebServerProtectedHeaders"
},
"sslCertificate": ""
},
"userManagement": {
"@type": "SharedWebServerUserManagement",
"enableAPIMInternalRoles": false,
"users": [
{
"@type": "SharedWebServerUser",
"roleAssociations": [],
"username": "boomi-internal",
"usingIPFilters": false,
"usingComponentFilters": false
}
]
},
"corsConfiguration": {
"@type": "SharedWebServerCors",
"origins": [
{
"@type": "SharedWebServerCORSOrigin",
"allowRequestHeaders": [],
"allowResponseHeaders": [],
"allowMethods": [],
"EnableHTTPRequestHandling": false,
"EnableHTTPSRequestHandling": false,
"allowCredentials": false,
"domain": "domain",
"cacheTimeout": 53
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedWebServer"
},
"example": "\n ea19beb4-3f9f-407e-b019-ac508c0aa73b \n \n ADVANCED \n \n CUSTOM \n as \n false \n 0 \n \n false \n http://dd:9090 \n false \n dd \n \n \n true \n 9090 \n false \n CUSTOM \n 0 \n false \n true \n http://dd:9090 \n \n \n true \n 9091 \n false \n BASIC \n 10 \n false \n false \n http://dd:10 \n \n \n 250 \n \n \n false \n \n boomi-internal \n false \n false \n \n \n \n \n domain \n false \n false \n false \n 53 \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"SharedWebServer"
],
"summary": "Modifies or updates a SharedWebServer object",
"description": "Updates a Shared Web Server object based on the supplied Runtime ID.",
"operationId": "UpdateSharedWebServer",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedWebServer"
},
"example": {
"@type": "SharedWebServer",
"atomId": "8f4c9283-695e-4c9b-963e-b66805832f68",
"generalSettings": {
"@type": "SharedWebServerGeneral",
"apiType": "INTERMEDIATE",
"authentication": {
"@type": "SharedWebServerAuthentication",
"authType": "BASIC",
"cacheAuthorizationCredentials": false
},
"overrideUrl": false,
"baseUrl": "http://cloudAtmSWS:9090",
"examineForwardHeaders": false,
"externalHost": "",
"internalHost": "",
"listenerPorts": {
"@type": "ListenerPortConfiguration",
"port": [
{
"@type": "SharedWebServerPort",
"enablePort": true,
"port": 8080,
"ssl": true,
"authType": "CLIENT_CERT",
"externalPort": 0,
"externalSSL": false,
"defaultPort": false
},
{
"@type": "SharedWebServerPort",
"enablePort": true,
"port": 9090,
"ssl": false,
"authType": "BASIC",
"externalPort": 0,
"externalSSL": false,
"defaultPort": false
}
]
},
"maxNumberOfThreads": 250,
"protectedHeaders": {
"@type": "SharedWebServerProtectedHeaders"
},
"sslCertificate": ""
},
"userManagement": {
"@type": "SharedWebServerUserManagement",
"enableAPIMInternalRoles": false,
"users": [
{
"@type": "SharedWebServerUser",
"roleAssociations": [],
"username": "boomi-internal",
"usingIPFilters": false,
"usingComponentFilters": false
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedWebServer"
},
"example": " \n 8f4c9283-695e-4c9b-963e-b66805832f68 \n \n INTERMEDIATE \n \n BASIC \n false \n \n false \n http://cloudAtmSWS:9090 \n false \n \n \n true \n 8080 \n true \n CLIENT_CERT \n 0 \n false \n false \n \n \n true \n 9090 \n false \n BASIC \n 0 \n false \n false \n \n \n 250 \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedWebServer"
},
"example": {
"@type": "SharedWebServer",
"atomId": "8f4c9283-695e-4c9b-963e-b66805832f68",
"generalSettings": {
"@type": "SharedWebServerGeneral",
"apiType": "INTERMEDIATE",
"authentication": {
"@type": "SharedWebServerAuthentication",
"authType": "BASIC",
"cacheAuthorizationCredentials": false
},
"overrideUrl": false,
"baseUrl": "http://cloudAtmSWS:9090",
"examineForwardHeaders": false,
"externalHost": "",
"internalHost": "",
"listenerPorts": {
"@type": "ListenerPortConfiguration",
"port": [
{
"@type": "SharedWebServerPort",
"enablePort": true,
"port": 8080,
"ssl": true,
"authType": "CLIENT_CERT",
"externalPort": 0,
"externalSSL": false,
"defaultPort": false
},
{
"@type": "SharedWebServerPort",
"enablePort": true,
"port": 9090,
"ssl": false,
"authType": "BASIC",
"externalPort": 0,
"externalSSL": false,
"defaultPort": false
}
]
},
"maxNumberOfThreads": 250,
"protectedHeaders": {
"@type": "SharedWebServerProtectedHeaders"
},
"sslCertificate": ""
},
"userManagement": {
"@type": "SharedWebServerUserManagement",
"enableAPIMInternalRoles": false,
"users": [
{
"@type": "SharedWebServerUser",
"roleAssociations": [],
"username": "boomi-internal",
"usingIPFilters": false,
"usingComponentFilters": false
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedWebServer"
},
"example": "\n 8f4c9283-695e-4c9b-963e-b66805832f68 \n \n INTERMEDIATE \n \n BASIC \n false \n \n false \n http://cloudAtmSWS:9090 \n false \n \n \n true \n 8080 \n true \n CLIENT_CERT \n 0 \n false \n false \n \n \n true \n 9090 \n false \n BASIC \n 0 \n false \n false \n \n \n 250 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedWebServer/bulk": {
"post": {
"tags": [
"SharedWebServer"
],
"summary": "Retrieves multiple SharedWebServer objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkSharedWebServer",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedWebServerBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedWebServerBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedWebServerBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedWebServerBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ThroughputAccount/query": {
"post": {
"tags": [
"ThroughputAccount"
],
"summary": "Queries for a ThroughputAccount object(s)",
"description": "- You can only use the EQUALS operator with the `environmentId` filter parameter.\n - The authenticating user for a QUERY operation must have the Dashboard privilege. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryThroughputAccount",
"requestBody": {
"description": " Possible properties include: environmentId, atomId, processDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property ": "atomId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"3456789a-bcde-f0123-4567-89abcdef012"
],
"operator": "EQUALS",
"property ": "atomId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n 2016-05-01 \n 2016-08-31 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n 3456789a-bcde-f0123-4567-89abcdef012 \n \n \n another-value \n \n \n \n ...\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ThroughputAccount/queryMore": {
"post": {
"tags": [
"ThroughputAccount"
],
"summary": "Retrieves additional results for a ThroughputAccount query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreThroughputAccount",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1ThroughputAccount~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountQueryResponse"
},
"example": {
"$ref": "#/paths/~1ThroughputAccount~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ThroughputAccountGroup/query": {
"post": {
"tags": [
"ThroughputAccountGroup"
],
"summary": "Queries for a ThroughputAccountGroup object(s)",
"description": "- You can only use the EQUALS operator with the `environmentId` filter parameter.\n - The authenticating user for a QUERY operation must have the Dashboard privilege. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryThroughputAccountGroup",
"requestBody": {
"description": " Possible properties include: accountGroupId, processDate",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"fedcba98-7654-3210-fedc-ba9876543210"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"2016-05-01",
"2016-08-31"
],
"operator": "BETWEEN",
"property": "processDate"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountGroupQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n fedcba98-7654-3210-fedc-ba9876543210 \n \n \n 2016-05-01 \n 2016-08-31 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n fedcba98-7654-3210-fedc-ba9876543210 \n \n \n another-value \n \n \n \n ...\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ThroughputAccountGroup/queryMore": {
"post": {
"tags": [
"ThroughputAccountGroup"
],
"summary": "Retrieves additional results for a ThroughputAccountGroup query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreThroughputAccountGroup",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1ThroughputAccountGroup~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ThroughputAccountGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1ThroughputAccountGroup~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradacomsConnectorRecord/query": {
"post": {
"tags": [
"TradacomsConnectorRecord"
],
"summary": "Queries for a TradacomsConnectorRecord object(s)",
"description": "- To filter by a custom field, use the format `customFields`. Use the `fieldName` as the filter property, where `fieldName` is the element name of the custom field in the record structure. To get a list of the available custom fields, refer to the [Custom Tracked Field](/docs/api/platformapi/CustomTrackedField) object. \n\n - The STARTS_WITH operator only accepts values that do not include spaces. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n",
"operationId": "QueryTradacomsConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradacomsConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradacomsConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10 \n \n \n another-value \n \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2019-08-10T06:24:12Z \n connector-abcdef01-2345-6789-abcd-ef0123456789 \n Listen \n Start \n Trading Partner \n Sample Tradacoms Listen Operation \n 0 \n true \n 3138 \n \n 13 \n 2019-08-10T10:53:59-0400 \n sample \n \n Errors \n Loop Error: 3 - VALUE_NOT_FOUND \n XB12 \n ka \n AB12 \n mow \n INVFIL \n 190810 \n 144753 \n STXREF \n rcvref \n CAKHDR \n C \n 1 \n 1 \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2019.08.10 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2019-08-10T06:25:02Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Listen \n Tradacoms \n Start \n Sample Tradacoms Listen Operation \n 49 \n true \n 2781 \n \n 55 \n 2019-08-10T10:57:14-0400 \n sample \n \n Success \n Success \n XB12 \n ka \n AB12 \n mow \n INVFIL \n 190810 \n 144757 \n STXREF \n rcvref \n CAKHDR \n C \n 1 \n 1 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradacomsConnectorRecord/queryMore": {
"post": {
"tags": [
"TradacomsConnectorRecord"
],
"summary": "Retrieves additional results for a TradacomsConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreTradacomsConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradacomsConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1TradacomsConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradacomsConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1TradacomsConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerComponent": {
"post": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Creates a TradingPartnerComponent object",
"description": "- This operation creates a Trading Partner Component object with a specified component name. \n - 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. If you leave off the folderID field when creating a component, it assigns a value. \n - Includes the organizationId field only if the trading partner is to reference an Organization component, in which case the field value is the ID of the Organization component. A request specifying the organizationId field populates the ContactInformation fields with the data from the referenced Organization component.",
"operationId": "CreateTradingPartnerComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": {
"PartnerCommunication": {
"FTPCommunicationOptions": {
"FTPSettings": {
"host": "ftp.wholesaling.com",
"port": [
"BigInteger",
1010
],
"user": "tom.miller",
"FTPSSLOptions": {
"useClientAuthentication": false,
"sslmode": "none"
},
"useDefaultSettings": false,
"connectionMode": "active"
},
"FTPGetOptions": {
"remoteDirectory": "/usr/local/bestwholesaling/outbox",
"fileToMove": "*.xml",
"maxFileCount": [
"BigInteger",
200
],
"useDefaultGetOptions": false,
"ftpAction": "actionget",
"transferType": "ascii"
},
"FTPSendOptions": {
"remoteDirectory": "/home/tommiller/new",
"moveToDirectory": "/home/tommiller/inbox",
"useDefaultSendOptions": false,
"ftpAction": "actionputappend",
"transferType": "ascii"
},
"SharedCommunicationChannel": {},
"CommunicationSetting": "custom"
},
"@type": "PartnerCommunication",
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": false,
"requireSignedMessages": false
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false
}
},
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"CommunicationSetting": "custom"
},
"GenericCommunicationOptions": []
},
"PartnerInfo": {
"X12PartnerInfo": {
"X12Options": {
"elementDelimiter": {
"delimiterValue": "stardelimited"
},
"segmentTerminator": {
"segmentTerminatorValue": "newline"
},
"filteracknowledgements": false,
"acknowledgementoption": "donotackitem",
"envelopeoption": "groupall",
"rejectDuplicateInterchange": false,
"outboundInterchangeValidation": true,
"outboundValidationOption": "filterError"
},
"X12ControlInfo": {
"ISAControlInfo": {
"interchangeIdQualifier": "X12IDQUAL_01",
"securityInformationQualifier": "X12SECQUAL_00",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"ackrequested": false,
"testindicator": "P"
},
"GSControlInfo": {
"respagencycode": "T"
}
}
}
},
"ContactInfo": {
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3579",
"fax": "311 555-9753"
},
"PartnerDocumentTypes": {
"@type": "PartnerDocumentTypes",
"PartnerDocumentType": [
{
"@type": "PartnerDocumentType",
"typeId": "101",
"profileId": "23456789-abcd-ef01-2345-6789abcdef01",
"use999Ack": false,
"useTA1Ack": false,
"expectAckForOutbound": false,
"validateOutboundTransactionSets": false,
"qualifierValidation": true
},
{
"@type": "PartnerDocumentType",
"typeId": "810",
"profileId": "3456789a-bcde-4012-3456-789abcdef012",
"use999Ack": false,
"useTA1Ack": false,
"expectAckForOutbound": false,
"validateOutboundTransactionSets": false,
"qualifierValidation": true
}
]
},
"classification": "tradingpartner",
"standard": "x12",
"componentName": "Best Wholesaling",
"folderName": "Home:TPs",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": "\n \n Tom Miller \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n tom@bestwholesaling.biz \n 311 555-3579 \n 311 555-9753 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n false \n \n \n \n false \n false \n 100000 \n false \n false \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n tom.miller \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/tommiller/new \n /home/tommiller/inbox \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": {
"@type": "TradingPartnerComponent",
"folderName": "Home:TPs",
"componentName": "Best Wholesaling",
"standard": "x12",
"classification": "tradingpartner",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1",
"ContactInfo": {
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": null,
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tombestwholesaling.biz",
"phone": "311 555-3579",
"fax": "311 555-9753"
},
"PartnerInfo": {
"X12PartnerInfo": {
"X12Options": {
"envelopeoption": "groupall",
"acknowledgementoption": "donotackitem",
"filteracknowledgements": "false",
"rejectDuplicateInterchange": "false",
"outboundInterchangeValidation": "true",
"outboundValidationOption": "filterError",
"elementDelimiter": {
"delimiterValue": "stardelimited"
},
"segmentTerminator": {
"segmentTerminatorValue": "newline"
}
},
"X12ControlInfo": {
"ISAControlInfo": {
"testindicator": "P",
"ackrequested": "false",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"securityInformationQualifier": "X12SECQUAL_00",
"interchangeIdQualifier": "X12IDQUAL_01"
},
"GSControlInfo": {
"respagencycode": "T"
}
}
}
},
"PartnerCommunication": {
"FTPCommunicationOptions": {
"CommunicationSetting": "custom",
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"FTPSettings": {
"connectionMode": "active",
"useDefaultSettings": "false",
"host": "ftp.bestwholesaling.com",
"port": "1010",
"user": "tom.miller",
"FTPSSLOptions": {
"sslmode": "none",
"useClientAuthentication": "false"
}
},
"FTPGetOptions": {
"transferType": "ascii",
"ftpAction": "actionget",
"useDefaultGetOptions": "false",
"remoteDirectory": "/usr/local/bestwholesaling/outbox",
"fileToMove": "*.xml",
"maxFileCount": "200"
},
"FTPSendOptions": {
"transferType": "ascii",
"ftpAction": "actionputappend",
"useDefaultSendOptions": "false",
"remoteDirectory": "/home/tommiller/new",
"moveToDirectory": "/home/tommiller/inbox"
},
"@type": "FTPCommunicationOptions"
},
"@type": "PartnerCommunication",
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": false,
"requireSignedMessages": false
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false
}
},
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"CommunicationSetting": "custom"
},
"GenericCommunicationOptions": []
},
"PartnerDocumentTypes": {
"PartnerDocumentType": [
{
"typeId": "101",
"profileId": "23456789-abcd-ef01-2345-6789abcdef01",
"use999Ack": "false",
"useTA1Ack": "false",
"expectAckForOutbound": "false",
"validateOutboundTransactionSets": "false",
"qualifierValidation": "true"
},
{
"typeId": "810",
"profileId": "3456789a-bcde-4012-3456-789abcdef012",
"use999Ack": "false",
"useTA1Ack": "false",
"expectAckForOutbound": "false",
"validateOutboundTransactionSets": "false",
"qualifierValidation": "true"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": "\n \n Tom Miller \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n tom@bestwholesaling.biz \n 311 555-3579 \n 311 555-9753 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n false \n \n \n \n false \n false \n 100000 \n false \n false \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n tom.miller \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/tommiller/new \n /home/tommiller/inbox \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerComponent/{id}": {
"get": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Retrieves an instance of a TradingPartnerComponent object",
"description": "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.",
"operationId": "GetTradingPartnerComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Unique identifier componentId for the Trading Partner component in UUID format. System-generated when created."
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": {
"@type": "TradingPartnerComponent",
"ContactInfo": {
"@type": "ContactInfo",
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3579",
"fax": "311 555-9753"
},
"PartnerInfo": {
"@type": "PartnerInfo",
"X12PartnerInfo": {
"@type": "X12PartnerInfo",
"X12Options": {
"@type": "X12Options",
"elementDelimiter": {
"@type": "EdiDelimiter",
"delimiterValue": "stardelimited"
},
"segmentTerminator": {
"@type": "EdiSegmentTerminator",
"segmentTerminatorValue": "newline"
},
"filteracknowledgements": false,
"acknowledgementoption": "donotackitem",
"envelopeoption": "groupall",
"rejectDuplicateInterchange": false,
"outboundInterchangeValidation": true,
"outboundValidationOption": "filterError",
"X12ControlInfo": {
"@type": "X12ControlInfo",
"ISAControlInfo": {
"@type": "ISAControlInfo",
"interchangeIdQualifier": "X12IDQUAL_01",
"securityInformationQualifier": "X12SECQUAL_00",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"ackrequested": false,
"testindicator": "P"
},
"GSControlInfo": {
"@type": "GSControlInfo",
"respagencycode": "T"
}
}
},
"X12ControlInfo": {
"@type": "X12ControlInfo",
"ISAControlInfo": {
"@type": "ISAControlInfo",
"interchangeIdQualifier": "X12IDQUAL_01",
"securityInformationQualifier": "X12SECQUAL_00",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"ackrequested": false,
"testindicator": "P"
},
"GSControlInfo": {
"@type": "GSControlInfo",
"respagencycode": "T"
}
}
}
},
"PartnerCommunication": {
"@type": "PartnerCommunication",
"FTPCommunicationOptions": {
"@type": "FTPCommunicationOptions",
"FTPSettings": {
"@type": "FTPSettings",
"host": "ftp.bestwholesaling.com",
"port": [
"BigInteger",
1010
],
"user": "tom.miller",
"FTPSSLOptions": {
"@type": "FTPSSLOptions",
"useClientAuthentication": false,
"sslmode": "none"
},
"useDefaultSettings": false,
"connectionMode": "active"
},
"FTPGetOptions": {
"@type": "FTPGetOptions",
"remoteDirectory": "/usr/local/bestwholesaling/outbox",
"fileToMove": "*.xml",
"maxFileCount": [
"BigInteger",
200
],
"useDefaultGetOptions": false,
"ftpAction": "actionget",
"transferType": "ascii"
},
"FTPSendOptions": {
"@type": "FTPSendOptions",
"remoteDirectory": "/home/tommiller/new",
"moveToDirectory": "/home/tommiller/inbox",
"useDefaultSendOptions": false,
"ftpAction": "actionputappend",
"transferType": "ascii"
},
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"CommunicationSetting": "custom"
},
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": false,
"requireSignedMessages": false
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false
}
},
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"CommunicationSetting": "custom"
},
"GenericCommunicationOptions": []
},
"PartnerDocumentTypes": {
"@type": "PartnerDocumentTypes",
"PartnerDocumentType": [
{
"@type": "PartnerDocumentType",
"typeId": "101",
"profileId": "23456789-abcd-ef01-2345-6789abcdef01",
"use999Ack": false,
"useTA1Ack": false,
"expectAckForOutbound": false,
"validateOutboundTransactionSets": false,
"qualifierValidation": true
},
{
"@type": "PartnerDocumentType",
"typeId": "810",
"profileId": "3456789a-bcde-4012-3456-789abcdef012",
"use999Ack": false,
"useTA1Ack": false,
"expectAckForOutbound": false,
"validateOutboundTransactionSets": false,
"qualifierValidation": true
}
]
},
"classification": "tradingpartner",
"standard": "x12",
"componentName": "Best Wholesaling",
"componentId": "12345678-9abc-def0-1234-56789abcdef0",
"folderName": "Home:TPs",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": "\n \n Tom Miller \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n tom@bestwholesaling.biz \n 311 555-3579 \n 311 555-9753 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n false \n \n \n \n false \n false \n 100000 \n false \n false \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n tom.miller \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/tommiller/new \n /home/tommiller/inbox \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Modifies or updates a TradingPartnerComponent object",
"description": "This operation overwrites the Trading Partner Component object with the specified component ID except as described: \n - 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. \n 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.",
"operationId": "UpdateTradingPartnerComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Unique identifier componentId for the Trading Partner component in UUID format. System-generated when created."
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": {
"PartnerCommunication": {
"FTPCommunicationOptions": {
"FTPSettings": {
"host": "ftp.bestwholesaling.com",
"port": [
"BigInteger",
1010
],
"user": "rachel.lewis",
"FTPSSLOptions": {
"useClientAuthentication": false,
"sslmode": "none"
},
"useDefaultSettings": false,
"connectionMode": "active"
},
"FTPGetOptions": {
"remoteDirectory": "/usr/local/bestwholesaling/outbox",
"fileToMove": "*.xml",
"maxFileCount": [
"BigInteger",
200
],
"useDefaultGetOptions": false,
"ftpAction": "actionget",
"transferType": "ascii"
},
"FTPSendOptions": {
"remoteDirectory": "/home/rachellewis/new",
"moveToDirectory": "/home/rachellewis/inbox",
"useDefaultSendOptions": false,
"ftpAction": "actionputappend",
"transferType": "ascii"
},
"SharedCommunicationChannel": {},
"CommunicationSetting": "custom"
},
"@type": "PartnerCommunication",
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": false,
"requireSignedMessages": false
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false
}
},
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"CommunicationSetting": "custom"
},
"GenericCommunicationOptions": []
},
"PartnerInfo": {
"X12PartnerInfo": {
"X12Options": {
"elementDelimiter": {
"delimiterValue": "stardelimited"
},
"segmentTerminator": {
"segmentTerminatorValue": "newline"
},
"filteracknowledgements": false,
"acknowledgementoption": "donotackitem",
"envelopeoption": "groupall",
"rejectDuplicateInterchange": false,
"outboundInterchangeValidation": true,
"outboundValidationOption": "filterError"
},
"X12ControlInfo": {
"ISAControlInfo": {
"interchangeIdQualifier": "X12IDQUAL_01",
"securityInformationQualifier": "X12SECQUAL_00",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"ackrequested": false,
"testindicator": "P"
},
"GSControlInfo": {
"respagencycode": "T"
}
}
}
},
"ContactInfo": {
"contactName": "Rachel Lewis",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "rachel@bestwholesaling.biz",
"phone": "311 555-2468",
"fax": "311 555-8642"
},
"PartnerDocumentTypes": {
"@type": "PartnerDocumentTypes",
"PartnerDocumentType": [
{
"@type": "PartnerDocumentType",
"typeId": "101",
"profileId": "23456789-abcd-ef01-2345-6789abcdef01",
"use999Ack": false,
"useTA1Ack": false,
"expectAckForOutbound": false,
"validateOutboundTransactionSets": false,
"qualifierValidation": true
},
{
"@type": "PartnerDocumentType",
"typeId": "810",
"profileId": "3456789a-bcde-4012-3456-789abcdef012",
"use999Ack": false,
"useTA1Ack": false,
"expectAckForOutbound": false,
"validateOutboundTransactionSets": false,
"qualifierValidation": true
}
]
},
"classification": "tradingpartner",
"standard": "x12",
"componentName": "Best Wholesaling",
"componentId": "12345678-9abc-def0-1234-56789abcdef0",
"folderName": "Home:TPs",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": "\n \n Rachel Lewis \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n rachel@bestwholesaling.biz \n 311 555-2468 \n 311 555-8642 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n false \n \n \n \n false \n false \n 100000 \n false \n false \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n rachel.lewis \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/rachellewis/new \n /home/rachellewis/inbox \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": {
"@type": "TradingPartnerComponent",
"folderId": "11356",
"folderName": "Home:TPs",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1",
"componentId": "12345678-9abc-def0-1234-56789abcdef0",
"componentName": "Best Wholesaling",
"standard": "x12",
"classification": "tradingpartner",
"ContactInfo": {
"contactName": "Rachel Lewis",
"address1": "127 Comstock Ave.",
"address2": null,
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "rachelbestwholesaling.biz",
"phone": "311 555-2468",
"fax": "311 555-8642"
},
"PartnerInfo": {
"X12PartnerInfo": {
"X12Options": {
"envelopeoption": "groupall",
"acknowledgementoption": "donotackitem",
"filteracknowledgements": "false",
"rejectDuplicateInterchange": "false",
"outboundInterchangeValidation": "true",
"outboundValidationOption": "filterError",
"elementDelimiter": {
"delimiterValue": "stardelimited"
},
"segmentTerminator": {
"segmentTerminatorValue": "newline"
}
},
"X12ControlInfo": {
"ISAControlInfo": {
"testindicator": "P",
"ackrequested": "false",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"securityInformationQualifier": "X12SECQUAL_00",
"interchangeIdQualifier": "X12IDQUAL_01"
},
"GSControlInfo": {
"respagencycode": "T"
}
}
}
},
"PartnerCommunication": {
"FTPCommunicationOptions": {
"CommunicationSetting": "custom",
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"FTPSettings": {
"connectionMode": "active",
"useDefaultSettings": "false",
"host": "ftp.bestwholesaling.com",
"port": "1010",
"user": "rachel.lewis",
"FTPSSLOptions": {
"sslmode": "none",
"useClientAuthentication": "false"
}
},
"FTPGetOptions": {
"transferType": "ascii",
"ftpAction": "actionget",
"useDefaultGetOptions": "false",
"remoteDirectory": "/usr/local/bestwholesaling/outbox",
"fileToMove": "*.xml",
"maxFileCount": "200"
},
"FTPSendOptions": {
"transferType": "ascii",
"ftpAction": "actionputappend",
"useDefaultSendOptions": "false",
"remoteDirectory": "/home/rachellewis/new",
"moveToDirectory": "/home/rachellewis/inbox"
}
},
"@type": "PartnerCommunication",
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": false,
"requireSignedMessages": false
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false
}
},
"SharedCommunicationChannel": {
"@type": "SharedCommunicationChannel"
},
"CommunicationSetting": "custom"
},
"GenericCommunicationOptions": []
},
"PartnerDocumentTypes": {
"PartnerDocumentType": [
{
"typeId": "101",
"profileId": "23456789-abcd-ef01-2345-6789abcdef01",
"use999Ack": "false",
"useTA1Ack": "false",
"expectAckForOutbound": "false",
"validateOutboundTransactionSets": "false",
"qualifierValidation": "true"
},
{
"typeId": "810",
"profileId": "3456789a-bcde-4012-3456-789abcdef012",
"use999Ack": "false",
"useTA1Ack": "false",
"expectAckForOutbound": "false",
"validateOutboundTransactionSets": "false",
"qualifierValidation": "true"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponent"
},
"example": "\n \n Rachel Lewis \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n rachel@bestwholesaling.biz \n 311 555-2468 \n 311 555-8642 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n false \n \n \n \n false \n false \n 100000 \n false \n false \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n rachel.lewis \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/rachellewis/new \n /home/rachellewis/inbox \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Deletes a TradingPartnerComponent object",
"description": "The DELETE operation deletes the Trading Partner Component object with a specific component ID. \n A DELETE operation specifying the ID of a deleted Trading Partner component returns a false response.",
"operationId": "DeleteTradingPartnerComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "Unique identifier componentId for the Trading Partner component in UUID format. System-generated when created."
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerComponent/bulk": {
"post": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Retrieves multiple TradingPartnerComponent objects by identifier",
"description": "The bulk GET operation returns multiple Trading Partner Component objects based on the supplied IDs, to a maximum of 100 records.",
"operationId": "BulkTradingPartnerComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerComponent/query": {
"post": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Queries for a TradingPartnerComponent object(s)",
"description": "The QUERY operation returns each Trading Partner component that meets the specified filtering criteria. \n\n - The name field in a QUERY filter represents the object’s componentName field. \n - 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). Filtering on a communication method field requests Trading Partner components by defining the communication method. \n - If the QUERY request includes multiple filters, you can connect the filters with a logical AND operator. The QUERY request does not support the logical OR operator. \n - The QUERY results omit the folderName field. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n **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.",
"operationId": "QueryTradingPartnerComponent",
"requestBody": {
"description": " Possible properties include: name, classification, standard, identifier, as2, disk, ftp, mllp, sftp, http, oftp",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"x12"
],
"operator": "EQUALS",
"property": "standard"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"x12"
],
"operator": "EQUALS",
"property": "standard"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n x12 \n \n \n "
},
"GroupingExpression": {
"value": "\n \n x12 \n \n \n another-value \n \n \n \n ftp \n \n \n ftp \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerComponent/queryMore": {
"post": {
"tags": [
"TradingPartnerComponent"
],
"summary": "Retrieves additional results for a TradingPartnerComponent query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreTradingPartnerComponent",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentQueryResponse"
},
"example": {
"$ref": "#/paths/~1TradingPartnerComponent~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerComponentQueryResponse"
},
"example": {
"$ref": "#/paths/~1TradingPartnerComponent~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerProcessingGroup": {
"post": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Creates a TradingPartnerProcessingGroup object",
"description": "Send an HTTP POST request where `accountId` is the ID of the authenticating account for the request. \n If you omit the folderName field, you must include the folderId field — and vice versa.",
"operationId": "CreateTradingPartnerProcessingGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": {
"TradingPartners": {
"TradingPartner": [
{
"id": "12345678-9abc-def0-1234-56789abcdef0"
},
{
"id": "0fedcba9-8765-4321-0fed-cba987654321"
}
]
},
"DocumentRouting": {
"StandardRoute": [
{
"DocumentTypeRoute": [
{
"PartnerRoute": [],
"documentType": "AUTHOR",
"processId": "56789abc-def0-1234-5678-9abcdef01234"
}
],
"standard": "edifact"
},
{
"DocumentTypeRoute": [
{
"PartnerRoute": [],
"documentType": "107",
"processId": "43210fed-cba9-8765-4321-0fedcba98765"
}
],
"standard": "x12"
}
],
"processId": "543210fe-dcba-9876-5432-10fedcba9876"
},
"componentName": "East Coast partners",
"folderName": "Home:TPs:PGs:Domestic"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": {
"@type": "TradingPartnerComponent",
"folderName": "Home:TPs",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1",
"componentName": "Best Wholesaling",
"standard": "x12",
"classification": "tradingpartner",
"ContactInfo": {
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": null,
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tombestwholesaling.biz",
"phone": "311 555-3579",
"fax": "311 555-9753"
},
"PartnerInfo": {
"X12PartnerInfo": {
"X12Options": {
"envelopeoption": "groupall",
"acknowledgementoption": "donotackitem",
"filteracknowledgements": "false",
"rejectDuplicateInterchange": "false",
"outboundInterchangeValidation": "true",
"outboundValidationOption": "filterError",
"elementDelimiter": {
"delimiterValue": "stardelimited"
},
"segmentTerminator": {
"segmentTerminatorValue": "newline"
}
},
"X12ControlInfo": {
"ISAControlInfo": {
"testindicator": "P",
"ackrequested": "false",
"authorizationInformationQualifier": "X12AUTHQUAL_00",
"securityInformationQualifier": "X12SECQUAL_00",
"interchangeIdQualifier": "X12IDQUAL_01"
},
"GSControlInfo": {
"respagencycode": "T"
}
}
}
},
"PartnerCommunication": {
"FTPCommunicationOptions": {
"CommunicationSetting": "custom",
"SharedCommunicationChannel": null,
"FTPSettings": {
"connectionMode": "active",
"useDefaultSettings": "false",
"host": "ftp.bestwholesaling.com",
"port": "1010",
"user": "tom.miller",
"FTPSSLOptions": {
"sslmode": "none",
"useClientAuthentication": "false"
}
},
"FTPGetOptions": {
"transferType": "ascii",
"ftpAction": "actionget",
"useDefaultGetOptions": "false",
"remoteDirectory": "/usr/local/bestwholesaling/outbox",
"fileToMove": "*.xml",
"maxFileCount": "200"
},
"FTPSendOptions": {
"transferType": "ascii",
"ftpAction": "actionputappend",
"useDefaultSendOptions": "false",
"remoteDirectory": "/home/tommiller/new",
"moveToDirectory": "/home/tommiller/inbox"
}
}
},
"PartnerDocumentTypes": {
"PartnerDocumentType": [
{
"typeId": "101",
"profileId": "23456789-abcd-ef01-2345-6789abcdef01",
"use999Ack": "false",
"useTA1Ack": "false",
"expectAckForOutbound": "false",
"validateOutboundTransactionSets": "false",
"qualifierValidation": "true"
},
{
"typeId": "810",
"profileId": "3456789a-bcde-4012-3456-789abcdef012",
"use999Ack": "false",
"useTA1Ack": "false",
"expectAckForOutbound": "false",
"validateOutboundTransactionSets": "false",
"qualifierValidation": "true"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": "\n \n Tom Miller \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n tom@bestwholesaling.biz \n 311 555-3579 \n 311 555-9753 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n tom.miller \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/tommiller/new \n /home/tommiller/inbox \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerProcessingGroup/{id}": {
"get": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Retrieves an instance of a TradingPartnerProcessingGroup object",
"description": "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. \n 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.",
"operationId": "GetTradingPartnerProcessingGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": {
"TradingPartnerProcessingGroup": {
"componentName": "East Coast partners",
"componentId": "3456789a-bcde-f012-34-56789abcdef012",
"folderName": "Home:TPs:PGs:Domestic",
"folderId": "11669",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1",
"TradingPartners": {
"TradingPartner": [
{
"id": "12345678-9abc-def0-1234-56789abcdef0"
},
{
"id": "0fedcba9-8765-4321-0fed-cba987654321"
}
]
},
"DocumentRouting": {
"processId": "543210fe-dcba-9876-5432-10fedcba9876",
"StandardRoute": [
{
"standard": "edifact",
"processId": "456789ab-cdef-0123-4567-89abcdef0123",
"DocumentTypeRoute": {
"documentType": "AUTHOR",
"processId": "56789abc-def0-1234-5678-9abcdef01234"
}
},
{
"standard": "x12",
"processId": "3210fedc-ba98-7654-3210-fedcba987654",
"DocumentTypeRoute": {
"documentType": "107",
"processId": "43210fed-cba9-8765-4321-0fedcba98765"
}
}
]
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Modifies or updates a TradingPartnerProcessingGroup object",
"description": "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.",
"operationId": "UpdateTradingPartnerProcessingGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": {
"TradingPartners": {
"TradingPartner": [
{
"id": "12345678-9abc-def0-1234-56789abcdef0"
},
{
"id": "0fedcba9-8765-4321-0fed-cba987654321"
}
]
},
"DocumentRouting": {
"StandardRoute": [
{
"DocumentTypeRoute": [
{
"PartnerRoute": [],
"documentType": "AUTHOR",
"processId": "56789abc-def0-1234-5678-9abcdef01234"
}
],
"standard": "edifact"
},
{
"DocumentTypeRoute": [
{
"PartnerRoute": [],
"documentType": "107",
"processId": "43210fed-cba9-8765-4321-0fedcba98765"
}
],
"standard": "x12"
}
],
"processId": "543210fe-dcba-9876-5432-10fedcba9876"
},
"componentName": "Atlantic Seaboard partners",
"componentId": "3456789a-bcde-f012-34-56789abcdef012",
"folderName": "Home:TPs:PGs:Domestic",
"folderId": "11669",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": "\n \n Rachel Lewis \n 127 Comstock Ave. \n Philadelphia \n PA \n 19100 \n US \n rachel@bestwholesaling.biz \n 311 555-2468 \n 311 555-8642 \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n ftp.bestwholesaling.com \n 1010 \n rachel.lewis \n \n \n \n /usr/local/bestwholesaling/outbox \n *.xml \n 200 \n \n \n /home/rachellewis/new \n /home/rachellewis/inbox \n \n \n \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": {
"@type": "TradingPartnerProcessingGroup",
"componentName": "Atlantic Seaboard partners",
"componentId": "3456789a-bcde-f012-34-56789abcdef012",
"folderName": "Home:TPs:PGs:Domestic",
"folderId": "11669",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1",
"TradingPartners": {
"TradingPartner": [
{
"id": "12345678-9abc-def0-1234-56789abcdef0"
},
{
"id": "0fedcba9-8765-4321-0fed-cba987654321"
}
]
},
"DocumentRouting": {
"processId": "543210fe-dcba-9876-5432-10fedcba9876",
"StandardRoute": [
{
"standard": "edifact",
"processId": "456789ab-cdef-0123-4567-89abcdef0123",
"DocumentTypeRoute": {
"documentType": "AUTHOR",
"processId": "56789abc-def0-1234-5678-9abcdef01234"
}
},
{
"standard": "x12",
"processId": "3210fedc-ba98-7654-3210-fedcba987654",
"DocumentTypeRoute": {
"documentType": "107",
"processId": "43210fed-cba9-8765-4321-0fedcba98765"
}
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroup"
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Deletes a TradingPartnerProcessingGroup object",
"description": "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\".",
"operationId": "DeleteTradingPartnerProcessingGroup",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerProcessingGroup/bulk": {
"post": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Retrieves multiple TradingPartnerProcessingGroup objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkTradingPartnerProcessingGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerProcessingGroup/query": {
"post": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Queries for a TradingPartnerProcessingGroup object(s)",
"description": "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. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryTradingPartnerProcessingGroup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupQueryConfig"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupQueryConfig"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "TradingPartnerProcessingGroup",
"componentName": "East Coast partners",
"componentId": "3456789a-bcde-f012-34-56789abcdef012",
"folderId": 11669,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
},
{
"@type": "TradingPartnerProcessingGroup",
"componentName": "European partners",
"componentId": "210fedcb-a987-6543-210f-edcba9876543",
"folderId": 11670,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
],
"numberOfResults": 102
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupQueryResponse"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/TradingPartnerProcessingGroup/queryMore": {
"post": {
"tags": [
"TradingPartnerProcessingGroup"
],
"summary": "Retrieves additional results for a TradingPartnerProcessingGroup query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreTradingPartnerProcessingGroup",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1TradingPartnerProcessingGroup~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/TradingPartnerProcessingGroupQueryResponse"
},
"example": {
"$ref": "#/paths/~1TradingPartnerProcessingGroup~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/X12ConnectorRecord/query": {
"post": {
"tags": [
"X12ConnectorRecord"
],
"summary": "Queries for a X12ConnectorRecord object",
"description": "To filter by a custom field, use the format customFields. Use the 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 [Custom Tracked Field](/docs/api/platformapi/CustomTrackedField) object. \n\n The STARTS_WITH operator only accepts values that do not include spaces. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging). \n\n **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.",
"operationId": "QueryX12ConnectorRecord",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/X12ConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.21"
],
"operator": "EQUALS",
"property": "executionId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.21"
],
"operator": "EQUALS",
"property": "executionId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/X12ConnectorRecordQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.21 \n \n \n "
},
"GroupingExpression": {
"value": "Tom Miller another-value \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.28 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2016-05-28T06:24:12Z \n connector-abcdef01-2345-6789-abcd-ef0123456789 \n Send \n x12 \n Trading Partner \n Xmit Message \n 0 \n true \n 654 \n \n 13 \n ASA \n \n Accepted \n Acknowledgment Report for Interchange Control Number 000000852
Date: 160528
Time: 0624
Acknowledgment Status: Accepted
Note: No Error \n Accepted \n Group Control #: 852
Acknowledgement Status: A \n 000000852 \n 852 \n 0001 \n SM \n 204 \n P \n 02 \n NDTL \n ZZ \n D1T1 \n NDTL \n D1T1 \n U \n U \n 003050 \n X \n 130528 \n 0224 \n Success \n Transaction Set #: 19 Acknowledgement Status: A \n \n \n account-123456 \n execution-01234567-89ab-cdef-0123-456789abcdef-2016.05.28 \n 3456789a-bcde-f012-3456-789abcdef012 \n 2016-05-28T06:25:02Z \n connector-bcdef012-3456-789a-bcde-f0123456789a \n Send \n x12 \n Trading Partner \n Xmit Message \n 49 \n true \n 654 \n \n 55 \n ASA \n \n Accepted \n Acknowledgment Report for Interchange Control Number 000000913
Date: 160528
Time: 0625
Acknowledgment Status: Accepted
Note: No Error \n Accepted \n Group Control #: 913
Acknowledgement Status: A \n 000000913 \n 913 \n 0001 \n SM \n 253 \n P \n 02 \n NDTL \n ZZ \n D1T1 \n NDTL \n D1T1 \n U \n U \n 003050 \n X \n 130528 \n 0225 \n Success \n Transaction Set #: 19 Acknowledgement Status: A \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/X12ConnectorRecord/queryMore": {
"post": {
"tags": [
"X12ConnectorRecord"
],
"summary": "Retrieves additional results for a X12ConnectorRecord query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging). \n\n **Note:** The queryMore response may include a new queryToken if additional results are available beyond the current page.",
"operationId": "QueryMoreX12ConnectorRecord",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/X12ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1X12ConnectorRecord~1query/post/responses/200/content/application~1json/example"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/X12ConnectorRecordQueryResponse"
},
"example": {
"$ref": "#/paths/~1X12ConnectorRecord~1query/post/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AccountCloudAttachmentProperties/{id}": {
"get": {
"tags": [
"AccountCloudAttachmentProperties"
],
"summary": "Retrieves an AccountCloudAttachmentProperties object by identifier",
"description": "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](https://help.boomi.com/docs/Atomsphere/Integration/Integration%20management/r-atm-Attachment_Quotas_tab_4fbc3fff-7aaf-4bbd-a2dc-25d0edb5189c) tab (Manage > Cloud Management) in the user interface. \n >**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.",
"operationId": "AsyncGetAccountCloudAttachmentProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the Runtime cloud. \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AccountCloudAttachmentProperties/response/{token}": {
"get": {
"tags": [
"AccountCloudAttachmentProperties"
],
"summary": "Retrieves an AccountCloudAttachmentProperties object by token",
"description": "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. \n >**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.",
"operationId": "AsyncTokenAccountCloudAttachmentProperties",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "AccountCloudAttachmentProperties",
"statusCode": 200,
"sessionId": "AccountCloudAttachmentProperties-1f23456f-a78f-91cc-012e-3e4dec5b67d8",
"accountDiskUsage": 4294,
"numberofAtomWorkers": 4,
"atomInputSize": 4131,
"atomOutputOverflowSize": 4213,
"atomWorkingOverflowSize": 413,
"httpRequestRate": 43,
"workerMaxExecutionTime": 322,
"workerMaxGeneralExecutionTime": 322,
"workerMaxRunningExecutions": 40,
"workerMaxQueuedExecutions": 40,
"workerQueuedExecutionTimeout": 401,
"maxConnectorTrackDocs": 40,
"httpWorkload": "LOW_LATENCY_DEBUG",
"as2Workload": "GENERAL",
"cloudAccountExecutionLimit": 415,
"cloudAccountExecutionWarningOffset": 413,
"enableAtomWorkerWarmup": true,
"minNumberofAtomWorkers": 4,
"testModeMaxDocs": 400,
"testModeMaxDocBytes": 304,
"enableAccountDataArchiving": true,
"listenerMaxConcurrentExecutions": 5,
"downloadRunnerlogs": true,
"flowControlParallelProcessTypeOverride": "NONE",
"queueIncomingMessageRateLimit": "1",
"workerElasticScalingThreshold": "1"
}
],
"numberOfResults": "1",
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesAsyncResponse"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AtomCounters/response/{token}": {
"get": {
"tags": [
"AtomCounters"
],
"summary": "Retrieves an AtomCounters object by identifier",
"description": "For a response, use the token from the initial GET response in a new request.",
"operationId": "AsyncTokenAtomCounters",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomCountersAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "AtomCounters",
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"Counters": [
{
"Counter": [
{
"@type": "Counter",
"name": "counter1",
"value": "2"
},
{
"@type": "Counter",
"name": "counter2",
"value": "1"
}
]
}
]
}
],
"responseStatusCode": "200",
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomCountersAsyncResponse"
},
"example": {
"$ref": "#/paths/~1async~1AtomCounters~1%7Bid%7D/get/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AtomCounters/{id}": {
"get": {
"tags": [
"AtomCounters"
],
"summary": "Retrieves an AtomCounters object by identifier",
"description": "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. \n `accountId` is the Platform account that you are authenticating with and `id` is the Runtime ID for the counters you are attempting to GET.",
"operationId": "AsyncGetAtomCounters",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"@type": "AsyncOperationResult",
"responseStatusCode": 202,
"asyncToken": {
"@type": "AsyncToken",
"token": "AtomCounters-abc123c4-a888-6789-8449-615e3cb58e5e"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AtomDiskSpace/{id}": {
"get": {
"tags": [
"AtomDiskSpace"
],
"summary": "Retrieves an AtomDiskSpace object by identifier",
"description": "The GET operation returns the current disk usage state of the given Runtime cloud attachment. \n 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. \n This first request is required to retrieve the authenticating token, which is used in a subsequent GET request. \n >**Note:** `accountId` must always refer to the account ID of the parent Runtime cloud and not that of the attachment.",
"operationId": "AsyncGetAtomDiskSpace",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the Runtime cloud attachment."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"@type": "AsyncOperationTokenResult",
"asyncToken": {
"@type": "AsyncToken",
"token": "AtomDiskSpace-12b08345-ab6a-7b0f-8a91-2e34dec567a8"
},
"responseStatusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AtomDiskSpace/response/{token}": {
"get": {
"tags": [
"AtomDiskSpace"
],
"summary": "Retrieves an AtomDiskSpace object by token",
"description": "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. \n >**Note:** `accountId` must always refer to the account ID of the parent Runtime cloud and not that of the attachment.",
"operationId": "AsyncTokenAtomDiskSpace",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomDiskSpaceAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "AtomDiskSpaceDirectory",
"file": "/var/boomi/Cloud_DockerCloud/accounts/parent-cloud-account-123/doccache",
"rawSize": 21931,
"size": "21 KB"
},
{
"@type": "AtomDiskSpaceDirectory",
"file": "/var/boomi/Cloud_DockerCloud/accounts/parent-cloud-account-123/tmpdata",
"rawSize": 0,
"size": "0"
}
],
"responseStatusCode": 200,
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomDiskSpaceAsyncResponse"
},
"example": {
"$ref": "#/paths/~1async~1AtomDiskSpace~1%7Bid%7D/get/responses/200/content/application~1xml/example"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AtomSecurityPolicies/{id}": {
"get": {
"tags": [
"AtomSecurityPolicies"
],
"summary": "Retrieves an AtomSecurityPolicies object by identifier",
"description": "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. \n\n 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.",
"operationId": "AsyncGetAtomSecurityPolicies",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "The runtime (container) id for the applicable runtime (accepts only Runtime cloud cluster and regular runtime cluster types, no basic runtimes or cloud attachments)."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"AsyncOperationTokenResult": {
"responseStatusCode": "202",
"asyncToken": {
"token": "AtomSecurityPolicies-6896e107-b210-454e-8fcf-73684d1e4903"
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AtomSecurityPolicies/response/{token}": {
"get": {
"tags": [
"AtomSecurityPolicies"
],
"summary": "Retrieves AtomSecurityPolicies objects by token",
"description": "Using the token from the initial GET response, send an HTTP GET where accountId is the account with which you are authenticating. \n\n 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.",
"operationId": "AsyncTokenAtomSecurityPolicies",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AtomSecurityPoliciesAsyncResponse"
},
"example": {
"AtomSecurityPolicies": {
"atomId": "4ce4a1c2-5bd9-4bd9-9201-46198e2d88db",
"common": {
"policies": {
"privilegeType": "RuntimePermission",
"arguments": [
{
"value": "arg1"
},
{
"value": "arg2"
}
]
}
},
"runner": null,
"worker": null,
"browser": {
"policies": {
"privilegeType": "Test",
"arguments": [
{
"value": "arg1"
},
{
"value": "arg2"
}
]
}
},
"numberOfResults": "1",
"responseStatusCode": "202",
"result": [
{
"atomId": "4ce4a1c2-5bd9-4bd9-9201-46198e2d88db",
"common": {
"policies": {
"privilegeType": "RuntimePermission",
"arguments": [
{
"value": "arg1"
},
{
"value": "arg2"
}
]
}
},
"runner": null,
"worker": null,
"browser": {
"policies": {
"privilegeType": "Test",
"arguments": [
{
"value": "arg1"
},
{
"value": "arg2"
}
]
}
}
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AtomSecurityPoliciesAsyncResponse"
},
"example": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/ListQueues/response/{token}": {
"get": {
"tags": [
"ListQueues"
],
"summary": "Retrieves a ListQueues object by identifier",
"description": "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.",
"operationId": "AsyncTokenListQueues",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListQueuesAsyncResponse"
},
"example": {
"AsyncOperationResult": {
"numberOfResults": "3",
"responseStatusCode": "200",
"result": [
{
"xsi_type": "QueueRecord",
"queueName": "Queue1",
"queueType": "Point-to-Point",
"messagesCount": "150",
"deadLettersCount": "0"
},
{
"xsi_type": "QueueRecord",
"queueName": "Queue2",
"queueType": "Publish/Subscribe",
"messagesCount": "18",
"deadLettersCount": "2",
"topicSubscribers": [
{
"SubscriberName": "123fb43d-a5c6-7890-123d-a4c56789ece0",
"messageCount": "9",
"deadLettersCount": "1"
},
{
"SubscriberName": "e4d567d3-cd89-0aae-b123-6848dcf975f0",
"messageCount": "9",
"deadLettersCount": "1"
}
]
},
{
"xsi_type": "QueueRecord",
"queueName": "Queue3",
"queueType": "Point-to-Point",
"messagesCount": "150",
"deadLettersCount": "0"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ListQueuesAsyncResponse"
},
"example": "\n\n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/ListQueues/{id}": {
"get": {
"tags": [
"ListQueues"
],
"summary": "Retrieves a ListQueues object by identifier",
"description": "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. \n >**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.",
"operationId": "AsyncGetListQueues",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"QueueMessageResponse": {
"sessionId": "QueueList-5678f901-23e4-567d-8b9e-01b234cc5678",
"message": "Request submitted to query queue messages"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n\n \n \n \n ea56da44-ea7d-4c80-9866-30556474938e \n \n \n 1045759d-7f6c-4108-bd0e-7b71541d6a2d \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n ea56da44-ea7d-4c80-9866-30556474938e \n \n \n another-value \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/ListenerStatus/response/{token}": {
"get": {
"tags": [
"ListenerStatus"
],
"summary": "Retrieves a ListenerStatus object by token",
"description": "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. \n >**Note:** For backward compatibility, Boomi continues to support the legacy URL: https://api.boomi.com/api/rest/v1/accountId/ListenerStatus/query/async.",
"operationId": "AsyncTokenListenerStatus",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListenerStatusAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "ListenerStatus",
"listenerId": "ea56da44-ea7d-4c80-9866-30556474938e",
"status": "listening",
"connectorType": "wss"
}
],
"numberOfResults": 1,
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ListenerStatusAsyncResponse"
},
"example": "\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/PersistedProcessProperties/response/{token}": {
"get": {
"tags": [
"PersistedProcessProperties"
],
"summary": "Retrieves a PersistedProcessProperties object by identifier",
"description": "For a response, use the token from the response in a new request.",
"operationId": "AsyncTokenPersistedProcessProperties",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedProcessPropertiesAsyncResponse"
},
"example": {
"AsyncOperationResult": {
"responseStatusCode": "200",
"result": {
"type": "PersistedProcessProperties",
"PersistedProcessProperties": {
"atomId": "3456789a-bcde-f012-3456-789abcdef012",
"processes": {
"processId": "83b8771e-9bab-4395-86aa-7c8149678900",
"PersistedProcessProperties": {
"ProcessProperty": [
{
"name": "processname1",
"value": "value1"
},
{
"name": "processname2",
"value": "value2"
}
]
}
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PersistedProcessPropertiesAsyncResponse"
},
"example": "\n\n \n \n 3456789a-bcde-f012-3456-789abcdef012 \n \n 83b8771e-9bab-4395-86aa-7c8149678900 \n \n \n processname1 \n value1 \n \n \n processname2 \n value2 \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/PersistedProcessProperties/{id}": {
"get": {
"tags": [
"PersistedProcessProperties"
],
"summary": "Retrieves a PersistedProcessProperties object by identifier",
"description": "The GET operation returns the current state of the Persisted Process properties names and values for the specified Runtime. \n The initial GET operation returns a token for the specified Runtime.",
"operationId": "AsyncGetPersistedProcessProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"AsyncOperationTokenResult": {
"responseStatusCode": "202",
"token": "PersistedProcessProperties-0c34dccd-01da-4078-ace2-69897e421583"
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OrganizationComponent": {
"post": {
"tags": [
"OrganizationComponent"
],
"summary": "Creates an OrganizationComponent object",
"description": "The CREATE operation creates an Organization Component object with the specified component name. \n\n 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. If you omit the `folderID` field, it assigns the value when you create the component. ",
"operationId": "CreateOrganizationComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": {
"@type": "OrganizationComponent",
"OrganizationContactInfo": {
"@type": "OrganizationContactInfo",
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3579",
"contactUrl": "https://www.bestwholesaling.biz",
"fax": "311 555-9753"
},
"componentName": "Best Wholesaling",
"folderName": "Commercial",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": "\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3579 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": {
"@type": "OrganizationComponent",
"OrganizationContactInfo": {
"@type": "OrganizationContactInfo",
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3579",
"contactUrl": "https://www.bestwholesaling.biz",
"fax": "311 555-9753"
},
"componentName": "Best Wholesaling",
"componentId": "89abcdef-0123-4567-89ab-cdef01234567",
"folderName": "Commercial",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": "\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3579 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OrganizationComponent/{id}": {
"get": {
"tags": [
"OrganizationComponent"
],
"summary": "Retrieves an instance of an OrganizationComponent object.",
"description": "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*.",
"operationId": "GetOrganizationComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Organization component ID"
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": {
"@type": "OrganizationComponent",
"OrganizationContactInfo": {
"@type": "OrganizationContactInfo",
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3579",
"contactUrl": "https://www.bestwholesaling.biz",
"fax": "311 555-9753"
},
"componentName": "Best Wholesaling",
"componentId": "89abcdef-0123-4567-89ab-cdef01234567",
"folderName": "Commercial",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": "\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3579 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"OrganizationComponent"
],
"summary": "Modifies or updates an OrganizationComponent object",
"description": "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.",
"operationId": "UpdateOrganizationComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": {
"@type": "OrganizationComponent",
"OrganizationContactInfo": {
"@type": "OrganizationContactInfo",
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3597",
"contactUrl": "https://www.bestwholesaling.biz",
"fax": "311 555-9753"
},
"componentName": "Best Wholesaling",
"componentId": "89abcdef-0123-4567-89ab-cdef01234567",
"folderName": "Commercial",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": "\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3597 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": {
"@type": "OrganizationComponent",
"OrganizationContactInfo": {
"@type": "OrganizationContactInfo",
"contactName": "Tom Miller",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3597",
"contactUrl": "https://www.bestwholesaling.biz",
"fax": "311 555-9753"
},
"componentName": "Best Wholesaling",
"componentId": "89abcdef-0123-4567-89ab-cdef01234567",
"folderName": "Commercial",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponent"
},
"example": "\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3597 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Organization component ID"
}
]
},
"delete": {
"tags": [
"OrganizationComponent"
],
"summary": "Deletes an OrganizationComponent object",
"description": "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`.",
"operationId": "DeleteOrganizationComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the Organization component you are attempting to delete."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OrganizationComponent/bulk": {
"post": {
"tags": [
"OrganizationComponent"
],
"summary": "Retrieves multiple OrganizationComponent objects by identifier",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkOrganizationComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentBulkResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OrganizationComponent/query": {
"post": {
"tags": [
"OrganizationComponent"
],
"summary": "Queries for an OrganizationComponent object",
"description": "- Only the LIKE operator is allowed with a name filter. Likewise, only the EQUALS operator is permitted with a contactName, email, or phone filter.\n\n - 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 .\n\n - The QUERY results omit the folderName field. \n\n For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryOrganizationComponent",
"requestBody": {
"description": " Possible properties include: name, contactName, email, phone",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"Tom Miller"
],
"operator": "EQUALS",
"property": "contactName"
},
{
"argument": [
"311 555-3579"
],
"operator": "EQUALS",
"property": "phone"
}
]
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"operator": "and",
"nestedExpression": [
{
"argument": [
"Tom Miller"
],
"operator": "EQUALS",
"property": "contactName"
},
{
"argument": [
"311 555-3579"
],
"operator": "EQUALS",
"property": "phone"
}
]
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n \n Tom Miller \n \n \n 311 555-3579 \n \n \n \n "
},
"GroupingExpression": {
"value": "\n \n Tom Miller \n \n \n another-value \n \n \n\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3579 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/OrganizationComponent/queryMore": {
"post": {
"tags": [
"OrganizationComponent"
],
"summary": "Retrieves additional results for an OrganizationComponent query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreOrganizationComponent",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "OrganizationComponent",
"OrganizationContactInfo": {
"@type": "OrganizationContactInfo",
"contactName": "Tom Miller",
"description": "Shared Organization component for Best Wholesaling",
"address1": "127 Comstock Ave.",
"address2": "",
"city": "Philadelphia",
"state": "PA",
"postalcode": "19100",
"country": "US",
"email": "tom@bestwholesaling.biz",
"phone": "311 555-3579",
"contactUrl": "https://www.bestwholesaling.biz",
"fax": "311 555-9753"
},
"componentName": "Best Wholesaling",
"componentId": "89abcdef-0123-4567-89ab-cdef01234567",
"folderId": 11356,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
],
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/OrganizationComponentQueryResponse"
},
"example": "\n\n\nTom Miller \n127 Comstock Ave. \nPhiladelphia \nPA \n19100 \nUS \ntom@bestwholesaling.biz \n311 555-3579 \nhttps://www.bestwholesaling.biz \n311 555-9753 \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedCommunicationChannelComponent": {
"post": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Creates a SharedCommunicationChannelComponent object",
"description": "The sample request creates a Shared Communication Component named `Disk Comms Channel`.",
"operationId": "CreateSharedCommunicationChannelComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": {
"@type": "SharedCommunicationChannelComponent",
"PartnerCommunication": {
"@type": "PartnerCommunication",
"DiskCommunicationOptions": {
"@type": "DiskCommunicationOptions",
"DiskGetOptions": {
"@type": "DiskGetOptions",
"fileFilter": "*",
"getDirectory": "GetDirectory",
"useDefaultGetOptions": false,
"deleteAfterRead": true,
"maxFileCount": [
"BigInteger",
0
],
"filterMatchType": "wildcard"
},
"DiskSendOptions": {
"@type": "DiskSendOptions",
"sendDirectory": "SendDirectory",
"useDefaultSendOptions": false,
"createDirectory": true,
"writeOption": "unique"
}
},
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": true,
"requireSignedMessages": true
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false,
"enabledFoldedHeaders": false
}
}
}
},
"PartnerArchiving": {
"@type": "PartnerArchiving",
"enableArchiving": false
},
"componentName": "DISK Communication object",
"folderName": "Boomi/SampleFolder",
"folderId": 922,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": "\n\n\n\n\nfalse \n \n\n\nfalse \nfalse \n100000 \ntrue \ntrue \n \n\n\n \n \n\n\n* \nExampleGetDirectory \n \n\nExampleSendDirectory \n \n \n \n\nfalse \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": "\n\n\n\n\nfalse \n \n\n\nfalse \nfalse \n100000 \ntrue \ntrue \n \n\n\n \n \n\n\n* \nExampleGetDirectory \n \n\nExampleSendDirectory \n \n \n \n\nfalse \n \n "
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedCommunicationChannelComponent/{id}": {
"get": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Retrieves an instance of a SharedCommunicationChannelComponent object",
"description": "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.",
"operationId": "GetSharedCommunicationChannelComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Unique identifier componentId for the Shared Communication Channel Component in UUID format. System-generated when created."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": {
"SharedCommunicationChannelComponent": {
"PartnerCommunication": {
"DiskCommunicationOptions": {
"DiskGetOptions": {
"fileFilter": "*",
"getDirectory": "ExampleGetDirectory"
},
"DiskSendOptions": {
"sendDirectory": "ExampleSendDirectory"
}
},
"@type": "PartnerCommunication",
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": true,
"requireSignedMessages": true
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false,
"enabledFoldedHeaders": false
}
}
}
},
"PartnerArchiving": {
"enableArchiving": false
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": "\n\n\n\n\nfalse \n \n\n\nfalse \nfalse \n100000 \ntrue \ntrue \n \n\n\n \n \n\n\n* \nExampleGetDirectory \n \n\nExampleSendDirectory \n \n \n \n\nfalse \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Modifies or updates a SharedCommunicationChannelComponent object",
"description": "The sample request updates the component named `Disk Comms Channel`.",
"operationId": "UpdateSharedCommunicationChannelComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Unique identifier componentId for the Shared Communication Channel Component in UUID format. System-generated when created."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": {
"@type": "SharedCommunicationChannelComponent",
"PartnerCommunication": {
"@type": "PartnerCommunication",
"DiskCommunicationOptions": {
"@type": "DiskCommunicationOptions",
"DiskGetOptions": {
"@type": "DiskGetOptions",
"fileFilter": "*",
"getDirectory": "GetDirectory",
"useDefaultGetOptions": false,
"deleteAfterRead": true,
"maxFileCount": [
"BigInteger",
0
],
"filterMatchType": "wildcard"
},
"DiskSendOptions": {
"@type": "DiskSendOptions",
"sendDirectory": "SendDirectory",
"useDefaultSendOptions": false,
"createDirectory": true,
"writeOption": "unique"
}
},
"AS2CommunicationOptions": {
"@type": "AS2CommunicationOptions",
"AS2SendSettings": {
"@type": "AS2SendSettings",
"AuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"verifyHostname": false,
"useDefaultSettings": false,
"authenticationType": "NONE"
},
"AS2SendOptions": {
"@type": "AS2SendOptions",
"AS2PartnerInfo": {
"@type": "AS2PartnerInfo",
"basicAuthEnabled": false,
"rejectDuplicateMessages": false,
"messagesToCheckForDuplicates": 100000,
"ListenAuthSettings": {
"@type": "AS2BasicAuthInfo"
},
"ListenAttachmentSettings": {
"@type": "AttachmentInfo"
},
"requireEncryptedMessages": true,
"requireSignedMessages": true
},
"AS2MessageOptions": {
"@type": "AS2MessageOptions",
"encryptionAlgorithm": "tripledes",
"dataContentType": "textplain",
"signingDigestAlg": "SHA1",
"signed": false,
"encrypted": false,
"compressed": false,
"multipleAttachments": false,
"enabledFoldedHeaders": false
},
"AS2MDNOptions": {
"@type": "AS2MDNOptions",
"requestMDN": false,
"synchronous": "sync",
"signed": false,
"useSSL": false,
"mdnDigestAlg": "SHA1",
"useExternalURL": false,
"enabledFoldedHeaders": false
}
}
}
},
"PartnerArchiving": {
"@type": "PartnerArchiving",
"enableArchiving": false
},
"componentName": "DISK Communication object",
"componentId": "6e9255ee-1899-49fa-891c-f7111d7e4e07",
"folderName": "Boomi/SampleFolder",
"folderId": 922,
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": "\n\n\n\n\nfalse \n \n\n\nfalse \nfalse \n100000 \ntrue \ntrue \n \n\n\n \n \n\n\n* \nExampleGetDirectory \n \n\nExampleSendDirectory \n \n \n \n\nfalse \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponent"
},
"example": "\n\n\n\n\nfalse \n \n\n\nfalse \nfalse \n100000 \ntrue \ntrue \n \n\n\n \n \n\n\n* \nExampleGetDirectory \n \n\nExampleSendDirectory \n \n \n \n\nfalse \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Deletes a SharedCommunicationChannelComponent object",
"description": "If the Shared Communication Channel component is deleted successfully, the response is `true`.",
"operationId": "DeleteSharedCommunicationChannelComponent",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "Unique identifier componentId for the Shared Communication Channel Component in UUID format. System-generated when created."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedCommunicationChannelComponent/bulk": {
"post": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Retrieves multiple SharedCommunicationChannelComponent objects by identifier",
"description": "To learn more about `bulk`, refer to the topic [Bulk GET operations](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkSharedCommunicationChannelComponent",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedCommunicationChannelComponent/query": {
"post": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Queries for a SharedCommunicationChannelComponent object(s).",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).\n\n The sample request query returns the Shared Communication Channel components using the AS2 standard for the authenticating account. \n\n **Note:** \n - The name field in a QUERY filter represents the object's `componentName` field. \n - The response includes a queryToken only when more than 100 results are available. Use the queryToken with the queryMore endpoint to retrieve additional results.",
"operationId": "QuerySharedCommunicationChannelComponent",
"requestBody": {
"description": " Possible properties include: name, communicationType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"as2"
],
"operator": "EQUALS",
"property": "communicationType"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"as2"
],
"operator": "EQUALS",
"property": "communicationType"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n\n\nas2 \n \n \n "
},
"GroupingExpression": {
"value": "\n\n \n \n \n as2 \n \n \n another-value \n \n \n \n "
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentQueryResponse"
},
"example": {
"numberOfResults": 3,
"@type": "QueryResult",
"result": [
{
"@type": "SharedCommunicationChannelComponent",
"componentName": "New Communication Channel",
"communicationType": "as2",
"componentId": "0cfe0d5a-0d33-48f8-825a-1d67667e0cd5",
"folderId": "894",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
},
{
"@type": "SharedCommunicationChannelComponent",
"componentName": "TestOfficeapi",
"communicationType": "as2",
"componentId": "1cbd3256-308c-4a9d-a70b-dd8b911bc72b",
"folderId": "894",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
},
{
"@type": "SharedCommunicationChannelComponent",
"componentName": "Shared AS2 API",
"communicationType": "as2",
"componentId": "24bdabb3-bf20-4138-9324-6270972b8472",
"folderId": "921",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentQueryResponse"
},
"example": "\n\n\n\n\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SharedCommunicationChannelComponent/queryMore": {
"post": {
"tags": [
"SharedCommunicationChannelComponent"
],
"summary": "Retrieves additional results for a SharedCommunicationChannelComponent query.",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreSharedCommunicationChannelComponent",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string",
"description": "Query token from the previous query response used to retrieve the next page of results."
},
"example": "/nd0PlROcmuUK8MV8KPzCVXwA/pgZZ0NfsYjhqLNyothPzrFIh0OQLP6Hq3ERMSAl38Dz3NV5otJ/0+a...."
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentQueryResponse"
},
"example": {
"numberOfResults": 3,
"@type": "QueryResult",
"result": [
{
"@type": "SharedCommunicationChannelComponent",
"componentName": "New Communication Channel",
"communicationType": "as2",
"componentId": "0cfe0d5a-0d33-48f8-825a-1d67667e0cd5",
"folderId": "894",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
},
{
"@type": "SharedCommunicationChannelComponent",
"componentName": "TestOfficeapi",
"communicationType": "as2",
"componentId": "1cbd3256-308c-4a9d-a70b-dd8b911bc72b",
"folderId": "894",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
},
{
"@type": "SharedCommunicationChannelComponent",
"componentName": "Shared AS2 API",
"communicationType": "as2",
"componentId": "24bdabb3-bf20-4138-9324-6270972b8472",
"folderId": "921",
"branchId": "QjoxNDMxNg",
"branchName": "branch-1"
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SharedCommunicationChannelComponentQueryResponse"
},
"example": "\n\n\n\n\n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupIntegrationPack": {
"post": {
"tags": [
"AccountGroupIntegrationPack"
],
"summary": "Creates an AccountGroupIntegrationPack object",
"description": "Adds an integration pack to the requesting account group.",
"operationId": "CreateAccountGroupIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPack"
},
"example": {
"integrationPackId": "fc32f440-9a53-45ce-bd6b-014755dadb64",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPack"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPack"
},
"example": {
"@type": "AccountGroupIntegrationPack",
"id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE",
"integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
"integrationPackName": "test integration pack",
"installationType": "SINGLE",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPack"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupIntegrationPack/{id}": {
"get": {
"tags": [
"AccountGroupIntegrationPack"
],
"summary": "Retrieves an instance of an AccountGroupIntegrationPack object",
"description": "The ordinary GET operation retrieves the properties of the AccountGroupIntegrationPack with the specified ID. \nThe bulk GET operation retrieves the properties of the AccountGroupIntegrationPack with the specified IDs to a maximum of 100. \nYou can obtain AccountGroupIntegrationPack IDs from the QUERY operation.",
"operationId": "GetAccountGroupIntegrationPack",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the integration pack."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPack"
},
"example": {
"@type": "AccountGroupIntegrationPack",
"id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE",
"integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
"integrationPackName": "test integration pack",
"installationType": "SINGLE",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPack"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"AccountGroupIntegrationPack"
],
"summary": "Deletes an AccountGroupIntegrationPack object",
"description": "Removes the integration pack with a specified ID from the requesting account group. \nYou can obtain this ID from a QUERY operation.",
"operationId": "DeleteAccountGroupIntegrationPack",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the integration pack."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupIntegrationPack/bulk": {
"post": {
"tags": [
"AccountGroupIntegrationPack"
],
"summary": "Retrieves multiple AccountGroupIntegrationPack objects by identifier",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAccountGroupIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupIntegrationPack/query": {
"post": {
"tags": [
"AccountGroupIntegrationPack"
],
"summary": "Queries for an AccountGroupIntegrationPack object(s)",
"description": "Retrieves all integration packs available to the requesting account group ID. \n\n For general information about the structure of QUERY filters and how to handle paged results, refer to the Query filters and Query paging topics.",
"operationId": "QueryAccountGroupIntegrationPack",
"requestBody": {
"description": " Possible properties include: accountGroupId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"
],
"operator": "EQUALS",
"property": "accountGroupId"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"cd17f866-c247-4c54-a1a1-ea8f8f86a1d1"
],
"operator": "EQUALS",
"property": "accountGroupId"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n cd17f866-c247-4c54-a1a1-ea8f8f86a1d1 \n \n \n "
},
"GroupingExpression": {
"value": "\n\n \n \n \n cd17f866-c247-4c54-a1a1-ea8f8f86a1d1 \n \n \n another-value \n \n \n \n \n"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "AccountGroupIntegrationPack",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
"integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
"integrationPackName": "test integration pack",
"installationType": "SINGLE",
"id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE"
},
{
"@type": "AccountGroupIntegrationPack",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
"integrationPackId": "fc32f440-9a53-45ce-bd6b-014755dadb64",
"integrationPackName": "New update Ipac",
"installationType": "MULTI",
"id": "MTJ8Y2QxN2Y4NjYtYzI0Ny00YzU0LWExYTEtZWE4ZjhmODZhMWQx"
}
],
"numberOfResults": 2
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackQueryResponse"
},
"example": "\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountGroupIntegrationPack/queryMore": {
"post": {
"tags": [
"AccountGroupIntegrationPack"
],
"summary": "Retrieves additional results for an AccountGroupIntegrationPack query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountGroupIntegrationPack",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "AccountGroupIntegrationPack",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
"integrationPackId": "cd17f866-c247-4c54-a1a1-ea8f8f863456",
"integrationPackName": "test integration pack",
"installationType": "SINGLE",
"id": "MXxjZDE3Zjg2Ni1jMjQ3LTRjNTQtYTFhMS1lYThmOGY4NmExZDE"
},
{
"@type": "AccountGroupIntegrationPack",
"accountGroupId": "cd17f866-c247-4c54-a1a1-ea8f8f86a1d1",
"integrationPackId": "fc32f440-9a53-45ce-bd6b-014755dadb64",
"integrationPackName": "New update Ipac",
"installationType": "MULTI",
"id": "MTJ8Y2QxN2Y4NjYtYzI0Ny00YzU0LWExYTEtZWE4ZjhmODZhMWQx"
}
],
"numberOfResults": 2
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountGroupIntegrationPackQueryResponse"
},
"example": "\n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PublisherIntegrationPack": {
"post": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Creates a PublisherIntegrationPack object",
"description": "Creates a single attachment or multiple attachment integration pack.",
"operationId": "CreatePublisherIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": {
"installationType": "SINGLE",
"name": "IPACK-JSON",
"Description": "Single Ipack"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": "\n first ipack \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": {
"@type": "PublisherIntegrationPack",
"Description": "Single Ipack",
"id": "2e8e7a47-eb93-4292-82f9-1b95dc8daa53",
"name": "IPACK-JSON",
"installationType": "SINGLE",
"operationType": "ADD",
"PublisherPackagedComponents": {
"@type": "PublisherPackagedComponents",
"PublisherPackagedComponent": [
{
"@type": "PublisherPackagedComponent",
"componentId": "76742659-845c-45e4-bb9f-d63ff998f658",
"componentName": "New Process 4",
"componentType": "process",
"currentVersion": "1.0",
"pendingVersion": "",
"deleted": true,
"latestVersion": ""
},
{
"@type": "PublisherPackagedComponent",
"componentId": "fa0211d4-d417-4230-b695-c78846c6e83d",
"componentName": "New Process 2",
"componentType": "process",
"currentVersion": "1.0",
"pendingVersion": "",
"deleted": true,
"latestVersion": ""
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": "\n first ipack \n \n \n \n \n \n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PublisherIntegrationPack/{id}": {
"get": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Retrieves an instance of a PublisherIntegrationPack object",
"description": "Retrieves the details of the integration pack and packaged components. \nThe standard GET operation retrieves the properties of the integration pack with a specified ID. \nThe bulk GET operation retrieves the properties of the integration packs with the specified IDs to a maximum of 100.",
"operationId": "GetPublisherIntegrationPack",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the integration pack."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": {
"@type": "PublisherIntegrationPack",
"Description": "",
"PublisherPackagedComponents": {
"@type": "PublisherPackagedComponents",
"PublisherPackagedComponent": [
{
"@type": "PublisherPackagedComponent",
"componentId": "76742659-845c-45e4-bb9f-d63ff998f658",
"componentName": "New Process 4",
"componentType": "process",
"currentVersion": "1.0",
"pendingVersion": "",
"deleted": true,
"latestVersion": ""
},
{
"@type": "PublisherPackagedComponent",
"componentId": "fa0211d4-d417-4230-b695-c78846c6e83d",
"componentName": "New Process 2",
"componentType": "process",
"currentVersion": "1.0",
"pendingVersion": "",
"deleted": true,
"latestVersion": ""
}
]
},
"id": "d7c16f5d-3311-417e-a149-3c55436f7d8d",
"name": "perf testing ipack",
"installationType": "MULTI",
"operationType": "ADD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": "\n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Modifies or updates a PublisherIntegrationPack object",
"description": "The Update operation adds or removes the packaged components from the publisher integration pack. \n It also updates the description field of single and multiple attachment integration packs and the name field only for a single attachment integration pack.\n\n >**Note:** When updating an integration pack, you must include all the packaged components associated with it in the request body. \n If a packaged component is not included, it will be deleted upon updating an integration pack. \n For example, include all packaged components while updating the integration pack name.",
"operationId": "UpdatePublisherIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": {
"Description": "description update",
"PublisherPackagedComponents": {
"PublisherPackagedComponent": [
{
"componentId": "6d7c05f6-cb29-41c7-8bac-b9e57b3b9783"
}
]
},
"id": "e7b60a7c-559a-4904-9a52-d724f2d967b4",
"name": "single_Ipack",
"installationType": "SINGLE",
"operationType": "ADD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": "\n description update \n \n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": {
"@type": "PublisherIntegrationPack",
"Description": "description update",
"PublisherPackagedComponents": {
"@type": "PublisherPackagedComponents",
"PublisherPackagedComponent": [
{
"@type": "PublisherPackagedComponent",
"componentId": "6d7c05f6-cb29-41c7-8bac-b9e57b3b9783",
"componentName": "New Process 7",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "1.0",
"deleted": true,
"latestVersion": ""
},
{
"@type": "PublisherPackagedComponent",
"componentId": "c7d8653d-81ff-4fcc-b814-49e148fc4024",
"componentName": "Cleanse",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "cleanse process",
"deleted": true,
"latestVersion": ""
},
{
"@type": "PublisherPackagedComponent",
"componentId": "b2780aad-f5af-44e8-9b5b-f4823b363284",
"componentName": "New Process 3",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "test",
"deleted": true,
"latestVersion": ""
}
]
},
"id": "e7b60a7c-559a-4904-9a52-d724f2d967b4",
"name": "single_Ipack",
"installationType": "SINGLE",
"operationType": "ADD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPack"
},
"example": " operationType=\"ADD\">\n description update \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
},
"delete": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Deletes a PublisherIntegrationPack object",
"description": "Deletes the publisher integration pack having a specified ID from the requesting account. \nThe deleted integration pack is automatically uninstalled from all accounts where it was installed. \nAny Runtimes or environments attached to the integration pack are also detached.",
"operationId": "DeletePublisherIntegrationPack",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the integration pack."
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PublisherIntegrationPack/bulk": {
"post": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Retrieves multiple PublisherIntegrationPack objects by identifier",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkPublisherIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackBulkRequest"
},
"example": {
"type": "GET",
"request": [
{
"id": "b9875167-ddbd-4c5f-a77d-327589b52bf8"
},
{
"id": "not_a_real_package_id"
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackBulkRequest"
},
"example": "\n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackBulkResponse"
},
"example": {
"@type": "BulkResult",
"response": [
{
"@type": "BulkResponse",
"Result": {
"@type": "PublisherIntegrationPack",
"Description": "",
"PublisherPackagedComponents": {
"@type": "PublisherPackagedComponents",
"PublisherPackagedComponent": [
{
"@type": "PublisherPackagedComponent",
"componentId": "c7d8653d-81ff-4fcc-b814-49e148fc4024",
"componentName": "Cleanse",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "cleanse process",
"deleted": true,
"latestVersion": ""
},
{
"@type": "PublisherPackagedComponent",
"componentId": "b2780aad-f5af-44e8-9b5b-f4823b363284",
"componentName": "New Process 3",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "test",
"deleted": true,
"latestVersion": ""
}
]
},
"id": "b9875167-ddbd-4c5f-a77d-327589b52bf8",
"name": "test multi",
"installationType": "MULTI",
"operationType": "ADD"
},
"statusCode": 200
},
{
"@type": "BulkResponse",
"id": "not_a_real_package_id",
"statusCode": 400,
"errorMessage": "Integration pack ID not_a_real_package_id is invalid. Provide a valid integration pack ID to complete this action."
}
]
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackBulkResponse"
}
},
"example": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n "
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PublisherIntegrationPack/query": {
"post": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Queries for a PublisherIntegrationPack object(s)",
"description": "For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to [Query filters](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_filters) and [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryPublisherIntegrationPack",
"requestBody": {
"description": "Possible properties include: name, id, installationType",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"SINGLE"
],
"operator": "EQUALS",
"property": "installationType"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"SINGLE"
],
"operator": "EQUALS",
"property": "installationType"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": "\n \n \n SINGLE \n \n \n "
},
"GroupingExpression": {
"value": "\n \n SINGLE \n \n \n another-value \n \n \n \n Ipack description \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/PublisherIntegrationPack/queryMore": {
"post": {
"tags": [
"PublisherIntegrationPack"
],
"summary": "Retrieves additional results for a PublisherIntegrationPack query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMorePublisherIntegrationPack",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "PublisherIntegrationPack",
"Description": "Ipack description",
"PublisherPackagedComponents": {
"@type": "PublisherPackagedComponents",
"PublisherPackagedComponent": []
},
"id": "664cc077-28a8-42cb-ac6e-1cb131c9e0d0",
"name": "IPACK-JSON",
"installationType": "SINGLE"
},
{
"@type": "PublisherIntegrationPack",
"Description": "",
"PublisherPackagedComponents": {
"@type": "PublisherPackagedComponents",
"PublisherPackagedComponent": [
{
"@type": "PublisherPackagedComponent",
"componentId": "62f7ffb7-5332-4142-893a-8d40d4742ccf",
"componentName": "Rate Limit Test",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "1.0",
"deleted": true,
"latestVersion": ""
},
{
"@type": "PublisherPackagedComponent",
"componentId": "bb0dae4f-c8f3-47fa-9dee-c3c484f79f71",
"componentName": "New Process 4",
"componentType": "process",
"currentVersion": "",
"pendingVersion": "3.0",
"deleted": true,
"latestVersion": ""
}
]
},
"id": "8b80f83b-9836-49a0-8c72-753131a77bae",
"name": "test single",
"installationType": "SINGLE",
"operationType": "ADD"
}
],
"numberOfResults": 2
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/PublisherIntegrationPackQueryResponse"
},
"example": "\n \n Ipack description \n \n \n \n \n \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ReleaseIntegrationPack": {
"post": {
"tags": [
"ReleaseIntegrationPack"
],
"summary": "Creates a ReleaseIntegrationPack object",
"description": "Creates an immediate or scheduled release for a publisher integration pack. \n\nTo schedule the publisher integration pack for release, you must specify the release schedule (immediate or scheduled). \nThe `releaseOnDate` field is required if you schedule the release for a future date.\n\n >**Note:** When scheduling an integration pack for a release using Create and Update operation, you must select your time zone in the [User Information](https://help.boomi.com/docs/Atomsphere/Platform/r-atm-User_information_management_6cb11e71-95a5-4257-aaff-66da5a1517ff) panel within the Settings page. Setting the time zone ensures the scheduled date is displayed correctly in the UI.",
"operationId": "CreateReleaseIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": {
"id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
"name": "Testing Multi",
"installationType": "MULTI",
"releaseSchedule": "IMMEDIATELY",
"ReleasePackagedComponents": {
"ReleasePackagedComponent": [
{
"componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
"version": "2.0"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": "\n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": {
"@type": "ReleaseIntegrationPack",
"id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
"installationType": "MULTI",
"name": "Testing Multi",
"releaseSchedule": "IMMEDIATELY",
"requestId": "release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
"releaseStatusUrl": "https://api.boomi.com/api/rest/v1/boomi-8Q78Q1/ReleaseIntegrationPackStatus/release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
"releaseOnDate": "2025-02-20",
"ReleasePackagedComponents": {
"ReleasePackagedComponent": [
{
"componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
"releasedVersion": "1.0",
"version": "1.0"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": " \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ReleaseIntegrationPack/{id}": {
"post": {
"tags": [
"ReleaseIntegrationPack"
],
"summary": "Modifies or updates a ReleaseIntegrationPack object",
"description": "Modifies the scheduled release of a publisher integration pack. \n\n The Update operation is only performed when there is an existing scheduled release request for the integration pack. \n\n >**Note:** When scheduling an integration pack for a release using Create and Update operation, you must select your time zone in the [User Information](https://help.boomi.com/docs/Atomsphere/Platform/r-atm-User_information_management_6cb11e71-95a5-4257-aaff-66da5a1517ff) panel within the Settings page. Setting the time zone ensures the scheduled date is displayed correctly in the UI.",
"operationId": "UpdateReleaseIntegrationPack",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": {
"id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
"name": "Testing Multi",
"installationType": "MULTI",
"releaseSchedule": "IMMEDIATELY",
"ReleasePackagedComponents": {
"ReleasePackagedComponent": [
{
"componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
"releasedVersion": "1.0",
"version": "1.0"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": "\n \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": {
"@type": "ReleaseIntegrationPack",
"id": "f0f7face-3a9d-48b1-8a32-82b84499cd4e",
"installationType": "MULTI",
"name": "Testing Multi",
"releaseSchedule": "IMMEDIATELY",
"requestId": "release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
"releaseStatusUrl": "https://api.boomi.com/api/rest/v1/boomi-8Q78Q1/ReleaseIntegrationPackStatus/release-11031691-dc62-4280-a3b2-dcf7f3521f8a",
"releaseOnDate": "2025-02-20",
"ReleasePackagedComponents": {
"ReleasePackagedComponent": [
{
"componentId": "b420a8ab-8e4e-41b2-93ce-079093a03af2",
"releasedVersion": "1.0",
"version": "1.0"
}
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPack"
},
"example": " \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/ReleaseIntegrationPackStatus/{id}": {
"get": {
"tags": [
"ReleaseIntegrationPackStatus"
],
"summary": "Retrieves an instance of a ReleaseIntegrationPackStatus object",
"description": "\nTo retrieve the release status of the publisher integration pack, follow these steps:\n \n1. Send a POST request to the ReleaseIntegrationPackStatus object. The response will return a requestId.\n2. Use the requestId returned in Step 1 to make a subsequent call to the ReleaseIntegrationPackStatus object to retrieve detailed information about the released integration pack.\n3. Repeatedly poll the ReleaseIntegrationPackStatus object using the requestId until the details of the released integration pack are available. If the request is still in progress or scheduled, it returns an HTTP 202 status code. When the integration pack is released successfully, the ReleaseIntegrationPackStatus object returns the released details.",
"operationId": "GetReleaseIntegrationPackStatus",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique ID assigned by the system to the integration pack."
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPackStatus"
},
"example": {
"@type": "ReleaseIntegrationPackStatus",
"ReleasePackagedComponents": {
"@type": "ReleasePackagedComponents",
"ReleasePackagedComponent": [
{
"@type": "ReleasePackagedComponent",
"componentId": "bb8b6c9d-9c39-4309-b07f-cdd96d201b27",
"releasedVersion": "1.0"
},
{
"@type": "ReleasePackagedComponent",
"componentId": "9d05717c-4dfe-4d5f-8e60-9196a6f78ef9",
"releasedVersion": "1.0",
"version": "2.0"
}
]
},
"responseStatusCode": 200,
"integrationPackId": "d7c16f5d-3311-417e-a149-3c55436f7d8d",
"name": "perf testing ipack",
"installationType": "MULTI",
"releaseSchedule": "IMMEDIATELY",
"requestId": "release-dcfbfd2c-09d9-492d-9965-bbd9ab8f2ffc",
"releaseStatus": "SUCCESS",
"releaseOnDate": "2025-02-20"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPackStatus"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/ReleaseIntegrationPackStatus/bulk": {
"post": {
"tags": [
"ReleaseIntegrationPackStatus"
],
"summary": "Retrieves multiple ReleaseIntegrationPackStatus objects by identifier",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkReleaseIntegrationPackStatus",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPackStatusBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPackStatusBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPackStatusBulkResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseIntegrationPackStatusBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeRestartRequest": {
"post": {
"tags": [
"RuntimeRestartRequest"
],
"summary": "Creates a RuntimeRestartRequest object",
"description": "Restarts the runtime. \n\n - The client sends a runtime restart request to the platform API that specifies the runtimeId that you want to restart. \n - 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.",
"operationId": "CreateRuntimeRestartRequest",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeRestartRequest"
},
"example": {
"runtimeId": "3456789a-bcde-f012-3456-789abcdef012"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeRestartRequest"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeRestartRequest"
},
"example": {
"@type": "RuntimeRestartRequest",
"statusCode": 200,
"message": "Restart request submitted for runtimeId `3456789a-bcde-f012-3456-789abcdef012`. Use the Atom object to retrieve the current runtime status."
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeRestartRequest"
},
"example": "\n"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SecretsManagerRefreshResponse"
},
"example": "\n\"/>"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeCloud": {
"post": {
"tags": [
"RuntimeCloud"
],
"summary": "Creates a RuntimeCloud object",
"description": "Creates a private runtime cloud in the specified (TEST or PROD) environment.\n\nSend an HTTP POST to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud`\n\nWhere `accountId` is the ID of the authenticating account.\n\n 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.",
"operationId": "CreateRuntimeCloud",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": {
"name": "My Private Cloud 1",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1,
"classification": "PROD"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": {
"@type": "RuntimeCloud",
"id": "59f78b7d-73bb-4b86-81f6-1b08c9205c2f",
"name": "My Private Cloud 1",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1,
"modifiedDate": "2025-06-12T12:22:54Z",
"createdDate": "2025-06-12T12:22:54Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeCloud/{id}": {
"get": {
"tags": [
"RuntimeCloud"
],
"summary": "Retrieves an instance of a RuntimeCloud object",
"description": "Retrieves the properties of a private runtime cloud with a specific ID. \nThe `createdBy`, `createdDate`, `modifiedBy`, and `modifiedDate` fields return in a successful response for private runtime clouds created after July 12, 2025. \nIf you update any existing private runtime cloud, then only `modifiedBy` and `modifiedDate` are returned in the Get response.\n\nSend an HTTP GET to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}`\n\n Where `accountId` is the ID of the authenticating account, and `cloudId` is the ID of the cloud for which you want to get information.\n\n",
"operationId": "GetRuntimeCloud",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": {
"@type": "RuntimeCloud",
"id": "326260d6-895e-4c45-a99f-a16de3907189",
"name": "Private Cloud",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 0,
"modifiedDate": "2025-05-27T18:32:49Z",
"createdDate": "2025-05-27T18:32:49Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"post": {
"tags": [
"RuntimeCloud"
],
"summary": "Modifies or updates a RuntimeCloud object.",
"description": "Updates the private runtime clouds.\n\n- 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.\n- 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.\n\nSend an HTTP POST to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}`\n\nWhere `accountId` is the ID of the authenticating account, and `cloudId` is the ID of the cloud you want to update.",
"operationId": "UpdateRuntimeCloud",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": {
"id": "59f78b7d-73bb-4b86-81f6-1b08c9205c2f",
"name": "First runtime cloud",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": false,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": {
"@type": "RuntimeCloud",
"id": "59f78b7d-73bb-4b86-81f6-1b08c9205c2f",
"name": "First runtime cloud",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": false,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1,
"modifiedDate": "2025-06-12T12:27:06Z",
"createdDate": "2025-06-12T12:22:54Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloud"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
},
"delete": {
"tags": [
"RuntimeCloud"
],
"summary": "Deletes a RuntimeCloud object.",
"description": "Send an HTTP DELETE to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/{cloudId}`\n\nWhere `accountId` is the ID of the authenticating account, and `cloudId` is the ID of the cloud you want to delete.",
"operationId": "DeleteRuntimeCloud",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response."
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeCloud/bulk": {
"post": {
"tags": [
"RuntimeCloud"
],
"summary": "Retrieves multiple RuntimeCloud objects by identifier",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkRuntimeCloud",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeCloud/query": {
"post": {
"tags": [
"RuntimeCloud"
],
"summary": "Queries for RuntimeCloud objects",
"description": "Retrieves private runtime clouds that exist on requesting account, and you can filter the records using query filters.\n\nSend an HTTP POST to: `https://api.boomi.com/api/rest/v1/{accountId}/RuntimeCloud/query`\n\n Where `accountId` is the ID of the authenticating account.\n\n",
"operationId": "QueryRuntimeCloud",
"requestBody": {
"description": " Possible properties include: name, id, classification, allowDeployments, allowBrowsing, allowTestExecutions, maxAttachmentsPerAccount, createdDate, modifiedDate, createdBy, modifiedBy",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudQueryConfig"
},
"examples": {
"SimpleExpression": {
"value": {
"QueryFilter": {
"expression": {
"argument": [
"PROD"
],
"operator": "EQUALS",
"property": "classification"
}
}
}
},
"GroupingExpression": {
"value": {
"QueryFilter": {
"expression": {
"operator": "and",
"nestedExpression": [
{
"argument": [
"PROD"
],
"operator": "EQUALS",
"property": "classification"
},
{
"argument": [
"another-value"
],
"operator": "EQUALS",
"property": "anotherProperty"
}
]
}
}
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudQueryConfig"
},
"example": "\n \n \n myCloud \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "RuntimeCloud",
"id": "c0235ead-1be2-44ea-bc7f-d1966022d18d",
"name": "myCloud",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": false,
"maxAttachmentsPerAccount": 2,
"modifiedDate": "2025-05-28T04:10:11Z",
"modifiedBy": "testUser@boomi.com",
"createdDate": "2025-06-12T12:22:54Z",
"createdBy": "testUser@boomi.com"
}
],
"numberOfResults": 1
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudQueryResponse"
},
"example": "\n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeCloud/queryMore": {
"post": {
"tags": [
"RuntimeCloud"
],
"summary": "Retrieves additional results for a RuntimeCloud query",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreRuntimeCloud",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "RuntimeCloud",
"id": "e999ff6c-f834-4021-a169-d792c5714171",
"name": "My runtime cloud 1",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1,
"modifiedDate": "2025-05-28T04:12:40Z",
"createdDate": "2025-05-28T04:12:40Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
},
{
"@type": "RuntimeCloud",
"id": "1368ec8a-9ba7-436c-b99f-adf447b287f9",
"name": "My runtime cloud 2",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1,
"modifiedDate": "2025-05-28T04:12:40Z",
"createdDate": "2025-05-28T04:12:40Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
},
{
"@type": "RuntimeCloud",
"id": "09e48685-1a0c-4e1f-9958-b852366dd048",
"name": "My runtime cloud 3",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 1,
"modifiedDate": "2025-05-28T04:12:40Z",
"createdDate": "2025-05-28T04:12:40Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
},
{
"@type": "RuntimeCloud",
"id": "ed4309b9-05db-4ef8-92d5-50116ff11410",
"name": "My runtime cloud 4",
"classification": "PROD",
"allowDeployments": true,
"allowBrowsing": true,
"allowTestExecutions": true,
"maxAttachmentsPerAccount": 3,
"modifiedDate": "2025-05-28T04:29:15Z",
"createdDate": "2025-05-28T04:26:35Z",
"createdBy": "testUser@boomi.com",
"modifiedBy": "testUser@boomi.com"
}
],
"numberOfResults": 4
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeCloudQueryResponse"
},
"example": "\n\n \n\n\n \n\n \n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentPropertiesDefault/{id}": {
"post": {
"tags": [
"AccountCloudAttachmentPropertiesDefault"
],
"summary": "Modifies or updates an AccountCloudAttachmentPropertiesDefault object.",
"description": "Sets the default cloud attachment properties for runtime cloud clusters.\n\nIf you have multiple runtime cloud clusters, you need to set the defaults for each runtime cloud cluster individually. You can use the [AccountCloudAttachmentSummary](https://developer.boomi.com/docs/api/platformapi/AccountCloudAttachmentSummary) API to see the runtime cloud cluster status.\n\n>**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.",
"operationId": "UpdateAccountCloudAttachmentPropertiesDefault",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesDefault"
},
"example": {
"@type": "AccountCloudAttachmentPropertiesDefault",
"accountDiskUsage": "429496729600",
"numberofAtomWorkers": "1",
"atomInputSize": "413132133313",
"atomOutputOverflowSize": "421313313",
"atomWorkingOverflowSize": "31313313",
"httpRequestRate": "31313313",
"workerMaxExecutionTime": "30000",
"workerMaxGeneralExecutionTime": "600000",
"workerMaxRunningExecutions": "20",
"workerMaxQueuedExecutions": "10",
"workerQueuedExecutionTimeout": "10000",
"maxConnectorTrackDocs": "10000",
"httpWorkload": "LOW_LATENCY",
"as2Workload": "GENERAL",
"cloudAccountExecutionLimit": "2147383646",
"cloudAccountExecutionWarningOffset": "31313213",
"enableAtomWorkerWarmup": "false",
"minNumberofAtomWorkers": "1",
"testModeMaxDocs": "100",
"testModeMaxDocBytes": "10485760",
"enableAccountDataArchiving": "false",
"listenerMaxConcurrentExecutions": "6",
"downloadRunnerlogs": "true"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesDefault"
},
"example": ""
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesDefault"
},
"example": {
"@type": "AccountCloudAttachmentPropertiesDefault",
"statusCode": 200,
"sessionId": "AccountCloudAttachmentPropertiesDefault-1f23456f-a78f-91cc-012e-3e4dec5b67d8"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesDefault"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentSummary/{id}": {
"get": {
"tags": [
"AccountCloudAttachmentSummary"
],
"summary": "Retrieves an instance of an AccountCloudAttachmentSummary object",
"description": "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.",
"operationId": "GetAccountCloudAttachmentSummary",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummary"
},
"example": {
"@type": "AccountCloudAttachmentSummary",
"runtimeId": "0134a8f1-594a-479c-b535-fd8154942952",
"attachmentInstanceId": "myaccount-A1B2C3.BJRJC2",
"attachmentAccountId": "myaccount-A1B2C3",
"cloudClusterId": "9cfec83c-cc54-4a36-bdac-b233e92ba7c5",
"cloudId": "abf5efbc-8829-4deb-8e1c-f2d2a4885b15",
"attachmentCreationDate": "2025-06-11T07:06:04Z"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummary"
},
"example": "\n"
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentSummary/bulk": {
"post": {
"tags": [
"AccountCloudAttachmentSummary"
],
"summary": "Retrieves multiple AccountCloudAttachmentSummary objects by identifier.",
"description": "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](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Bulk_GET_operations).",
"operationId": "BulkAccountCloudAttachmentSummary",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryBulkRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryBulkRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryBulkResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryBulkResponse"
}
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentSummary/query": {
"post": {
"tags": [
"AccountCloudAttachmentSummary"
],
"summary": "Queries for an AccountCloudAttachmentSummary object(s)",
"description": "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.\n\nFor 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.",
"operationId": "QueryAccountCloudAttachmentSummary",
"requestBody": {
"description": " Possible properties include: runtimeId, attachmentAccountId, attachmentInstanceId, attachmentCreationDate, cloudClusterId, cloudId, clusterCloudId",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryQueryConfig"
},
"example": {
"QueryFilter": {
"expression": {
"argument": [
"abc-A1B2C3.ST9U8N"
],
"operator": "NOT_EQUALS",
"property": "attachmentInstanceId"
}
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryQueryConfig"
},
"example": "\n \n \n c2565504-2d6b-4785-9b1e-041f020e868a \n \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "AccountCloudAttachmentSummary",
"runtimeId": "9d0904a4-475c-4120-9ba5-2ae6b918e6f9",
"attachmentInstanceId": "abc-A1B2C3.HJKLM8",
"attachmentAccountId": "abc-A1B2C3",
"cloudClusterId": "9d0904a4-475c-4120-9ba5-2ae6b918e6f9",
"cloudId": "be3f9179-dfa2-4bca-8efb-ad02ced243dd",
"attachmentCreationDate": "2025-06-10T13:28:16Z"
},
{
"@type": "AccountCloudAttachmentSummary",
"runtimeId": "7c2eaf8b-6785-4a33-a97f-6b83aa4e5fdb",
"attachmentInstanceId": "account-J4K5L6.ST9U8N",
"attachmentAccountId": "account-J4K5L6",
"cloudClusterId": "025dcd38-7b06-497c-8769-0fa701f80a3c",
"cloudId": "3ca45d71-7794-40e2-b94b-182aef8ce5c2",
"attachmentCreationDate": "2025-07-30T07:40:55Z"
}
],
"numberOfResults": 2
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryQueryResponse"
},
"example": "\n\n\n \n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/AccountCloudAttachmentSummary/queryMore": {
"post": {
"tags": [
"AccountCloudAttachmentSummary"
],
"summary": "Retrieves additional results for an AccountCloudAttachmentSummary query.",
"description": "To learn about using `queryMore`, refer to the topic [Query paging](https://developer.boomi.com/docs/APIs/PlatformAPI/Introduction/Query_paging).",
"operationId": "QueryMoreAccountCloudAttachmentSummary",
"requestBody": {
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryQueryResponse"
},
"example": {
"@type": "QueryResult",
"result": [
{
"@type": "AccountCloudAttachmentSummary",
"runtimeId": "9d0904a4-475c-4120-9ba5-2ae6b918e6f9",
"attachmentInstanceId": "myaccount-YWHK01.HJKLMN",
"attachmentAccountId": "myaccount-YWHK01",
"cloudClusterId": "9d0904a4-475c-4120-9ba5-2ae6b918e6f9",
"cloudId": "be3f9179-dfa2-4bca-8efb-ad02ced243dd",
"attachmentCreationDate": "2025-06-10T13:28:16Z"
},
{
"@type": "AccountCloudAttachmentSummary",
"runtimeId": "7c2eaf8b-6785-4a33-a97f-6b83aa4e5fdb",
"attachmentInstanceId": "account-J4K5L6.ST9U8N",
"attachmentAccountId": "account-J4K5L6",
"cloudClusterId": "025dcd38-7b06-497c-8769-0fa701f80a3c",
"cloudId": "3ca45d71-7794-40e2-b94b-182aef8ce5c2",
"attachmentCreationDate": "2025-07-30T07:40:55Z"
}
],
"numberOfResults": 2
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentSummaryQueryResponse"
},
"example": "\n\n\n \n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AccountCloudAttachmentPropertiesDefault/{id}": {
"get": {
"tags": [
"AccountCloudAttachmentPropertiesDefault"
],
"summary": "Retrieves an AccountCloudAttachmentPropertiesDefault object by identifier",
"operationId": "AsyncGetAccountCloudAttachmentPropertiesDefault",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"@type": "AsyncOperationTokenResult",
"asyncToken": {
"@type": "AsyncToken",
"token": "AccountCloudAttachmentPropertiesDefault-1f23456f-a78f-91cc-012e-3e4dec5b67d8"
},
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/AccountCloudAttachmentPropertiesDefault/response/{token}": {
"get": {
"tags": [
"AccountCloudAttachmentPropertiesDefault"
],
"summary": "Retrieves an AccountCloudAttachmentPropertiesDefault object by token",
"description": "Retrieves an AccountCloudAttachmentPropertiesDefault object by token",
"operationId": "AsyncTokenAccountCloudAttachmentPropertiesDefault",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesDefaultAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "AccountCloudAttachmentPropertiesDefault",
"accountDiskUsage": 4294,
"numberofAtomWorkers": 4,
"atomInputSize": 4131,
"atomOutputOverflowSize": 4213,
"atomWorkingOverflowSize": 413,
"httpRequestRate": 43,
"workerMaxExecutionTime": 322,
"workerMaxGeneralExecutionTime": 322,
"workerMaxRunningExecutions": 40,
"workerMaxQueuedExecutions": 40,
"workerQueuedExecutionTimeout": 401,
"maxConnectorTrackDocs": 40,
"httpWorkload": "LOW_LATENCY_DEBUG",
"as2Workload": "GENERAL",
"cloudAccountExecutionLimit": 415,
"cloudAccountExecutionWarningOffset": 413,
"enableAtomWorkerWarmup": true,
"minNumberofAtomWorkers": 4,
"testModeMaxDocs": 400,
"testModeMaxDocBytes": 304,
"enableAccountDataArchiving": true,
"listenerMaxConcurrentExecutions": 5,
"downloadRunnerlogs": true
}
],
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AccountCloudAttachmentPropertiesDefaultAsyncResponse"
},
"example": ""
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/RuntimeObservabilitySettings/{id}": {
"get": {
"tags": [
"RuntimeObservabilitySettings"
],
"summary": "Retrieves a RuntimeObservabilitySettings object by identifier",
"description": "Initiates async operation and returns token for retrieving observability settings.",
"operationId": "AsyncGetRuntimeObservabilitySettings",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"@type": "AsyncOperationTokenResult",
"asyncToken": {
"@type": "AsyncToken",
"token": "RuntimeObservabilitySettings-2a16ed42-a32a-4114-85ab-44eb2c60303c"
},
"responseStatusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/RuntimeObservabilitySettings/response/{token}": {
"get": {
"tags": [
"RuntimeObservabilitySettings"
],
"summary": "Retrieves a RuntimeObservabilitySettings object by token",
"description": "Retrieves observability settings using the token.",
"operationId": "AsyncTokenRuntimeObservabilitySettings",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeObservabilitySettingsAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "RuntimeObservabilitySettings",
"runtimeId": "44e038de-7830-426e-a1c5-36baaa8c99ef",
"generalSettings": {
"@type": "GeneralSettings",
"enabled": true,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "http://api.example.com:4317",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BASIC",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "username",
"type": "string",
"value": "newusername@company.comnew"
},
{
"@type": "ObservabilityAuthenticationFields",
"id": "password",
"type": "password",
"encryptedValueSet": true
}
]
}
}
},
"logSettings": {
"@type": "LogSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://logs-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"type": "password",
"encryptedValueSet": true
}
]
}
},
"logFilterEnabled": true,
"logFilterTypes": [
"RUNTIME",
"PROCESS",
"DOCUMENT",
"RUNNER",
"WORKER",
"BROWSER"
],
"logTimeoutSeconds": [
"BigInteger",
30
],
"logBatchSize": [
"BigInteger",
512
],
"logFlushInterval": [
"BigInteger",
1000
],
"logMaxQueueSize": [
"BigInteger",
2048
]
},
"metricSettings": {
"@type": "MetricSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://metrics-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"type": "password",
"encryptedValueSet": true
}
]
}
},
"metricTimeoutSeconds": [
"BigInteger",
30
],
"metricIntervalSeconds": [
"BigInteger",
30
]
},
"traceSettings": {
"@type": "TraceSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://traces-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"type": "password",
"encryptedValueSet": true
}
]
}
},
"traceTimeoutSeconds": [
"BigInteger",
0
],
"traceBatchSize": [
"BigInteger",
0
],
"traceFlushInterval": [
"BigInteger",
100
],
"traceMaxQueueSize": [
"BigInteger",
0
],
"processFilterEnabled": true,
"processFilterIds": [
"1d0f671b-713a-4f9c-942f-f27f396bfa0c",
"b29f0349-23d6-4e87-846b-381ac76b8e5f",
"75949b79-c36d-4188-8c4d-9aa5ce8c40e3"
]
}
}
],
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeObservabilitySettingsAsyncResponse"
},
"example": "\n\n \n 44e038de-7830-426e-a1c5-36baaa8c99ef \n \n true \n \n http://api.example.com:4317 \n \n BASIC \n \n username \n string \n newusername@company.comnew \n \n \n password \n password \n true \n \n \n \n \n \n true \n false \n \n https://logs-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n password \n true \n \n \n \n true \n RUNTIME \n PROCESS \n DOCUMENT \n RUNNER \n WORKER \n BROWSER \n 30 \n 512 \n 1000 \n 2048 \n \n \n true \n false \n \n https://metrics-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n password \n true \n \n \n \n 30 \n 30 \n \n \n true \n false \n \n https://traces-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n password \n true \n \n \n \n 0 \n 0 \n 100 \n 0 \n true \n 1d0f671b-713a-4f9c-942f-f27f396bfa0c \n b29f0349-23d6-4e87-846b-381ac76b8e5f \n 75949b79-c36d-4188-8c4d-9aa5ce8c40e3 \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeObservabilitySettings/{id}": {
"post": {
"tags": [
"RuntimeObservabilitySettings"
],
"summary": "Modifies or updates a RuntimeObservabilitySettings object",
"description": "Updates observability settings for a runtime",
"operationId": "UpdateRuntimeObservabilitySettings",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeObservabilitySettings"
},
"example": {
"runtimeId": "a0c49871-212b-4ece-9b29-fafd80ca0136",
"generalSettings": {
"@type": "GeneralSettings",
"enabled": true,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "http://api.example.com:4317",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BASIC",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "username",
"value": "newusername@company.comnew"
},
{
"@type": "ObservabilityAuthenticationFields",
"id": "password",
"value": "mypasswordsdfvzsdvz"
}
]
}
}
},
"logSettings": {
"@type": "LogSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://logs-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"value": "esrgslogs-bearer-tokendzfvzdv"
}
]
}
},
"logTimeoutSeconds": 30,
"logBatchSize": 512,
"logFlushInterval": 1000,
"logMaxQueueSize": 2048,
"logFilterEnabled": true,
"logFilterTypes": [
"RUNTIME",
"PROCESS",
"DOCUMENT",
"RUNNER",
"WORKER",
"BROWSER"
]
},
"metricSettings": {
"@type": "MetricSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://metrics-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"value": "metrics-bearer-token"
}
]
}
},
"metricTimeoutSeconds": 30,
"metricIntervalSeconds": 30
},
"traceSettings": {
"@type": "TraceSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://traces-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"value": "traces-bearer-token"
}
]
}
},
"traceBatchSize": 0,
"traceFlushInterval": 100,
"traceTimeoutSeconds": 0,
"traceMaxQueueSize": 0,
"processFilterEnabled": true,
"processFilterIds": [
"1d0f671b-713a-4f9c-942f-f27f396bfa0c",
"b29f0349-23d6-4e87-846b-381ac76b8e5f",
"75949b79-c36d-4188-8c4d-9aa5ce8c40e3"
]
},
"shouldRestartPlugin": true
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeObservabilitySettings"
},
"example": "\n\n a0c49871-212b-4ece-9b29-fafd80ca0136 \n \n true \n \n http://api.example.com:4317 \n \n BASIC \n \n username \n newusername@company.comnew \n \n \n password \n mypassword123 \n \n \n \n \n \n true \n false \n \n https://logs-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n logs-bearer-token123 \n \n \n \n true \n RUNTIME \n PROCESS \n DOCUMENT \n RUNNER \n WORKER \n BROWSER \n 30 \n 512 \n 1000 \n 2048 \n \n \n true \n false \n \n https://metrics-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n metrics-bearer-token123 \n \n \n \n 30 \n 30 \n \n \n true \n false \n \n https://traces-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n traces-bearer-token123 \n \n \n \n 30 \n 512 \n 100 \n 2048 \n true \n 1d0f671b-713a-4f9c-942f-f27f396bfa0c \n b29f0349-23d6-4e87-846b-381ac76b8e5f \n 75949b79-c36d-4188-8c4d-9aa5ce8c40e3 \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeObservabilitySettings"
},
"example": {
"@type": "RuntimeObservabilitySettings",
"runtimeId": "a0c49871-212b-4ece-9b29-fafd80ca0136",
"generalSettings": {
"@type": "GeneralSettings",
"enabled": true,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "http://api.example.com:4317",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BASIC",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "username",
"type": "string",
"value": "newusername@company.comnew"
},
{
"@type": "ObservabilityAuthenticationFields",
"id": "password",
"type": "password",
"encryptedValueSet": true
}
]
}
}
},
"logSettings": {
"@type": "LogSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://logs-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"type": "password",
"encryptedValueSet": true
}
]
}
},
"logFilterEnabled": true,
"logFilterTypes": [
"RUNTIME",
"PROCESS",
"DOCUMENT",
"RUNNER",
"WORKER",
"BROWSER"
],
"logTimeoutSeconds": [
"BigInteger",
30
],
"logBatchSize": [
"BigInteger",
512
],
"logFlushInterval": [
"BigInteger",
1000
],
"logMaxQueueSize": [
"BigInteger",
2048
]
},
"metricSettings": {
"@type": "MetricSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://metrics-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"type": "password",
"encryptedValueSet": true
}
]
}
},
"metricTimeoutSeconds": [
"BigInteger",
30
],
"metricIntervalSeconds": [
"BigInteger",
30
]
},
"traceSettings": {
"@type": "TraceSettings",
"enabled": true,
"overrideGeneralObservabilityEndpoint": false,
"observabilityEndpoint": {
"@type": "ObservabilityEndpoint",
"url": "https://traces-endpoint.example.com",
"authentication": {
"@type": "ObservabilityEndpointAuthentication",
"authType": "BEARER_TOKEN",
"fields": [
{
"@type": "ObservabilityAuthenticationFields",
"id": "bearerToken",
"type": "password",
"encryptedValueSet": true
}
]
}
},
"traceTimeoutSeconds": [
"BigInteger",
0
],
"traceBatchSize": [
"BigInteger",
0
],
"traceFlushInterval": [
"BigInteger",
100
],
"traceMaxQueueSize": [
"BigInteger",
0
],
"processFilterEnabled": true,
"processFilterIds": [
"1d0f671b-713a-4f9c-942f-f27f396bfa0c",
"b29f0349-23d6-4e87-846b-381ac76b8e5f",
"75949b79-c36d-4188-8c4d-9aa5ce8c40e3"
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeObservabilitySettings"
},
"example": "\n\n a0c49871-212b-4ece-9b29-fafd80ca0136 \n \n true \n \n http://api.example.com:4317 \n \n BASIC \n \n username \n string \n newusername@company.comnew \n \n \n password \n password \n true \n \n \n \n \n \n true \n false \n \n https://logs-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n password \n true \n \n \n \n true \n RUNTIME \n PROCESS \n DOCUMENT \n RUNNER \n WORKER \n BROWSER \n 30 \n 512 \n 1000 \n 2048 \n \n \n true \n false \n \n https://metrics-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n password \n true \n \n \n \n 30 \n 30 \n \n \n true \n false \n \n https://traces-endpoint.example.com \n \n BEARER_TOKEN \n \n bearerToken \n password \n true \n \n \n \n 30 \n 512 \n 100 \n 2048 \n true \n 1d0f671b-713a-4f9c-942f-f27f396bfa0c \n b29f0349-23d6-4e87-846b-381ac76b8e5f \n 75949b79-c36d-4188-8c4d-9aa5ce8c40e3 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/RuntimeProperties/{id}": {
"get": {
"tags": [
"RuntimeProperties"
],
"description": "Retrieves the details of standard and system properties, and custom runtime and system properties of a specific runtime. Retrieving runtime and system properties is an asynchronous process:\n1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform.\n`https://api.boomi.com/api/rest/v1/{accountId}/async/RuntimeProperties/{id}`.\nThe `accountId` is the ID of the authenticating account for the request, and `id` is the ID of the runtime.\n2. The platform returns a token.\n\n3. Send one or more GET requests that include the token.\n`https://api.boomi.com/api/rest/v1/{accountId}/async/RuntimeProperties/response/{token}`\n4. The platform returns a list of the properties associated with the specific runtime.\n>**Note:** The runtime that you are calling must be online.",
"summary": "Retrieves a RuntimeProperties object by identifier",
"operationId": "AsyncGetRuntimeProperties",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Read-only. System-generated unique identifier of a runtime.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"@type": "AsyncOperationTokenResult",
"asyncToken": {
"@type": "AsyncToken",
"token": "RuntimeProperties-881d2af4-c8c6-4bae-94b7-85b5a52c21bc"
},
"responseStatusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n\n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/RuntimeProperties/response/{token}": {
"get": {
"tags": [
"RuntimeProperties"
],
"summary": "Retrieves a RuntimeProperties object by token",
"description": "Retrieves the runtime properties using the token.",
"operationId": "AsyncTokenRuntimeProperties",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimePropertiesAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "RuntimeProperties",
"standardProperties": {
"@type": "standardProperties",
"containerHostName": "cloud_cluster2",
"containerForceRestart": 0,
"useLocalStorageForRuntimeAssets": false,
"workingDataLocalStorageDirectory": "/opt/boomi/local",
"clusterNetworkTransportType": "UNICAST",
"debugLogging": true,
"standardOutputAndErrorLogging": true,
"forceStartSharedWebServer": true,
"containerName": "cloud_cluster2",
"containerPurgeImmediately": false,
"containerPurgeDays": 37
},
"systemProperties": {
"@type": "systemProperties",
"heapSize": "513m",
"clientDefaultConnectTimeout": 120001,
"clientDefaultReadTimeout": 120000,
"javaClassPathPrepend": "/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar",
"javaSecurityCompatibility": "JVM_DEFINED",
"jgroupsClusteredLibraryVersion": 3,
"jmxRemoteAuthentication": false,
"jmxRemotePort": 6005,
"jmxRemoteSsl": false,
"preferIpv4Stack": true,
"retryHttpPost": false
},
"customRuntimeProperties": {
"@type": "customRuntimeProperties",
"com.boomi.container.is.orchestrated.container": "true",
"com.boomi.container.cloudlet.findInitialHostsTimeout": "4",
"com.boomi.container.enableUI": "false",
"com.boomi.container.metrics.enabled": "false",
"com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate": "true"
},
"customSystemProperties": {
"@type": "customSystemProperties",
"property": [
"-Dcom.sun.management.jmxremote",
"-Dcom.sun.management.jmxremote.local.only=true",
"-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"
]
},
"runtimeId": "edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5"
}
],
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimePropertiesAsyncResponse"
},
"example": "\n\n \n \n \n \n \n \n \n \n \n \n \n -Dcom.sun.management.jmxremote \n -Dcom.sun.management.jmxremote.local.only=\"false\" \n -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 \n \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/RuntimeProperties/{id}": {
"post": {
"tags": [
"RuntimeProperties"
],
"summary": "Modifies or updates a RuntimeProperties object",
"description": "Adds, removes, or updates standard and system properties, as well as custom runtime and system properties for runtimes, through a single API call.\nThe update operation includes the optional flags, `partialUpdate` and `shouldRestartRuntime`.\n\n The Update operation returns HTTP 202 status code.",
"operationId": "UpdateRuntimeProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Read-only. System-generated unique identifier of a runtime.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeProperties"
},
"example": {
"runtimeId": "edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5",
"partialUpdate": "true",
"standardProperties": {
"containerName": "cloud_cluster2",
"containerHostName": "cloud_cluster2",
"containerPurgeImmediately": false,
"containerPurgeDays": 38,
"containerForceRestart": 0,
"debugLogging": true,
"standardOutputAndErrorLogging": true,
"forceStartSharedWebServer": true,
"useLocalStorageForRuntimeAssets": false,
"workingDataLocalStorageDirectory": "/opt/boomi/local",
"clusterNetworkTransportType": "UNICAST"
},
"systemProperties": {
"heapSize": "514m",
"clientDefaultConnectTimeout": 120002,
"clientDefaultReadTimeout": 120000,
"javaClassPathPrepend": "/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar",
"javaSecurityCompatibility": "JVM_DEFINED",
"jgroupsClusteredLibraryVersion": 3,
"jmxRemoteAuthentication": false,
"jmxRemotePort": 6005,
"jmxRemoteSsl": false,
"preferIpv4Stack": true,
"retryHttpPost": false
},
"shouldRestartRuntime": "true",
"customRuntimeProperties": {
"com.boomi.container.is.orchestrated.container": "true",
"com.boomi.container.cloudlet.findInitialHostsTimeout": "5",
"com.boomi.container.enableUI": "false",
"com.boomi.container.metrics.enabled": "false",
"com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate": "true"
},
"customSystemProperties": {
"property": [
"-Dcom.sun.management.jmxremote",
"-Dcom.sun.management.jmxremote.local.only=true",
"-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeProperties"
},
"example": "\n\n \n \n \n \n \n \n \n \n \n \n -Dcom.sun.management.jmxremote \n -Dcom.sun.management.jmxremote.local.only=\"false\" \n -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 \n \n "
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RuntimeProperties"
},
"example": {
"@type": "RuntimeProperties",
"standardProperties": {
"@type": "standardProperties",
"containerName": "cloud_cluster2",
"containerHostName": "cloud_cluster2",
"containerPurgeImmediately": false,
"containerPurgeDays": 38,
"containerForceRestart": 0,
"debugLogging": true,
"standardOutputAndErrorLogging": true,
"forceStartSharedWebServer": true,
"useLocalStorageForRuntimeAssets": false,
"workingDataLocalStorageDirectory": "/opt/boomi/local",
"clusterNetworkTransportType": "UNICAST"
},
"systemProperties": {
"@type": "systemProperties",
"heapSize": "514m",
"clientDefaultConnectTimeout": 120002,
"clientDefaultReadTimeout": 120000,
"javaClassPathPrepend": "/usr/lib/jvm/java-11-amazon-corretto/lib/tools.jar",
"javaSecurityCompatibility": "JVM_DEFINED",
"jgroupsClusteredLibraryVersion": 3,
"jmxRemoteAuthentication": false,
"jmxRemotePort": 6005,
"jmxRemoteSsl": false,
"preferIpv4Stack": true,
"retryHttpPost": false
},
"runtimeId": "edfbe7a2-8ffa-4079-84b3-3f469c5ee8e5",
"partialUpdate": true,
"customRuntimeProperties": {
"@type": "customRuntimeProperties",
"com.boomi.container.is.orchestrated.container": "true",
"com.boomi.container.cloudlet.findInitialHostsTimeout": "5",
"com.boomi.container.enableUI": "false",
"com.boomi.container.metrics.enabled": "false",
"com.boomi.container.enableRuntimeRestartOnRuntimePropsUpdate": "true"
},
"customSystemProperties": {
"@type": "customSystemProperties",
"property": [
"-Dcom.sun.management.jmxremote",
"-Dcom.sun.management.jmxremote.local.only=true",
"-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"
]
}
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/RuntimeProperties"
},
"example": "\n\n \n \n \n \n \n \n \n \n \n \n -Dcom.sun.management.jmxremote \n -Dcom.sun.management.jmxremote.local.only=\"false\" \n -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 \n \n "
}
}
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
},
"503": {
"$ref": "#/components/responses/503"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/cancelExecution/{executionId}": {
"post": {
"tags": [
"cancelExecution"
],
"operationId": "cancelExecutionOperation",
"summary": "cancelExecution operation",
"description": "To perform a cancelExecution operation, send an HTTP POST to: \n\n`https://api.boomi.com/api/rest/v1/{accountId}/cancelExecution/{executionId}` \n\nwhere `accountId` is the user's account ID and `executionId` is the ID of the process running on a runtime.\n\nA successful cancelExecution call returns an HTTP status code of 202. An error message appears if you cannot cancel the run because the runtime is not running.",
"parameters": [
{
"name": "executionId",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A unique identifier assigned by the system to a running process"
}
],
"responses": {
"202": {
"description": "Successful request and response.",
"content": {
"application/json": {
"example": {
"message": "Operation completed successfully."
}
},
"application/xml": {
"example": "Operation completed successfully. \n \n \n userAccount \n \n 764086051850-6qr4p6gpi6hn506pt8ejuq83di341hur.apps.googleusercontent.com \n d-FL95Q19q7MQmFpd7hHD0Ty \n 1//0gydbEBHiafWiCgYIARAAGBASNwF-L9Ir-zIPptU6w338h3YSH0p3PS89gNKfVmF1GQTll9jzrFQP9wv5YkRG892KHp0JHUQEEtk \n \n \n \n "
},
"GCPserviceAccount": {
"value": " \n\n \n \n serviceAccount \n \n boomi-appsec-sandbox \n 232312401554433 \n 3bb64a3a4989586b1846534ehehe \n BEGIN PRIVATE KEY \n target-sa@boomi-appsec-sandbox.iam.gserviceaccount.com \n \n \n \n "
},
"AWS": {
"value": " \n\n \n \n AKIAIOSFODNN7EXAMPLE \n 232312401554433 \n us-east-1 \n \n \n "
},
"Azure": {
"value": " \n\n \n \n a4c2469b-cf84-4145-8f5f-cb7bacf814bc \n 7f58f645-c190-4ce5-9de4-e2b7acd2a6ab \n nWu9HVZ7Rnj.2y7XSkVyUngZ][x9Z:e \n \n \n "
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentSecretsConfigurationResponse"
},
"example": {
"@type": "CloudAttachmentSecretsConfigurationResponse",
"statusCode": 200,
"message": " secrets configuration sent successfully to cloud attachment b6fd12be-e165-4589-8f96-169913171e79"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentSecretsConfigurationResponse"
},
"example": " secrets configuration sent successfully to cloud attachment b6fd12be-e165-4589-8f96-169913171e79\"/>"
}
}
},
"503": {
"$ref": "#/components/responses/503"
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/CloudAttachmentProperties/{id}": {
"get": {
"tags": [
"CloudAttachmentProperties"
],
"description": "Retrieves the details of cloud attachment properties of a specific runtime. Retrieving cloud attachment properties is an asynchronous process:\n1. Send a GET request that specifies both the account ID and runtime ID to the Boomi Enterprise Platform. `https://api.boomi.com/api/rest/v1/{accountId}/async/CloudAttachmentProperties/{id}`. \nThe `accountId` is the ID of the authenticating account for the request, and `id` is the runtime ID.\n2. The platform returns a token.\n3. Send one or more GET requests that include the token. `https://api.boomi.com/api/rest/v1/{accountId}/async/CloudAttachmentProperties/response/{token}`\n4. The platform returns a list of the cloud attachment properties associated with the specific runtime.\n>**Note:** The runtime that you are calling must be online.",
"summary": "Retrieves a CloudAttachmentProperties object by identifier",
"operationId": "AsyncGetCloudAttachmentProperties",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Read-only. System-generated unique identifier of a runtime. To view the runtime ID in the UI, go to **Manage > Runtime Management**.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": {
"@type": "AsyncOperationTokenResult",
"asyncToken": {
"@type": "AsyncToken",
"token": "CloudAttachmentProperties-1f23456f-a78f-91cc-012e-3e4dec5b67d8"
},
"responseStatusCode": 202
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/AsyncOperationTokenResult"
},
"example": "\n\n \n "
}
}
},
"503": {
"$ref": "#/components/responses/503"
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/async/CloudAttachmentProperties/response/{token}": {
"get": {
"tags": [
"CloudAttachmentProperties"
],
"description": "Use the token received from the initial GET request to retrieve the cloud attachment properties.",
"summary": "Retrieves a CloudAttachmentProperties object by token",
"operationId": "AsyncTokenCloudAttachmentProperties",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Takes in the token from a previous call to return a result.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentPropertiesAsyncResponse"
},
"example": {
"@type": "AsyncOperationResult",
"result": [
{
"@type": "CloudAttachmentProperties",
"runtimeId": "7ee105f7-6a9e-4b62-b383-3f6f3121ffc0",
"defaultTimeZoneForAccountSchedules": "IST",
"containerName": "Cloud_attachment_1",
"containerPurgeImmediately": false,
"containerPurgeDays": 45,
"archiveProcessedDocuments": true,
"lowLatencyWarningThreshold": 4,
"purgeScheduleForComponents": 7,
"purgeScheduleForLogs": 20,
"purgeScheduleForProcessedDocuments": 4,
"purgeScheduleForTemporaryData": 1
}
],
"responseStatusCode": 200
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentPropertiesAsyncResponse"
},
"example": "\n\n \n "
}
}
},
"503": {
"$ref": "#/components/responses/503"
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/CloudAttachmentProperties/{id}": {
"post": {
"tags": [
"CloudAttachmentProperties"
],
"description": "Adds, removes, or updates cloud attachment properties for a specific runtime. The update operation includes the optional flag, `partialUpdate`.\nBy default, it is set to `false`:\n- If set to `true`, only the property values specified in the request get updated. All other existing properties within the runtime will remain unchanged.\n- If set to `false`, property values specified in the request get updated. However, other property values not included in the request are reset to their default values.\n>**Note:** To reset a property to its default value in the `account.properties` file, set partialUpdate to `false` without including the property values in the request.",
"summary": "Modifies or updates a CloudAttachmentProperties object",
"operationId": "UpdateCloudAttachmentProperties",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Read-only. System-generated unique identifier of a runtime. To view the runtime ID in the UI, go to **Manage > Runtime Management**.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentProperties"
},
"example": {
"partialUpdate": true,
"runtimeId": "7ee105f7-6a9e-4b62-b383-3f6f3121ffc0",
"containerName": "Cloud_attachment_1",
"containerPurgeImmediately": false,
"containerPurgeDays": 46,
"defaultTimeZoneForAccountSchedules": "IST"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentProperties"
},
"example": "\n"
}
},
"required": false
},
"responses": {
"200": {
"description": "Successful request and response.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentProperties"
},
"example": {
"@type": "CloudAttachmentProperties",
"runtimeId": "7ee105f7-6a9e-4b62-b383-3f6f3121ffc0",
"defaultTimeZoneForAccountSchedules": "IST",
"containerName": "Cloud_attachment_1",
"containerPurgeImmediately": false,
"containerPurgeDays": 46
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CloudAttachmentProperties"
},
"example": "\n"
}
}
},
"503": {
"$ref": "#/components/responses/503"
},
"403": {
"$ref": "#/components/responses/403"
},
"410": {
"$ref": "#/components/responses/410"
}
},
"security": [
{
"basicAuth": []
}
]
}
}
},
"components": {
"schemas": {
"AS2BasicAuthInfo": {
"type": "object",
"properties": {
"password": {
"type": "string",
"xml": {
"attribute": true
}
},
"user": {
"type": "string",
"xml": {
"attribute": true
}
}
}
},
"AS2CommunicationOptions": {
"type": "object",
"properties": {
"AS2DefaultPartnerSettings": {
"$ref": "#/components/schemas/AS2SendSettings"
},
"AS2ReceiveOptions": {
"$ref": "#/components/schemas/AS2ReceiveOptions"
},
"AS2SendOptions": {
"$ref": "#/components/schemas/AS2SendOptions"
},
"AS2SendSettings": {
"$ref": "#/components/schemas/AS2SendSettings"
},
"CommunicationSetting": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"default",
"custom",
"component"
]
},
"SharedCommunicationChannel": {
"$ref": "#/components/schemas/SharedCommunicationChannel"
}
}
},
"AS2ConnectorRecord": {
"required": [
"account",
"actionType",
"atomId",
"connectorName",
"connectorType",
"customFields",
"dateProcessed",
"errorMessage",
"executionId",
"id",
"operationName"
],
"type": "object",
"properties": {
"account": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The ID of the account this record was run in.",
"example": "account-123456"
},
"ackStatus": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The acknowledgment status — Acknowledged, Acknowledged/Errors, or Not Acknowledged.",
"example": "Acknowledged"
},
"actionType": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The type of action with which this record corresponds — Listen or Send.",
"example": "Send"
},
"as2FromId": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The arbitrary identifier that indicates the sender of the message.",
"example": "DASHER"
},
"as2ToId": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The arbitrary identifier that indicates the recipient of the message.",
"example": "DANCER"
},
"atomId": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The ID of the Runtime that processed this record.",
"example": "3456789a-bcde-f012-3456-789abcdef012"
},
"connectorName": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "For an AS2 Client \\(Send\\) operation, the value is the name of the AS2 Client connection component through which the document that corresponds to this record was sent. The value is as2sharedserver Connector for an AS2 Shared Server \\(Listen\\) operation, Trading Partner for an X12 trading partner Send operation, or Start for an X12 trading partner Listen operation.",
"example": "Sample AS2 Connection"
},
"connectorType": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The type of connector to which this record corresponds — as2 for AS2 Client \\(Send\\), as2sharedserver for AS2 Shared Server \\(Listen\\), or x12 for Trading Partner Send or Listen using the X12 standard.",
"example": "as2"
},
"contentLength": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The length of the message in bytes.",
"example": "484"
},
"customFields": {
"$ref": "#/components/schemas/customFields"
},
"dateProcessed": {
"type": "string",
"format": "date-time",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The processing date and time of this record.",
"example": "2018-07-11T06:24:12Z"
},
"documentIndex": {
"type": "integer",
"format": "int32",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The numerical index of this record in the run.",
"example": "0"
},
"errorMessage": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The error message associated with this record if applicable."
},
"executionId": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The ID of the run.",
"example": "execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11"
},
"filename": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The file name of the document that corresponds to this record.",
"example": "0000000122518.dat"
},
"id": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The ID of this record.",
"example": "connector-bcdef012-3456-789a-bcde-f0123456789a"
},
"mdnMessage": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The content of the Message Delivery Notification \\(MDN\\) message — *processed*, *processed/error*, *processed/error:* *authentication-failed*, *processed/error: decompression-failed*, or *processed/error: decryption-failed*. In a Listen action by the AS2 shared server, an MDN message generates automatically. For a Send action, generating an MDN message is an option for the processing AS2 Client operation.",
"example": "processed"
},
"messageId": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The arbitrary identifier for the message.",
"example": "<976473487.15.1527087239460.JavaMail.dashernorthpole>"
},
"mimetype": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The MIME type of the message — *text/plain*, *application/binary*, *application/edifact*, *application/octet-stream*, *application/edi-x12*, or *application/xml*",
"example": "application/octet-stream"
},
"operationName": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The name of the operation component that processed this record. The component is an AS2 Client operation in the case of a Send action or an AS2 Shared Server operation in the case of a Listen action.",
"example": "Sample AS2 Operation"
},
"size": {
"type": "integer",
"format": "int64",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The size, in bytes, of the document that corresponds to this record.",
"example": "654"
},
"subject": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "The arbitrary subject name for the message.",
"example": "Sleigh Order 122518"
},
"successful": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "Whether the record is a success or error.",
"example": "true"
}
}
},
"AS2ConnectorRecordExpression": {
"oneOf": [
{
"$ref": "#/components/schemas/AS2ConnectorRecordSimpleExpression"
},
{
"$ref": "#/components/schemas/AS2ConnectorRecordGroupingExpression"
}
]
},
"AS2ConnectorRecordGroupingExpression": {
"required": [
"operator"
],
"type": "object",
"properties": {
"nestedExpression": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"$ref": "#/components/schemas/AS2ConnectorRecordExpression"
}
},
"operator": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"and",
"or"
]
}
},
"content": {
"application/json": {
"examples": {
"jsonExample": {
"summary": "Grouping Expression in JSON",
"value": {
"operator": "and",
"nestedExpression": [
{
"operator": "EQUALS",
"property": "executionId",
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11"
]
},
{
"operator": "EQUALS",
"property": "as2FromId",
"argument": [
"DASHER"
]
}
]
}
}
}
}
},
"xml": {
"name": "GroupingExpression",
"namespace": "http://api.platform.boomi.com/"
}
},
"AS2ConnectorRecordQueryConfig": {
"required": [
"QueryFilter"
],
"type": "object",
"properties": {
"QueryFilter": {
"required": [
"expression"
],
"type": "object",
"properties": {
"expression": {
"$ref": "#/components/schemas/AS2ConnectorRecordExpression"
}
},
"xml": {
"name": "QueryFilter",
"namespace": "http://api.platform.boomi.com/"
}
}
},
"xml": {
"name": "QueryConfig",
"namespace": "http://api.platform.boomi.com/"
}
},
"AS2ConnectorRecordQueryResponse": {
"type": "object",
"properties": {
"numberOfResults": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"queryToken": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request."
},
"result": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"$ref": "#/components/schemas/AS2ConnectorRecord"
}
}
},
"xml": {
"name": "QueryResult",
"namespace": "http://api.platform.boomi.com/"
}
},
"AS2ConnectorRecordSimpleExpression": {
"required": [
"operator",
"property"
],
"type": "object",
"properties": {
"argument": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"type": "string",
"xml": {
"name": "argument"
}
}
},
"operator": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"EQUALS",
"STARTS_WITH",
"BETWEEN",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL",
"LESS_THAN",
"LESS_THAN_OR_EQUAL"
]
},
"property": {
"type": "string",
"xml": {
"attribute": true
}
}
},
"content": {
"application/json": {
"examples": {
"jsonExample": {
"summary": "Simple Expression in JSON",
"value": {
"operator": "EQUALS",
"property": "executionId",
"argument": [
"execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11"
]
}
}
}
},
"application/xml": {
"examples": {
"xmlExample": {
"summary": "Simple Expression in XML",
"value": "\n execution-01234567-89ab-cdef-0123-456789abcdef-2018.07.11 \n "
}
}
}
},
"xml": {
"name": "SimpleExpression",
"namespace": "http://api.platform.boomi.com/"
}
},
"AS2MDNOptions": {
"required": [
"externalURL",
"mdnClientSSLCert",
"mdnSSLCert"
],
"type": "object",
"properties": {
"externalURL": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"mdnClientSSLCert": {
"$ref": "#/components/schemas/PrivateCertificate"
},
"mdnDigestAlg": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512"
]
},
"mdnSSLCert": {
"$ref": "#/components/schemas/PublicCertificate"
},
"requestMDN": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"signed": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"synchronous": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"sync",
"async"
]
},
"useExternalURL": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"useSSL": {
"type": "boolean",
"xml": {
"attribute": true
}
}
}
},
"AS2MessageOptions": {
"required": [
"subject"
],
"type": "object",
"properties": {
"attachmentCache": {
"type": "string",
"xml": {
"attribute": true
}
},
"attachmentOption": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"BATCH",
"DOCUMENT_CACHE"
]
},
"compressed": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"dataContentType": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"textplain",
"binary",
"edifact",
"edix12",
"applicationxml",
"textxml"
]
},
"encrypted": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"encryptionAlgorithm": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"na",
"tripledes",
"des",
"rc2-128",
"rc2-64",
"rc2-40",
"aes-128",
"aes-192",
"aes-256"
]
},
"maxDocumentCount": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"multipleAttachments": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"signed": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"signingDigestAlg": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512"
]
},
"subject": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
}
}
},
"AS2MyCompanyInfo": {
"required": [
"as2Id",
"encryptionPrivateCertificate",
"mdnSignaturePrivateCertificate",
"signingPrivateCertificate"
],
"type": "object",
"properties": {
"as2Id": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"enabledFoldedHeaders": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "When `true`, outbound messages use folded headers. The default value is `false`.",
"example": false
},
"enabledLegacySMIME": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"encryptionPrivateCertificate": {
"$ref": "#/components/schemas/PrivateCertificate"
},
"mdnSignaturePrivateCertificate": {
"$ref": "#/components/schemas/PrivateCertificate"
},
"signingPrivateCertificate": {
"$ref": "#/components/schemas/PrivateCertificate"
}
}
},
"AS2PartnerInfo": {
"required": [
"as2Id",
"clientSSLCertificate",
"encryptionPublicCertificate",
"mdnSignaturePublicCertificate",
"signingPublicCertificate"
],
"type": "object",
"properties": {
"ListenAttachmentSettings": {
"$ref": "#/components/schemas/AttachmentInfo"
},
"ListenAuthSettings": {
"$ref": "#/components/schemas/AS2BasicAuthInfo"
},
"as2Id": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"basicAuthEnabled": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"default": false
},
"clientSSLCertificate": {
"$ref": "#/components/schemas/PublicCertificate"
},
"enabledFoldedHeaders": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "When `true`, outbound messages use folded headers. The default value is `false`.",
"example": false
},
"enabledLegacySMIME": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"encryptionPublicCertificate": {
"$ref": "#/components/schemas/PublicCertificate"
},
"mdnSignaturePublicCertificate": {
"$ref": "#/components/schemas/PublicCertificate"
},
"messagesToCheckForDuplicates": {
"type": "integer",
"format": "int32",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"rejectDuplicateMessages": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"signingPublicCertificate": {
"$ref": "#/components/schemas/PublicCertificate"
},
"requireEncryptedMessages": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "Indicates whether incoming AS2 messages must be encrypted for this communication channel. If not specified, the value defaults to `true` for **CREATE** operations and `false` for **UPDATE** operations. If an invalid value is provided, it is treated as not specified. Values consisting of a single character or starting with “f” are interpreted as `false`."
},
"requireSignedMessages": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "Indicates whether incoming AS2 messages must be signed for this communication channel. If not specified, the value defaults to `true` for **CREATE** operations and `false` for **UPDATE** operations. If an invalid value is provided, it is treated as not specified. Values consisting of a single character or starting with “f” are interpreted as `false`."
}
}
},
"AS2ReceiveOptions": {
"required": [
"AS2DefaultPartnerInfo",
"AS2DefaultPartnerMDNOptions",
"AS2DefaultPartnerMessageOptions",
"AS2MyCompanyInfo"
],
"type": "object",
"properties": {
"AS2DefaultPartnerInfo": {
"$ref": "#/components/schemas/AS2PartnerInfo"
},
"AS2DefaultPartnerMDNOptions": {
"$ref": "#/components/schemas/AS2MDNOptions"
},
"AS2DefaultPartnerMessageOptions": {
"$ref": "#/components/schemas/AS2MessageOptions"
},
"AS2MyCompanyInfo": {
"$ref": "#/components/schemas/AS2MyCompanyInfo"
}
}
},
"AS2SendOptions": {
"required": [
"AS2MDNOptions",
"AS2MessageOptions"
],
"type": "object",
"properties": {
"AS2MDNOptions": {
"$ref": "#/components/schemas/AS2MDNOptions"
},
"AS2MessageOptions": {
"$ref": "#/components/schemas/AS2MessageOptions"
},
"AS2PartnerInfo": {
"$ref": "#/components/schemas/AS2PartnerInfo"
}
}
},
"AS2SendSettings": {
"required": [
"clientSSLCertificate",
"sslCertificate",
"url"
],
"type": "object",
"properties": {
"AuthSettings": {
"$ref": "#/components/schemas/AS2BasicAuthInfo"
},
"authenticationType": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"NONE",
"BASIC"
]
},
"clientSSLCertificate": {
"$ref": "#/components/schemas/PrivateCertificate"
},
"sslCertificate": {
"$ref": "#/components/schemas/PublicCertificate"
},
"url": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
}
},
"useDefaultSettings": {
"type": "boolean",
"xml": {
"attribute": true
}
},
"verifyHostname": {
"type": "boolean",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"default": false
}
}
},
"Account": {
"type": "object",
"properties": {
"accountId": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The ID of the account.",
"example": "boomiqa-T7KIDU"
},
"dateCreated": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The creation date of the account.",
"example": "2022-09-02T20:16:28Z"
},
"expirationDate": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The scheduled expiration date of the account."
},
"licensing": {
"$ref": "#/components/schemas/Licensing",
"description": "Indicates the number of connections used and purchased in each of the connector type and production/test classifications. The classifications include standard, smallBusiness, enterprise, and tradingPartner."
},
"molecule": {
"$ref": "#/components/schemas/Molecule"
},
"name": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The name of the account.",
"example": "BoomiQA"
},
"overDeployed": {
"type": "boolean",
"xml": {
"attribute": true
},
"description": "Indicates the state of an account if one or more additional deployments are made after all available connection licenses have been used for any of the connector class."
},
"status": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"trial",
"active",
"suspended",
"deleted",
"unlimited"
],
"description": "The status of the account. The allowed values are active or deleted.",
"example": "active"
},
"suggestionsEnabled": {
"type": "boolean",
"xml": {
"attribute": true
},
"description": "Identifies whether this account has the Boomi Suggest feature enabled."
},
"supportAccess": {
"type": "boolean",
"xml": {
"attribute": true
},
"description": "Identifies whether this account allows support user access.",
"example": "true"
},
"supportLevel": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"standard",
"premier"
],
"description": "The level of support for this account. The allowed values are standard *or premier.",
"example": "standard"
},
"widgetAccount": {
"type": "boolean",
"xml": {
"attribute": true
},
"example": "false"
}
}
},
"AccountBulkRequest": {
"type": "object",
"properties": {
"request": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"$ref": "#/components/schemas/BulkId"
}
},
"type": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"GET",
"DELETE",
"UPDATE",
"CREATE"
]
}
},
"xml": {
"name": "BulkRequest",
"namespace": "http://api.platform.boomi.com/"
}
},
"AccountBulkResponse": {
"type": "object",
"properties": {
"response": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"required": [
"Result"
],
"type": "object",
"properties": {
"Result": {
"$ref": "#/components/schemas/Account"
},
"index": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"id": {
"type": "string",
"xml": {
"attribute": true
}
},
"statusCode": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"errorMessage": {
"type": "string",
"xml": {
"attribute": true
}
}
}
}
}
},
"xml": {
"name": "BulkResult",
"namespace": "http://api.platform.boomi.com/"
}
},
"AccountCloudAttachmentProperties": {
"type": "object",
"properties": {
"accountDiskUsage": {
"type": "integer",
"format": "int64",
"xml": {
"attribute": true
},
"description": "Represented in bytes, this property sets the size limit for an account that uses the private Runtime cloud."
},
"as2Workload": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"GENERAL",
"LOW_LATENCY_DEBUG"
],
"description": "Used to select the process run mode for AS2 listener processes.Accepted values: Possible values: \n\n When the runtime status is ONLINE: \n\n - ONLINE_RUNNING \n - ONLINE_STOPPING \n - ONLINE_STARTING \n - CLUSTER_ISSUE \n - RESTARTING \n - RESTARTING_TOO_LONG \n - RESTARTING_DEAD \n\n When the runtime status is OFFLINE: \n\n - OFFLINE \n - OFFLINE_NOT_STOPPED \n - OFFLINE_NOT_INITIALIZED \n - OFFLINE_WITH_ERROR \n - OFFLINE_WITH_CLUSTER_ISSUE \n - DELETED \n - OFFBOARDING \n\n When the runtime status is WARNING: CLUSTER_ISSUE \n\n When the runtime status is UNKNOWN: UNKNOWN \n\n "
}
}
},
"AtomAS2Artifacts": {
"type": "object",
"properties": {
"atomId": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The ID of the Runtime.",
"example": "3456789a-bcde-f012-3456-789abcdef012"
},
"logDate": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The date of the logged events.",
"example": "2016-02-05"
}
}
},
"AtomBulkRequest": {
"type": "object",
"properties": {
"request": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"$ref": "#/components/schemas/BulkId"
}
},
"type": {
"type": "string",
"xml": {
"attribute": true
},
"enum": [
"GET",
"DELETE",
"UPDATE",
"CREATE"
]
}
},
"xml": {
"name": "BulkRequest",
"namespace": "http://api.platform.boomi.com/"
}
},
"AtomBulkResponse": {
"type": "object",
"properties": {
"response": {
"type": "array",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"items": {
"required": [
"Result"
],
"type": "object",
"properties": {
"Result": {
"$ref": "#/components/schemas/Atom"
},
"index": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"id": {
"type": "string",
"xml": {
"attribute": true
}
},
"statusCode": {
"type": "integer",
"format": "int32",
"xml": {
"attribute": true
}
},
"errorMessage": {
"type": "string",
"xml": {
"attribute": true
}
}
}
}
}
},
"xml": {
"name": "BulkResult",
"namespace": "http://api.platform.boomi.com/"
}
},
"AtomConnectionFieldExtensionSummary": {
"required": [
"field"
],
"type": "object",
"properties": {
"atomId": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The ID of the Runtime.",
"example": "3456789a-bcde-f0123-4567-89abcdef012"
},
"connectionId": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The ID of the connection.",
"example": "bcdef012-3456-789a-bcde-f0123456789a"
},
"extensionGroupId": {
"type": "string",
"xml": {
"attribute": true
},
"description": "If the process is in a multi-install integration pack, this is the ID of the multi-install integration pack, which is the same as the ID of the process.",
"example": ""
},
"field": {
"$ref": "#/components/schemas/FieldSummary",
"description": "The extensions template for the OAuth 2.0 accessToken field is a superset of the standard connection field template. There is one additional field: oauth2AuthorizationUrl. The oauth2AuthorizationUrl value is the URL for manually generating the access token."
},
"id": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The ID of the object. This is a conceptual ID synthesized from the IDs of the1 Your packaged components were successfully deployed. You have exceeded the usage count in your current connection licenses by 15. Contact a Boomi representative to purchase a higher connection licenses count. ```"
},
"notes": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "(Valid in request body) Notes that describe the deployment."
},
"packageId": {
"type": "string",
"xml": {
"namespace": "http://api.platform.boomi.com/"
},
"description": "(Valid in request body) The ID of the packaged component. You can use `packageId` to deploy an existing packaged component. The packaged component ID is available from the: Connector Operation.`` > Gateway Information panel.\n\n3. Use the Broker ID found in the user interface by navigating to **Configure Server** > **Authentication** > `` > Broker Information panel.",
"example": "3456789a-bcde-f012-3456-789abcdef012"
}
}
},
"JavaUpgrade": {
"type": "object",
"properties": {
"JavaUpgradeOptions": {
"$ref": "#/components/schemas/JavaUpgradeOptions",
"example": {
"migrateCertificate": "true",
"cacertsPath": "/boomi_atom/jre",
"externalJDKPath": "/usr/java/latest",
"prefJreLocation": "external"
}
},
"atomId": {
"type": "string",
"xml": {
"attribute": true
},
"description": "The unique ID assigned by the system to the containerAccess denied due to insufficient permissions. Endpoint is invalid or no longer exists. The Boomi server is currently unavailable or your account's rate limits have been exceeded. Retry later.