Boomi Platform Connector API Reference (1.0.0) - ConnectorMetadata

Toggle Pane

• Connector Metadata
  • postSubmit a display name change request
  • postCancel a display name change request

API docs by Redocly

License: Boomi API License

Download OpenAPI Specification: Download

Connector Metadata

Change the connector metadata (display name) for PRIVATE and PUBLIC connectors.

Submit a display name change request

Use this API to change the display name of a connector if it is PRIVATE. Additionally, this API allows a user to submit a display name change request if the connector is PUBLIC.

Prerequisites

Before submitting a display name 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:

In order to user 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 the value of the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata)

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

Response Schema:

application/jsonapplication/xmlapplication/json

classificationType required	string classificationType is the value of the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
required	object (Metadata)
reviewStatus required	string Enum: "APPROVED" "CANCELLED" "PENDING" "REJECTED"
required	object (User)
uid	integer <int64>

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"

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "classificationType": "sample-connector-classification",
• "metadata": {

  • "displayName": "New Connector Display name"

  },
• "reviewStatus": "PENDING",
• "submittedBy": {

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

  },
• "uid": 0

}

Cancel a display name change request

Use this API to cancel an existing display name change request. This API should only be used for PUBLIC connectors that have submitted a display name change request for review. If there is no PENDING display name 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.

Prerequisites

Before submitting a display name 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 visibility change request for review.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classificationType required

string 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

Response Schema:

application/jsonapplication/xmlapplication/json

classificationType required	string classificationType is the value of the Type column of the Boomi Enterprise Platform > Developer tab > Connectors table.
reviewStatus required	string Enum: "APPROVED" "CANCELLED" "PENDING" "REJECTED"
required	object (User)
uid	integer <int64>

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

{

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

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

  },
• "uid": 0

}