Boomi Platform Connector API Reference (1.0.0) - ConnectorVisibility

Toggle Pane

• Connector Visibility
  • postSubmit a connector visibility change request
  • postCancel a connector visibility change request

API docs by Redocly

License: Boomi API License

Download OpenAPI Specification: Download

Connector Visibility

Submit a connector visibility change request and ask to review the visibility change of your connector.

Features and Privileges

Ensure that you have :

• DEVELOPER and API privileges for visibility changes from PRIVATE to HIDDEN

• 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

Submit a connector visibility change request

Use the ConnectorVisibility operation to submit a connector visibility change request to change the visibility of your connector.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classificationType required	string Corresponds to the value of the Type column of Developer tab > Connectors table in the Boomi Enterprise Platform.
visibility required	string Enum: "HIDDEN" "PRIVATE" "PUBLIC"

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 Corresponds to the value of the Type column of Developer tab > Connectors table in the Boomi Enterprise Platform.
reviewStatus required	string Enum: "APPROVED" "CANCELLED" "PENDING" "REJECTED"
submittedBy required	string
visibility required	string Enum: "HIDDEN" "PRIVATE" "PUBLIC"
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}/ConnectorVisibility

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "classificationType": "sample-connector-classification",
• "visibility": "HIDDEN"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "classificationType": "sample-connector-classification",
• "visibility": "HIDDEN",
• "reviewStatus": "PENDING",
• "submittedBy": "Lastname, Firstname",
• "uid": 0

}

Cancel a connector visibility change request

Use the ConnectorVisibility operation to cancel a pending connector visibility change request.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

classificationType required

string Corresponds to the value of the Type column of Developer tab > Connectors table in the Boomi Enterprise Platform.

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 Corresponds to the value of the Type column of Developer tab > Connectors table in the Boomi Enterprise Platform.
reviewStatus required	string Enum: "APPROVED" "CANCELLED" "PENDING" "REJECTED"
submittedBy required	string
visibility required	string Enum: "HIDDEN" "PRIVATE" "PUBLIC"
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}/ConnectorVisibility/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",
• "visibility": "HIDDEN",
• "reviewStatus": "CANCELLED",
• "submittedBy": "Lastname, Firstname",
• "uid": 0

}