{ "openapi": "3.0.3", "info": { "title": "Boomi Enterprise Platform Connector APIs", "description": "Download OpenAPI Specification: Download \n\n ## Introduction \n The Boomi Enterprise Platform Connector APIs allows for management and deployment of integration connectors associated with your account. These APIs are developed with a RESTish implementation around an object/verb hierarchy. This hierarchy parallels the web service implementation behind REST. Within the API, objects represent structures and relationships within Boomi Connectivity Administration.\n ### Connector Deployment API\nThe Connector Deployment API provides programmatic access to deploy any connector that was created using the Boomi Software Development Kit (SDK). \n ### Connector Management API\nThe API provides programmatic access to connector administration functionality that is normally accessed through the **Developer** tab. \n ## Access Requirements\nAll Connector Deployment API calls are authenticated by your account ID. The account ID is used as the general context for any Connector Deployment API call.\n\n Ensure that you have:\n\n * The signed [SDK Publisher Agreement](/docs/Connectors/ConnectorDevelopmentReference/Entering_connector_publisher_information) \n\n * DEVELOPER privilege \n\n Furthermore, the authenticated user for all Connector Deployment API requests must have the API Access privilege. Requests for some operations require additional privileges and are noted in the individual topics for those operations.\n\n A few error scenarios: \n * [403 (Forbidden) HTTP Response](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4) - If an API request does not provide the correct credentials or there is an invalid account ID.\n\n * [400 (Bad Request) HTTP Response](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) - If the authenticating user for a particular API request does not have the required privileges.", "contact": { "name": "Customer Support", "url": "https://community.boomi.com/s/support", "email": "support@boomi.com" }, "license": { "name": "Boomi API License", "url": "/docs/GettingStarted/API_licensing" }, "version": "1.0.0" }, "servers": [ { "url": "https://api.boomi.com/connector/api/rest/v1/{accountId}", "description": "US - Boomi Connector API Endpoint URL. {accountId} is the Account ID of the authenticated account making this request.", "variables": { "accountId": { "description": "The Account ID of the authenticated account making this request", "default": "%7BaccountId%7D" } } }, { "url": "https://api.platform.gb.boomi.com/connector/api/rest/v1/{accountId}", "description": "GB - Boomi Connector API Endpoint URL.", "variables": { "accountId": { "description": "The Account ID of the authenticated account making this request", "default": "%7BaccountId%7D" } } } ], "tags": [ { "name": "Connector Group", "description": "A connector group is a collection of versioned connectors, which enables the connection of processes with a particular application. You can assign same versions to multiple connectors within a connector group." }, { "name": "Connector Classification", "description": "A connector classification is the actual connector you would use within the platform. You can have many classifications within a connector group, however, the label has to be different for each classification. For example, dev, uat, or prod." }, { "name": "Connector Version", "description": "Upload a new version of the connector group provided as one of the input data. \n\n >**Note:** There is a maximum of 1500 connector versions available for each account." }, { "name": "Connector Archive", "description": "Autoconfigure an entire connector - connector group, classification, and version - by a single upload of a connector archive. The connector built this way can be directly used in the build tab as part of processes. \n\n ### Features and Privileges \n\n In addition to the developer privilege and the SDK publisher agreement, ensure that you have: \n\n * CONNECTOR_ADMINISTRATION feature — Controls the CONNECTOR_SUBMISSION privilege \n\n * CONNECTOR_SUBMISSION privilege — Required to autoconfigure a connector from a connector archive." }, { "name": "Connector Descriptor Validation", "description": "Validate the descriptor for a connector to ensure that it is syntactically valid and fix issues, if any, prior to using the descriptor in an upload. \n\n ### Features and Privileges \n\n In addition to the developer privilege and the SDK publisher agreement, ensure that you have: \n\n * CONNECTOR_ADMINISTRATION feature — Controls the CONNECTOR_SUBMISSION privilege \n\n * CONNECTOR_SUBMISSION privilege — Required to autoconfigure a connector from a connector archive." }, { "name": "Connector Version Review", "description": "Submit a connector version review request. \n\n ### Features and Privileges \n\n In addition to the developer privilege and the SDK publisher agreement, ensure that you have: \n\n * CONNECTOR_ADMINISTRATION feature — Controls the CONNECTOR_SUBMISSION privilege \n\n * CONNECTOR_SUBMISSION privilege — Required to autoconfigure a connector from a connector archive." }, { "name": "Connector Version Query" }, { "name": "Connector Version Change", "description": "Change the version of a PRIVATE connector or submit a version approval request for PUBLIC connectors. \n\n >**Note:** For scheduled connector version change requests done via the API for private connectors, the release of the pending version occurs once every hour. \n\n ### Features and Privileges \n\n Ensure that you have : \n\n * DEVELOPER and API privileges for PRIVATE connectors. \n\n * CONNECTOR_ADMINISTRATION feature and the CONNECTOR_SUBMISSION privilege, in addition to the DEVELOPER and API privileges, for PUBLIC connectors." }, { "name": "Connector Pending Release", "description": "Cancel a pending release for either PUBLIC or PRIVATE classifications. \n\n ### Features and Privilegs \n\n * To cancel a pending release using this API, the account that would like to submit this request must have the SDK Publisher Agreement signed. \n\n * If you want to cancel a PRIVATE connector for a pending release, you need the DEVELOPER privilege on the account. \n\n * To cancel a PUBLIC connector for a pending release and if you are the owner of the account, you need to have the CONNECTOR_SUBMISSION feature. \n\n * To cancel a PUBLIC connector for a pending release and if you are NOT the owner of the account, you need to have the CONNECTOR_ADMINISTRATION feature. " }, { "name": "Connector Visibility", "description": "Submit a connector visibility change request and ask to review the visibility change of your connector. \n\n ### Features and Privileges \n\n Ensure that you have : \n\n * DEVELOPER and API privileges for visibility changes from PRIVATE to HIDDEN\n\n * CONNECTOR_ADMINISTRATION feature and the CONNECTOR_SUBMISSION privilege, in addition to the DEVELOPER and API privileges, for visibility changes from PRIVATE to PUBLIC or PUBLIC to HIDDEN" }, { "name": "Connector Icon", "description": "Create or update a connector icon for an existing connector classification type. \n\n ### Prerequisites \n\n Before submitting a request to create or update an existing connector icon with this API, you must verify the following to ensure the request is successful: \n\n - The user submitting the request has the correct features and privileges. \n - The account that is submitting the request has signed the Connector SDK Agreement and the account's publisher information exists on the Publisher tab. To learn more, refer to [Publisher tab](/docs/Connectors/ConnectorDevelopmentReference/Entering_connector_publisher_information). \n - The `connectorIcon` file size file cannot not be larger than 100KB. \n\n ### Features and privileges \n\n To create a connector icon for an existing connector type with this API, the following features and privileges (granted by your account administrator) are required to perform the ConnectorIcon operation: \n - `DEVELOPER` and `API` privileges - PRIVATE connectors only inside the requester's own account \n - `CONNECTOR_REVIEW`, `DEVELOPER` and `API` privileges - for any PUBLIC/PRIVATE/HIDDEN connectors in any account \n\n ### Troubleshooting \n If the API request is not successful, use the following information to help you troubleshoot: \n - If the publisher information is missing, an error occurs. To learn more, see Prerequisites in this topic. \n - If the connector for which you are submitting the request is not built against the Boomi Software Development Kit (SDK), an error occurs. \n - If the classificationType does not exist, an error occurs. \n - If the connector icon does not exist, an error occurs. \n - If the groupType is provided instead of the classificationType, an error occurs. \n - The SVG file structure is internally validated. The XML structure must start with Developer tab --> Connectors table_.", "schema": { "type": "string" }, "example": "accountID-sample-uat" } ], "responses": { "200": { "description": "Successful request and response" }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorDescriptorValidation/validate": { "post": { "tags": [ "Connector Descriptor Validation" ], "summary": "Validate a connector descriptor file", "description": "Use this operation to pre-emptively validate the descriptor for a connector to ensure that it is syntactically valid and fix issues, if any, prior to using the descriptor in an upload. \n\n This is a multipart form data request which takes one form data input with key `descriptor` and the value will be the `connector-descriptor.xml` file to be validated. \n\n **Sample error messages** \n\n Issue: Invalid Configuration \n - Only 1 field value condition is supported for visibility at this time on field with ID: conditionalField6. \n - Only 1 condition is supported for visibility at this time on field with ID: conditionalField5. \n - A conditionally visible field cannot be a type of oauth . (Field ID: conditionalField12). \n - The visibility condition for field conditionalField2 may only have the values true and false when referencing a boolean type field in the condition. \n - The visibility condition for field conditionalField2 may only have the values true and false when referencing a boolean type field in the condition. \n - The field with ID: valueField is involved in the visibility configuration rule for the field with ID: conditionalField, it must be of type boolean or have a list or radio display type. \n - The visibility condition configured on field with ID: conditionalField3 must point to an existing configured field. \n - The visibility condition value(s) you have provided for conditionalField22 is not in the allowed values for the referenced field with ID: valueField22. \n - A conditional visibility field cannot be referenced by another conditional visibility rule at this time. This is to prevent circular conditions. (Field ID: valueField7). \n - A conditionally visible field cannot be a type of wssecurity . (Field ID: conditionalField11). \n - A conditional visibility field cannot be referenced by another conditional visibility rule at this time. This is to prevent circular conditions. (Field ID: conditionalField7). \n - The visibility condition configured on field with ID: conditionalField5 must point to an existing configured field. \n - The field with ID: valueField1 is involved in the visibility configuration rule for the field with ID: conditionalField1, it must be of type boolean or have a list or radio display type. \n - The tracking direction for Listen operations is always response and cannot be changed. \n - QUERY operation is configured with supportsBrowse=true and supportsBrowse=false \n - The tracking direction for Listen operations is always response and cannot be changed. \n - Tracked Property with ID: outputProp already exists. You cannot specify a Tracked Group with the same ID: outputProp. \n\n **Sample warning message** \n\n Unsupported configuration: The browsingType attribute in GenericConnectorDescriptor is retired. This has been deprecated and browsing is performed using containers that are associated with the account. To continue, please remove the browsingType attribute from your descriptor file. \n ", "operationId": "CreateConnectorDescriptorValidation", "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorDescriptorValidation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorDescriptorValidation" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorGroup": { "post": { "tags": [ "Connector Group" ], "summary": "Create a connector group", "description": "Use this operation to create a shell of a connector, that is, a connector group and optionally create a connector classification, if classification details are provided in the request. A connector group is the parent shell that can hold multiple classifications and versions of that connector. You can optionally add vendor details via the API to be stored as part of the connector group.", "operationId": "CreateConnectorGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectorGroup" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateConnectorGroup" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectorGroupResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateConnectorGroupResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorGroup/{groupType}": { "get": { "tags": [ "Connector Group" ], "summary": "Retrieve a connector group", "description": "Use this operation to retrieve a connector group by providing the `connectorType` that is the unique type value for that connector. A connector group is the parent shell that can hold multiple classifications and versions of that connector. The response retrieved will contain information about the connector group along with its available classifications and versions, if any.", "operationId": "GetConnectorGroup", "parameters": [ { "name": "groupType", "in": "path", "required": true, "description": "`groupType` is the value of the _Type_ column of the _Boomi Enterprise Platform --> Developer tab --> Connectors table_ without the classification. \n For the connector-id, `accountId-connectorType-classification`, the connectorType value is `accountId-connectorType` after omitting the classification. \n\n For example, if the _Type_ column displays _accountID-sample-uat_, then the `groupType` will be _accountID-sample_.", "schema": { "type": "string" }, "example": "accountID-sample" } ], "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectorGroupResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateConnectorGroupResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Connector Group" ], "summary": "Delete a connector group", "operationId": "DeleteConnectorGroup", "description": "Use this operation to delete a connector group by providing the groupType that is the unique type value for that connector. A connector group is the parent shell that can hold multiple classifications and versions of that connector. In order for a connector group to be deleted the classifications within that group also need to be deleted. The response will be a true or false value indicating if the ConnectorGroup was successfully deleted.", "parameters": [ { "name": "groupType", "in": "path", "required": true, "description": "`groupType` is the value of the _Type_ column of the _Boomi Enterprise Platform --> Developer tab --> Connectors table_ without the classification. \n For the connector-id, `accountId-connectorType-classification`, the connectorType value is `accountId-connectorType` after omitting the classification. \n\n For example, if the _Type_ column displays _accountID-sample-uat_, then the `groupType` will be _accountID-sample_.", "schema": { "type": "string" }, "example": "accountID-sample" } ], "responses": { "200": { "description": "Successful request and response" }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorGroupQuery/query": { "post": { "tags": [ "Connector Group" ], "summary": "Retrieve connector groups with classifications", "description": "Use this operation to retrieve connector groups with their respective classifications. This API fetches less than or equal to the supported limit of 20 records.", "operationId": "QueryConnectorGroupQuery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorGroupQueryQueryConfig" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorGroupQueryQueryConfig" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorGroupQueryQueryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorGroupQueryQueryResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorGroupQuery/queryMore": { "post": { "tags": [ "Connector Group" ], "summary": "Retrieve additional results for connector groups with classifications", "description": "Use this operation to retrieve connector groups with their respective classifications. Use this API as a follow-up query for records beyond the first 20 records.", "operationId": "QueryMoreConnectorGroupQuery", "requestBody": { "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorGroupQueryQueryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorGroupQueryQueryResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorPendingRelease/cancelPendingRelease": { "post": { "tags": [ "Connector Pending Release" ], "summary": "Cancel a pending release for a public or private connector", "description": "Use this operation to cancel a pending release for either PUBLIC or PRIVATE classifications.", "operationId": "UpdateConnectorPendingRelease", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorPendingRelease" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorPendingRelease" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorPendingRelease" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorPendingRelease" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersion/upload": { "post": { "tags": [ "Connector Version" ], "summary": "Create a new connector version", "description": "Use this operation to upload a new version to an existing connector group. Creating a version using this API will attach this new version to the connector group provided as one of the input data. The request format is multipart and the following data inputs are all of the parts we require for the request: \n - `connectorVersionArchive` : The connector archive .zip file. \n - `groupType` : Text field for the connector group type. `groupType` is the value of the _Type_ column of the _Boomi Enterprise Platform --> Developer tab --> Connectors table_ without the classification. \n For the connector-id, `accountId-connectorType-classification`, the connectorType value is `accountId-connectorType` after omitting the classification. For example, if the _Type_ column displays _accountID-sample-uat_, then the `groupType` will be _accountID-sample_. \n - `changeLog` : (Optional) Text field to save any relevant description about the version being uploaded. \n - `sha256Checksum` : (Optional) Text field to provide a `sha256Checksum` to validate the integrity of the uploaded file.", "operationId": "CreateConnectorVersion", "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionDeleteResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionDeleteResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersion/delete": { "post": { "tags": [ "Connector Version" ], "summary": "Delete a connector version", "description": "Use this operation to delete a connector version by providing the `connectorGroupType`, which is the unique type value for the connector group that the connector version is associated with. A connector group is the parent shell that can hold multiple classifications and versions of that connector. You need to provide the versionId of the connector version that you want to delete. \n\n You can't delete a connector version if: \n\n * It is currently being used by any classification within the connector group \n\n * It has a review status of PENDING, APPROVED, or REJECTED.", "operationId": "DeleteConnectorVersion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionDelete" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionDelete" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response" }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersionChange": { "post": { "tags": [ "Connector Version Change" ], "summary": "Submit a connector version change request", "description": "Use this operation to change the version of a connector it if is PRIVATE. In addition, this API allows to submit a version approval request if the connector is PUBLIC.", "operationId": "CreateConnectorVersionChange", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChange" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChange" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChangeResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChangeResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersionChange/delete": { "post": { "tags": [ "Connector Version Change" ], "summary": "Cancel a pending connector version change request", "description": "Use this operation to cancel an existing connector version change request. This API should only be used for PUBLIC connectors that have submitted a connector version change request for review. If there is not any PENDING connector version change requests for the particular connector passed in the request body, an error will be thrown indicating that there is no pending request to cancel.", "operationId": "UpdateConnectorVersionChange", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChangeCancel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChangeCancel" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChangeCancelResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionChangeCancelResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersionQuery/query": { "post": { "tags": [ "Connector Version" ], "summary": "Retrieve connector versions", "description": "Use this operation to retrieve connector versions, upto 100 records", "operationId": "QueryConnectorVersionQuery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionQueryQueryConfig" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionQueryQueryConfig" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionQueryQueryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionQueryQueryResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersionQuery/queryMore": { "post": { "tags": [ "Connector Version" ], "summary": "Retrieve additional connector versions", "operationId": "QueryMoreConnectorVersionQuery", "description": "Use this operation to retrieve connector versions beyond first 100 records", "requestBody": { "content": { "text/plain": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionQueryQueryResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionQueryQueryResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersionReview": { "post": { "tags": [ "Connector Version Review" ], "summary": "Submit a connector version review request", "description": "Use this operation to submit a connector version review request to review a version of your connector code.", "operationId": "CreateConnectorVersionReview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReview" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReview" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReviewResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReviewResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVersionReview/delete": { "post": { "tags": [ "Connector Version Review" ], "summary": "Cancel a pending connector version review request", "description": "Use the ConnectorVersionReview object to cancel a pending connector version review request.", "operationId": "DeleteConnectorVersionReview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReview" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReview" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReviewResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVersionReviewResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVisibility": { "post": { "tags": [ "Connector Visibility" ], "summary": "Submit a connector visibility change request", "description": "Use the ConnectorVisibility operation to submit a connector visibility change request to change the visibility of your connector.", "operationId": "CreateConnectorVisibility", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVisibility" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVisibility" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVisibilityResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVisibilityResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorVisibility/delete": { "post": { "tags": [ "Connector Visibility" ], "summary": "Cancel a connector visibility change request", "description": "Use the ConnectorVisibility operation to cancel a pending connector visibility change request.", "operationId": "UpdateConnectorVisibility", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVisibilityCancel" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVisibilityCancel" } } }, "required": false }, "responses": { "200": { "description": "Successful request and response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorVisibilityCancelResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorVisibilityCancelResponse" } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorIcon/{classificationType}/upload": { "post": { "tags": [ "Connector Icon" ], "summary": "Create a new connector icon", "description": "Use this operation to upload a new connector icon to an existing connector type. Creating an icon using this API will update the existing connector icon to this new icon to the connector type provided as one of the input data. The request format is multipart and the following data inputs are all of the parts we require for the request: \n - `connectorIcon` : The connector icon .svg file. \n - `sha256Checksum` : (Optional) Text field to provide a `sha256Checksum` to validate the integrity of the uploaded file.", "operationId": "CreateConnectorIcon", "parameters": [ { "name": "classificationType", "in": "path", "required": true, "description": "classificationType is the value of the _Type_ column of the _Boomi Enterprise Platform > Developer tab > Connectors table_.", "schema": { "type": "string" }, "example": "accountID-sample-uat" } ], "responses": { "200": { "description": "Successful request and response" }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorIcon/{classificationType}": { "get": { "tags": [ "Connector Icon" ], "summary": "Retrieve a connector icon", "operationId": "GetConnectorIcon", "description": "Use this API to retrieve a connector icon by providing the `classificationType`, which is the unique type value for that connector. If there is no connector icon for the classification type passed in the URL, an error will be thrown to indicate that there is no connector icon.", "parameters": [ { "name": "classificationType", "in": "path", "required": true, "description": "classificationType is the value of the _Type_ column of the _Boomi Enterprise Platform > Developer tab > Connectors table_.", "schema": { "type": "string" }, "example": "accountID-sample-uat" } ], "responses": { "200": { "description": "Successful request and response." }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Connector Icon" ], "summary": "Delete a connector icon", "operationId": "DeleteConnectorIcon", "description": "Use this API to delete an existing connector icon by providing the `classificationType`, which is the unique type value for that connector. If there is no connector icon for the classification type passed in the URL, an error will be thrown to indicate that there is no connector icon.", "parameters": [ { "name": "classificationType", "in": "path", "required": true, "description": "classificationType is the value of the _Type_ column of the _Boomi Enterprise Platform > Developer tab > Connectors table_.", "schema": { "type": "string" }, "example": "accountID-sample-uat" } ], "responses": { "200": { "description": "Successful request and response." }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorMetadata": { "post": { "tags": [ "Connector Metadata" ], "summary": "Creates or updates a ConnectorMetadata object", "operationId": "CreateConnectorMetadata", "description": "Use this API to create or update connector metadata for a specific connector. For PRIVATE connectors, changes apply immediately. For PUBLIC connectors, changes are submitted for approval. \n\n **Note:** \n - PUBLIC connectors allow only one pending request at a time. \n - Tags are replaced entirely with each request. To add tags, include all existing tags along with new ones. To remove all tags, send empty `tags` array `\"tags\": []`. Exclude `connectorTags` to preserve existing tags. \n - HIDDEN connectors are not supported. \n\n ### Prerequisites \n Before submitting a metadata change request via the API, verify the following to ensure the request is successful: \n - The account submitting the request has signed the Connector SDK Agreement and the account's publisher information exists on the Publisher tab. To learn more, refer to [Publisher tab](/docs/Connectors/ConnectorDevelopmentReference/Entering_connector_publisher_information). \n - The connector for which you are submitting the request is built against the Software Development Kit (SDK). Otherwise, you cannot use the API to submit the request. \n\n ### Features and privileges: \n\n To use this API, the user account must have the following features and privileges: \n\n Feature: `CONNECTOR_ADMINISTRATION` \n\n Privileges: `CONNECTOR_SUBMISSION`, `DEVELOPER`, and `API`", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorMetadata" }, "example": { "classificationType": "sample-connector-classification", "metadata": { "displayName": "New Connector Display Name", "connectorTags": { "tags": [ { "name": "tag-name-1", "description": "The tag description" }, { "name": "tag-name-2", "description": "The other tag description" } ] } } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorMetadata" }, "example": "sample-connector-classificationNew Connector Display Nametag-name-1The tag descriptiontag-name-2The other tag description\n" } }, "required": false }, "responses": { "200": { "description": "Successful request and response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorMetadataResponse" }, "examples": { "PRIVATE - Immediate": { "value": { "@type": "ConnectorMetadataResponse", "reviewStatus": "APPROVED", "submittedBy": { "@type": "User", "firstName": "Boomi", "lastName": "User", "email": "testUser@boomi.com" }, "classificationType": "{connector-classification}", "metadata": { "@type": "Metadata", "displayName": "New Connector Display Name", "connectorTags": { "@type": "", "tags": [ { "@type": "ConnectorTag", "name": "tag-name-1", "description": "The tag description" }, { "@type": "ConnectorTag", "name": "tag-name-2", "description": "The other tag description" } ] } } } }, "PUBLIC - Pending Approval": { "value": { "@type": "ConnectorMetadataResponse", "reviewStatus": "PENDING", "submittedBy": { "@type": "User", "firstName": "Boomi", "lastName": "User", "email": "testUser@boomi.com" }, "submittedDate": "2023-09-02T12:50:00.033Z", "classificationType": "{connector-classification}", "metadata": { "@type": "Metadata", "displayName": "New Connector Display Name", "connectorTags": { "@type": "", "tags": [ { "@type": "ConnectorTag", "name": "tag-name-1", "description": "The tag description" }, { "@type": "ConnectorTag", "name": "tag-name-2", "description": "The other tag description" } ] } }, "uid": 136795 } } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorMetadataResponse" }, "examples": { "PRIVATE - Immediate": { "value": "sample-connector-classificationNew Connector Display Nametag-name-1The tag descriptiontag-name-2The other tag descriptionAPPROVEDBoomiUsertestUser@boomi.com" }, "PUBLIC - Pending Approval": { "value": "sample-connector-classificationNew Connector Display Nametag-name-1The tag descriptionPENDINGBoomiUsertestUser@boomi.com2023-09-02T12:50:00.033Z" } } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorMetadata/delete": { "post": { "tags": [ "Connector Metadata" ], "summary": "Cancel a metadata change request", "operationId": "UpdateConnectorMetadata", "description": "Use this API to cancel an existing metadata change request. This API should only be used for PUBLIC connectors that have submitted a metadata change request for review. If there is no PENDING metadata change request for the particular connector passed in the request body, an error will be thrown indicating that there is no pending request to cancel. \n\n **Note:** Only PENDING requests can be cancelled. \n\n ### Prerequisites \n Before submitting a metadata change request via the API, verify the following to ensure the request is successful: \n - The account submitting the request has signed the Connector SDK Agreement and the account's publisher information exists on the Publisher tab. To learn more, refer to [Publisher tab](/docs/Connectors/ConnectorDevelopmentReference/Entering_connector_publisher_information). \n - The connector for which you are submitting the request has a PENDING review status. \n - The connector for which you are submitting the request is built against the Software Development Kit (SDK). Otherwise, you cannot use the API to submit the request. \n\n ### Features and privileges \n The following features and privileges (granted by your account administrator) are required to perform the ConnectorMetadata operation: \n - Feature: `CONNECTOR_ADMINISTRATION` feature - Controls the `CONNECTOR_SUBMISSION` privilege \n - Privilege: `CONNECTOR_SUBMISSION` , `DEVELOPER` and `API` privileges - Required to delete a connector metadata change request for review.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorMetadata" }, "example": { "classificationType": "sample-connector-classification" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorMetadata" }, "example": "sample-connector-classification" } }, "required": false }, "responses": { "200": { "description": "Successful request and response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorMetadataResponse" }, "example": { "@type": "ConnectorMetadataResponse", "classificationType": "sample-connector-classification", "reviewStatus": "CANCELLED", "submittedBy": { "@type": "User", "email": "testUser@boomi.com", "firstName": "Boomi", "lastName": "User" }, "uid": 0 } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorMetadataResponse" }, "example": "sample-connector-classificationCANCELLEDBoomiUsertestUser@boomi.com0" } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } }, "/ConnectorMetadata/{classificationType}": { "get": { "tags": [ "Connector Metadata" ], "summary": "Retrieves an instance of a ConnectorMetadata object", "operationId": "GetConnectorMetadata", "description": "Use this API to retrieve the current metadata (display name and tags) for a specific connector. \n\n **Note:** Returns empty tags array if connector has no tags. \n\n ### Prerequisites \n Before submitting a metadata change request via the API, verify the following to ensure the request is successful: \n - The account submitting the request has signed the Connector SDK Agreement and the account's publisher information exists on the Publisher tab. To learn more, refer to [Publisher tab](/docs/Connectors/ConnectorDevelopmentReference/Entering_connector_publisher_information). \n - The connector for which you are submitting the request is built against the Software Development Kit (SDK). Otherwise, you cannot use the API to submit the request. \n\n ### Features and privileges: \n\n To use this API, the user account must have the following features and privileges: \n\n Feature: `CONNECTOR_ADMINISTRATION` \n\n Privileges: `DEVELOPER`, and `API`", "parameters": [ { "name": "classificationType", "in": "path", "description": "classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful request and response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorMetadata" }, "example": { "@type": "ConnectorMetadata", "classificationType": "{connector-classification}", "metadata": { "@type": "Metadata", "displayName": "Connector Display Name", "connectorTags": { "@type": "", "tags": [ { "@type": "ConnectorTag", "name": "tag-name-1", "description": "The tag description" }, { "@type": "ConnectorTag", "name": "tag-name-2", "description": "The other tag description" } ] } } } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConnectorMetadata" }, "examples": { "Get Response": { "value": "{connector-classification}Connector Display Nametag-name-1The tag descriptiontag-name-2The other tag description" } } } } }, "503": { "$ref": "#/components/responses/503" }, "403": { "$ref": "#/components/responses/403" }, "410": { "$ref": "#/components/responses/410" } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "schemas": { "APIConnectorVersion": { "required": [ "ConnectorVersionMetadata", "carLink", "changeLog", "deletedBy", "deletedDate", "displayVersion", "reviewStatus", "uploadedBy", "uploadedDate", "versionId" ], "type": "object", "properties": { "ConnectorVersionMetadata": { "$ref": "#/components/schemas/ConnectorVersionMetadata" }, "carLink": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "changeLog": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deletedBy": { "$ref": "#/components/schemas/User" }, "deletedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "displayVersion": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "pendingConnectorReview": { "$ref": "#/components/schemas/ConnectorReview" }, "releaseVersion": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ] }, "uploadedBy": { "$ref": "#/components/schemas/User" }, "uploadedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "versionId": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "ConnectorClassification": { "required": [ "classification", "classificationType", "createdBy", "dateCreated", "displayName", "groupType", "lastModifiedDate", "pendingVersion", "releaseDate", "reviewStatus", "version", "visibility" ], "type": "object", "properties": { "classification": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "dev" }, "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "sample-connector-classification" }, "createdBy": { "$ref": "#/components/schemas/User" }, "dateCreated": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "displayName": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Sample connector" }, "groupType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "sample-connector" }, "lastModifiedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "pendingVersion": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "3" }, "releaseDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ] }, "version": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "3" }, "visibility": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "PUBLIC" } } }, "ConnectorDescriptorValidation": { "required": [ "errors", "success", "warnings" ], "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/ValidationErrors" }, "success": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "warnings": { "$ref": "#/components/schemas/ValidationWarnings" } } }, "ConnectorGroup": { "required": [ "createdBy", "dateCreated", "groupType", "lastModifiedDate", "name" ], "type": "object", "properties": { "classifications": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ConnectorClassification" } }, "createdBy": { "$ref": "#/components/schemas/User" }, "dateCreated": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "groupType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "lastModifiedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "name": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "vendor": { "$ref": "#/components/schemas/ConnectorVendor" }, "versions": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/APIConnectorVersion" } } } }, "ConnectorGroupQuery": { "required": [ "createdBy", "dateCreated", "groupType", "lastModifiedDate", "name" ], "type": "object", "properties": { "classifications": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ConnectorClassification" } }, "createdBy": { "$ref": "#/components/schemas/User" }, "dateCreated": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "groupType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "lastModifiedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "name": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "vendor": { "$ref": "#/components/schemas/ConnectorVendor" } } }, "ConnectorGroupQueryExpression": { "oneOf": [ { "$ref": "#/components/schemas/ConnectorGroupQuerySimpleExpression" }, { "$ref": "#/components/schemas/ConnectorGroupQueryGroupingExpression" } ] }, "ConnectorGroupQueryGroupingExpression": { "required": [ "operator" ], "type": "object", "properties": { "nestedExpression": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ConnectorGroupQueryExpression" } }, "operator": { "type": "string", "xml": { "attribute": true }, "enum": [ "and", "or" ] } }, "xml": { "name": "GroupingExpression", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorGroupQueryQueryConfig": { "required": [ "QueryFilter" ], "type": "object", "properties": { "QueryFilter": { "required": [ "expression" ], "type": "object", "properties": { "expression": { "$ref": "#/components/schemas/ConnectorGroupQueryExpression" } }, "xml": { "name": "QueryFilter", "namespace": "http://api.platform.boomi.com/" } } }, "xml": { "name": "QueryConfig", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorGroupQueryQueryResponse": { "type": "object", "properties": { "numberOfResults": { "type": "integer", "format": "int32", "xml": { "attribute": true } }, "queryToken": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "result": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ConnectorGroupQuery" } } }, "xml": { "name": "QueryResult", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorGroupQuerySimpleExpression": { "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", "LIKE", "NOT_EQUALS", "IS_NULL", "IS_NOT_NULL", "BETWEEN", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "CONTAINS", "NOT_CONTAINS" ] }, "property": { "type": "string", "xml": { "attribute": true } } }, "xml": { "name": "SimpleExpression", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorPendingRelease": { "required": [ "classificationType" ], "type": "object", "properties": { "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "The name of the classification type of the connector that currently has a pending release scheduled.", "example": "test-user-connec-prod" } } }, "ConnectorReview": { "required": [ "submittedBy", "submittedDate" ], "type": "object", "properties": { "submittedBy": { "$ref": "#/components/schemas/User" }, "submittedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "ConnectorVendor": { "required": [ "supportEmail", "supportURL", "vendorName", "vendorProduct", "vendorProductVersion" ], "type": "object", "properties": { "supportEmail": { "type": "string", "example": "boomi@boomi.com", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "supportURL": { "type": "string", "example": "http://www.google.com", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "vendorName": { "type": "string", "example": "Boomi", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "vendorProduct": { "type": "string", "example": "Boomi", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "vendorProductVersion": { "type": "string", "example": "1", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "ConnectorVersionChange": { "required": [ "classificationType", "versionId" ], "type": "object", "properties": { "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "The name of the classification that currently has a PENDING connector version change request against it", "example": "sample-connector-classification" }, "versionId": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "The system version number you wish to switch to", "example": "3" }, "releaseNotes": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "Text to create any release notes for the connector", "example": "Any relevant release notes - Testing with a newer version" }, "VersionChangeSchedule": { "$ref": "#/components/schemas/VersionChangeSchedule" } } }, "ConnectorVersionChangeResponse": { "required": [ "classification", "classificationType", "completedBy", "completedDate", "releaseNotes", "reviewReason", "reviewStatus", "submittedBy" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorVersionChange" }, { "type": "object", "properties": { "classification": { "$ref": "#/components/schemas/ConnectorClassification" }, "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ], "example": "PENDING" }, "reviewReason": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "submittedBy": { "$ref": "#/components/schemas/User" }, "completedBy": { "$ref": "#/components/schemas/User" }, "completedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "uid": { "type": "integer", "format": "int64", "xml": { "attribute": true } } } } ] }, "ConnectorVersionChangeCancel": { "required": [ "classificationType" ], "type": "object", "properties": { "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "The name of the classification that currently has a PENDING connector version change request against it", "example": "sample-connector-classification" } } }, "ConnectorVersionChangeCancelResponse": { "required": [ "classification", "classificationType", "completedBy", "completedDate", "releaseNotes", "reviewReason", "reviewStatus", "submittedBy" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorVersionChangeCancel" }, { "type": "object", "properties": { "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ], "example": "CANCELLED" }, "completedBy": { "$ref": "#/components/schemas/User" }, "completedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } } } } ] }, "ConnectorVersionDelete": { "required": [ "groupType", "versionId" ], "type": "object", "properties": { "groupType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "versionId": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "uploadedBy": { "$ref": "#/components/schemas/User" }, "uploadedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": false } } }, "ConnectorVersionDeleteResponse": { "required": [ "groupType", "versionId" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorVersionDelete" }, { "type": "object", "properties": { "displayVersion": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "2.1.2" }, "changeLog": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Testing independent key-value pairs via the API" } } } ] }, "ConnectorVersionMetadata": { "required": [ "strictClassLoading" ], "type": "object", "properties": { "strictClassLoading": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "false" } } }, "ConnectorVersionQuery": { "required": [ "ConnectorVersionMetadata", "carLink", "changeLog", "deletedBy", "deletedDate", "displayVersion", "reviewStatus", "uploadedBy", "uploadedDate", "versionId" ], "type": "object", "properties": { "ConnectorVersionMetadata": { "$ref": "#/components/schemas/ConnectorVersionMetadata" }, "carLink": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "changeLog": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deletedBy": { "$ref": "#/components/schemas/User" }, "deletedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "displayVersion": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "pendingConnectorReview": { "$ref": "#/components/schemas/ConnectorReview" }, "releaseVersion": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ] }, "uploadedBy": { "$ref": "#/components/schemas/User" }, "uploadedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "versionId": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "ConnectorVersionQueryExpression": { "oneOf": [ { "$ref": "#/components/schemas/ConnectorVersionQuerySimpleExpression" }, { "$ref": "#/components/schemas/ConnectorVersionQueryGroupingExpression" } ] }, "ConnectorVersionQueryGroupingExpression": { "required": [ "operator" ], "type": "object", "properties": { "nestedExpression": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ConnectorVersionQueryExpression" } }, "operator": { "type": "string", "xml": { "attribute": true }, "enum": [ "and", "or" ] } }, "xml": { "name": "GroupingExpression", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorVersionQueryQueryConfig": { "required": [ "QueryFilter" ], "type": "object", "properties": { "QueryFilter": { "required": [ "expression" ], "type": "object", "properties": { "expression": { "$ref": "#/components/schemas/ConnectorVersionQueryExpression" } }, "xml": { "name": "QueryFilter", "namespace": "http://api.platform.boomi.com/" } } }, "xml": { "name": "QueryConfig", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorVersionQueryQueryResponse": { "type": "object", "properties": { "numberOfResults": { "type": "integer", "format": "int32", "xml": { "attribute": true } }, "queryToken": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "result": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ConnectorVersionQuery" } } }, "xml": { "name": "QueryResult", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorVersionQuerySimpleExpression": { "required": [ "operator", "property" ], "type": "object", "properties": { "argument": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "type": "string", "xml": { "name": "argument" }, "example": "test-account-group1" } }, "operator": { "type": "string", "xml": { "attribute": true }, "enum": [ "EQUALS", "LIKE", "NOT_EQUALS", "IS_NULL", "IS_NOT_NULL", "BETWEEN", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "CONTAINS", "NOT_CONTAINS" ] }, "property": { "type": "string", "xml": { "attribute": true }, "example": "GROUP_TYPE", "description": " - `GROUP_TYPE`: (Required) Supported operators: `EQUALS` \n - `DELETED`: (Optional) Supported operators: `EQUALS` \n - `REVIEW_STATUS`: (Optional) Supported operators: `EQUALS`, `NOT_EQUALS`. Supported arguments: Enum: `APPROVED`, `CANCELLED`, `PENDING`, `REJECTED` \n - `STRICT_CLASS_LOADING`: (Optional) Supported operators: `true`, `false`" } }, "xml": { "name": "SimpleExpression", "namespace": "http://api.platform.boomi.com/" } }, "ConnectorVersionReview": { "required": [ "groupType", "version" ], "type": "object", "properties": { "groupType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "`groupType` is the value of the _Type_ column of the _Boomi Enterprise Platform --> Developer tab --> Connectors table_ without the classification. \n For the connector-id, `accountId-connectorType-classification`, the connectorType value is `accountId-connectorType` after omitting the classification. \n\n For example, if the _Type_ column displays _accountID-sample-uat_, then the `groupType` will be _accountID-sample_.", "example": "sampleGroupType" }, "version": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "3" } } }, "ConnectorVersionReviewResponse": { "required": [ "groupType", "reviewStatus", "submittedBy", "version" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorVersionReview" }, { "type": "object", "properties": { "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Pending" }, "submittedBy": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Administrator" }, "uid": { "type": "integer", "format": "int64", "xml": { "attribute": true } } } } ] }, "ConnectorVisibility": { "required": [ "classificationType", "visibility" ], "type": "object", "properties": { "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "sample-connector-classification", "description": "Corresponds to the value of the _Type_ column of _Developer tab > Connectors_ table in the Boomi Enterprise Platform." }, "visibility": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "HIDDEN", "PRIVATE", "PUBLIC" ] } } }, "ConnectorVisibilityResponse": { "required": [ "classificationType", "reviewStatus", "submittedBy", "visibility" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorVisibility" }, { "type": "object", "properties": { "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ], "example": "PENDING" }, "submittedBy": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Lastname, Firstname" }, "uid": { "type": "integer", "format": "int64", "xml": { "attribute": true } } } } ] }, "ConnectorVisibilityCancel": { "required": [ "classificationType" ], "type": "object", "properties": { "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "sample-connector-classification", "description": "Corresponds to the value of the _Type_ column of _Developer tab > Connectors_ table in the Boomi Enterprise Platform." } } }, "ConnectorVisibilityCancelResponse": { "required": [ "classificationType", "reviewStatus", "submittedBy", "visibility" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorVisibility" }, { "type": "object", "properties": { "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ], "example": "CANCELLED" }, "submittedBy": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Lastname, Firstname" }, "uid": { "type": "integer", "format": "int64", "xml": { "attribute": true } } } } ] }, "CreateConnectorClassification": { "required": [ "classification", "displayName", "groupType" ], "type": "object", "properties": { "classification": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "dev" }, "displayName": { "type": "string", "example": "Group Test 4 Connector", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "groupType": { "type": "string", "example": "test-account-boomi-conn", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "version": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": 3 } } }, "CreateConnectorClassificationResponse": { "required": [ "classification", "displayName", "groupType" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateConnectorClassification" }, { "type": "object", "properties": { "createdBy": { "$ref": "#/components/schemas/User" }, "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "test-account-boomi-conn-dev" }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": false }, "visibility": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "PRIVATE" }, "dateCreated": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "lastModifiedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } } } } ] }, "CreateConnectorGroup": { "required": [ "CreateConnectorClassification", "groupName" ], "type": "object", "properties": { "ConnectorVendor": { "$ref": "#/components/schemas/ConnectorVendor" }, "CreateConnectorClassification": { "$ref": "#/components/schemas/CreateConnectorClassification" }, "groupName": { "type": "string", "example": "Group Test 4", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "CreateConnectorGroupResponse": { "required": [ "CreateConnectorClassification", "groupName" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/CreateConnectorGroup" }, { "type": "object", "properties": { "groupType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "sample-connector" }, "lastModifiedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "dateCreated": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "deleted": { "type": "boolean", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": false }, "createdBy": { "$ref": "#/components/schemas/User" }, "ConnectorVendor": { "$ref": "#/components/schemas/ConnectorVendor" }, "CreateConnectorClassification": { "$ref": "#/components/schemas/CreateConnectorClassification" }, "groupName": { "type": "string", "example": "Group Test 4", "xml": { "namespace": "http://api.platform.boomi.com/" } } } } ] }, "Metadata": { "type": "object", "properties": { "displayName": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "New Connector Display Name", "description": "New display name for the connector. Can be null if not changing. Cannot be blank." }, "connectorTags": { "$ref": "#/components/schemas/ConnectorTags" } }, "description": "Container object for all metadata properties." }, "ConnectorMetadata": { "required": [ "classificationType", "metadata" ], "type": "object", "properties": { "classificationType": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.", "example": "sample-connector-classification" }, "metadata": { "$ref": "#/components/schemas/Metadata" } } }, "ConnectorMetadataResponse": { "required": [ "classificationType", "metadata", "reviewStatus", "submittedBy", "submittedDate" ], "type": "object", "allOf": [ { "$ref": "#/components/schemas/ConnectorMetadata" }, { "type": "object", "properties": { "reviewStatus": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "enum": [ "APPROVED", "CANCELLED", "PENDING", "REJECTED" ], "description": "Request review status. APPROVED: metadata updated (PRIVATE connectors). PENDING: awaiting review (PUBLIC connectors). CANCELLED/REJECTED: request cancelled or rejected. Returned only in POST responses.", "example": "PENDING" }, "submittedBy": { "allOf": [ { "$ref": "#/components/schemas/User" } ], "description": "User who submitted the metadata change request. Returned only in POST responses." }, "submittedDate": { "type": "string", "format": "date-time", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "Timestamp when the metadata change request was submitted. Returned only for PUBLIC connectors with PENDING review status." }, "uid": { "type": "integer", "format": "int64", "xml": { "attribute": true }, "description": "Unique identifier for the metadata change request. Returned only for PUBLIC connectors." } } } ] }, "User": { "required": [ "email", "firstName", "lastName" ], "type": "object", "properties": { "email": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "testUser@boomi.com", "description": "Submitter's email address" }, "firstName": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "Boomi", "description": "Submitter's first name" }, "lastName": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "example": "User", "description": "Submitter's last name" } } }, "ValidationError": { "required": [ "issue", "message" ], "type": "object", "properties": { "issue": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "message": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "ValidationErrors": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "xml": { "attribute": true } }, "error": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "ValidationWarning": { "required": [ "issue", "message" ], "type": "object", "properties": { "issue": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } }, "message": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" } } } }, "ValidationWarnings": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "xml": { "attribute": true } }, "warning": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "items": { "$ref": "#/components/schemas/ValidationWarning" } } } }, "VersionChangeSchedule": { "type": "object", "properties": { "preferredReleaseDate": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "Contains information pertaining to a release date. This can be used by both PUBLIC and PRIVATE connectors.", "example": "2024-07-23T21:32:52Z" } } }, "ConnectorTag": { "type": "object", "required": [ "description", "name" ], "properties": { "description": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "Tag description", "example": "The tag description" }, "name": { "type": "string", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "Tag name", "example": "tag-name-1" } } }, "ConnectorTags": { "type": "object", "properties": { "tags": { "type": "array", "xml": { "namespace": "http://api.platform.boomi.com/" }, "description": "Array of tag objects. Empty array removes all tags.", "items": { "$ref": "#/components/schemas/ConnectorTag" } } } } }, "responses": { "403": { "description": "Access denied due to insufficient permissions. \n To know the action to be taken for this and the other error responses (410, 503, etc), refer to [API Errors](https://developer.boomi.com/docs/APIs/Connectors/APIReference/API-errors)", "content": { "application/json": { "examples": { "Forbidden (JSON)": { "summary": "Forbidden (JSON)", "value": { "message": "Access denied due to insufficient permissions." } } } }, "application/xml": { "examples": { "Forbidden (XML)": { "summary": "Forbidden (XML)", "value": "Access denied due to insufficient permissions." } } } } }, "410": { "description": "Endpoint is invalid or no longer exists.", "content": { "application/json": { "examples": { "Gone (JSON)": { "summary": "Gone (JSON)", "value": { "message": "Endpoint is invalid or no longer exists." } } } }, "application/xml": { "examples": { "Gone (XML)": { "summary": "Gone (XML)", "value": "Endpoint is invalid or no longer exists." } } } } }, "503": { "description": "The Boomi server is currently unavailable or your account's rate limits have been exceeded. Retry later.", "content": { "application/json": { "examples": { "Service Unavailable (JSON)": { "summary": "Service Unavailable (JSON)", "value": { "message": "The Boomi server is currently unavailable or your account's rate limits have been exceeded. Retry later." } } } }, "application/xml": { "examples": { "Service Unavailable (XML)": { "summary": "Service Unavailable (XML)", "value": "The Boomi server is currently unavailable or your account's rate limits have been exceeded. Retry later." } } } } } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } } }