Boomi Platform Connector API Reference (1.0.0) - ConnectorIcon

Toggle Pane

• Connector Icon
  • postCreate a new connector icon
  • getRetrieve a connector icon
  • delDelete a connector icon

API docs by Redocly

License: Boomi API License

Download OpenAPI Specification: Download

Connector Icon

Create or update a connector icon for an existing connector classification type.

Prerequisites

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:

• The user submitting the request has the correct features and privileges.
• 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.
• The connectorIcon file size file cannot not be larger than 100KB.

Features and privileges

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:

• DEVELOPER and API privileges - PRIVATE connectors only inside the requester's own account
• CONNECTOR_REVIEW, DEVELOPER and API privileges - for any PUBLIC/PRIVATE/HIDDEN connectors in any account

Troubleshooting

If the API request is not successful, use the following information to help you troubleshoot:

• If the publisher information is missing, an error occurs. To learn more, see Prerequisites in this topic.
• If the connector for which you are submitting the request is not built against the Boomi Software Development Kit (SDK), an error occurs.
• If the classificationType does not exist, an error occurs.
• If the connector icon does not exist, an error occurs.
• If the groupType is provided instead of the classificationType, an error occurs.
• The SVG file structure is internally validated. The XML structure must start with <svg.
• If the Create a new connector icon response is true, try clearing your browser's cache.

Create a new connector icon

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:

• connectorIcon : The connector icon .svg file.
• sha256Checksum : (Optional) Text field to provide a sha256Checksum to validate the integrity of the uploaded file.

Authorizations:

basicAuth

path Parameters

classificationType required

string Example: accountID-sample-uat classificationType is the value of the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.

Responses

Response Headers

Sunset	string The approximate date the API Object will be removed
Warning	string Informative header describing a warning that appeared due to your API call
Deprecation	string Indicates that the api you are using is deprecated and will be removed at some point. Includes the date that this was initially deprecated.
Link	string A hyperlink indicating a site with more information about the deprecation of this object

Boomi Connector API Endpoint URL. {accountId} is the Account ID of the authenticated account making this request.

https://api.boomi.com/connector/api/rest/v1/{accountId}/ConnectorIcon/{classificationType}/upload

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieve a connector icon

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.

Authorizations:

basicAuth

path Parameters

classificationType required

string Example: accountID-sample-uat classificationType is the value of the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.

Responses

Response Headers

Sunset	string The approximate date the API Object will be removed
Warning	string Informative header describing a warning that appeared due to your API call
Deprecation	string Indicates that the api you are using is deprecated and will be removed at some point. Includes the date that this was initially deprecated.
Link	string A hyperlink indicating a site with more information about the deprecation of this object

Boomi Connector API Endpoint URL. {accountId} is the Account ID of the authenticated account making this request.

https://api.boomi.com/connector/api/rest/v1/{accountId}/ConnectorIcon/{classificationType}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Delete a connector icon

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.

Authorizations:

basicAuth

path Parameters

classificationType required

string Example: accountID-sample-uat classificationType is the value of the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.

Responses

Response Headers

Sunset	string The approximate date the API Object will be removed
Warning	string Informative header describing a warning that appeared due to your API call
Deprecation	string Indicates that the api you are using is deprecated and will be removed at some point. Includes the date that this was initially deprecated.
Link	string A hyperlink indicating a site with more information about the deprecation of this object

Boomi Connector API Endpoint URL. {accountId} is the Account ID of the authenticated account making this request.

https://api.boomi.com/connector/api/rest/v1/{accountId}/ConnectorIcon/{classificationType}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}