Boomi Platform Connector API Reference (1.0.0) - ConnectorMetadata

Toggle Pane

• Connector Metadata
  • postCreates or updates a ConnectorMetadata object
  • postCancel a metadata change request
  • getRetrieves an instance of a ConnectorMetadata object

API docs by Redocly

License: Boomi API License

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Connector Metadata

This API manages connector metadata, including display names and tags for Boomi connectors. PRIVATE connectors update immediately, while PUBLIC connector changes require approval. It also provides retrieval capabilities for connector metadata.

Creates or updates a ConnectorMetadata object

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.

Note:

• PUBLIC connectors allow only one pending request at a time.
• 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.
• HIDDEN connectors are not supported.

Prerequisites

Before submitting a metadata change request via the API, verify the following to ensure the request is successful:

• 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.
• 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.

Features and privileges:

To use this API, the user account must have the following features and privileges:

Feature: CONNECTOR_ADMINISTRATION

Privileges: CONNECTOR_SUBMISSION, DEVELOPER, and API

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classificationType required	string classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata) Container object for all metadata properties.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

classificationType required	string classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata) Container object for all metadata properties.
reviewStatus required	string Enum: "APPROVED" "CANCELLED" "PENDING" "REJECTED" Request review status. APPROVED: metadata updated (PRIVATE connectors). PENDING: awaiting review (PUBLIC connectors). CANCELLED/REJECTED: request cancelled or rejected. Returned only in POST responses.
required	object User who submitted the metadata change request. Returned only in POST responses.
submittedDate required	string <date-time> Timestamp when the metadata change request was submitted. Returned only for PUBLIC connectors with PENDING review status.
uid	integer <int64> Unique identifier for the metadata change request. Returned only for PUBLIC connectors.

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}/ConnectorMetadata

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "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"

        }

      ]

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

Example

PRIVATE - ImmediatePUBLIC - Pending ApprovalPRIVATE - Immediate

{

• "@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"

        }

      ]

    }

  }

}

Cancel a metadata change request

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.

Note: Only PENDING requests can be cancelled.

Prerequisites

Before submitting a metadata change request via the API, verify the following to ensure the request is successful:

• 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.
• The connector for which you are submitting the request has a PENDING review status.
• 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.

Features and privileges

The following features and privileges (granted by your account administrator) are required to perform the ConnectorMetadata operation:

• Feature: CONNECTOR_ADMINISTRATION feature - Controls the CONNECTOR_SUBMISSION privilege
• Privilege: CONNECTOR_SUBMISSION , DEVELOPER and API privileges - Required to delete a connector metadata change request for review.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classificationType required	string classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata) Container object for all metadata properties.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

classificationType required	string classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata) Container object for all metadata properties.
reviewStatus required	string Enum: "APPROVED" "CANCELLED" "PENDING" "REJECTED" Request review status. APPROVED: metadata updated (PRIVATE connectors). PENDING: awaiting review (PUBLIC connectors). CANCELLED/REJECTED: request cancelled or rejected. Returned only in POST responses.
required	object User who submitted the metadata change request. Returned only in POST responses.
submittedDate required	string <date-time> Timestamp when the metadata change request was submitted. Returned only for PUBLIC connectors with PENDING review status.
uid	integer <int64> Unique identifier for the metadata change request. Returned only for PUBLIC connectors.

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}/ConnectorMetadata/delete

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "classificationType": "sample-connector-classification"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "ConnectorMetadataResponse",
• "classificationType": "sample-connector-classification",
• "reviewStatus": "CANCELLED",
• "submittedBy": {

  • "@type": "User",
  • "email": "testUser@boomi.com",
  • "firstName": "Boomi",
  • "lastName": "User"

  },
• "uid": 0

}

Retrieves an instance of a ConnectorMetadata object

Use this API to retrieve the current metadata (display name and tags) for a specific connector.

Note: Returns empty tags array if connector has no tags.

Prerequisites

Before submitting a metadata change request via the API, verify the following to ensure the request is successful:

• 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.
• 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.

Features and privileges:

To use this API, the user account must have the following features and privileges:

Feature: CONNECTOR_ADMINISTRATION

Privileges: DEVELOPER, and API

Authorizations:

basicAuth

path Parameters

classificationType required

string classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

classificationType required	string classificationType is a unique identifier for the connector, found in the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata) Container object for all metadata properties.

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}/ConnectorMetadata/{classificationType}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@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"

        }

      ]

    }

  }

}