Boomi Platform Connector API Reference (1.0.0) - ConnectorArchive

Toggle Pane

• Connector Archive
  • postAutoconfigure a connector from a connector archive

API docs by Redocly

License: Boomi API License

Download OpenAPI Specification: Download

Connector Archive

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.

Features and Privileges

In addition to the developer privilege and the SDK publisher agreement, ensure that you have:

• CONNECTOR_ADMINISTRATION feature — Controls the CONNECTOR_SUBMISSION privilege

• CONNECTOR_SUBMISSION privilege — Required to autoconfigure a connector from a connector archive.

Autoconfigure a connector from a connector archive

This request will have a single form data input with connectorArchive key. The zip file being uploaded should contain a MANIFEST.MF file that should at minimum, have a display name that will be used as the display-name for the resultant connector . A classification can be optionally provided in the manifest which is used while creating the connector classification associated with this connector.

If successful, the API returns a response that has details of the connector group, classification, and versions created using the connector archive.

Authorizations:

basicAuth

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

required	object (User)
dateCreated required	string <date-time>
groupType required	string
lastModifiedDate required	string <date-time>
name required	string
	Array of objects (ConnectorClassification)
deleted	boolean
	object (ConnectorVendor)
	Array of objects (APIConnectorVersion)

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}/ConnectorArchive/upload

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "classifications": [

  • {

    • "classification": "dev",
    • "classificationType": "sample-connector-classification",
    • "createdBy": {

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

      },
    • "dateCreated": "2019-08-24T14:15:22Z",
    • "deleted": true,
    • "displayName": "Sample connector",
    • "groupType": "sample-connector",
    • "lastModifiedDate": "2019-08-24T14:15:22Z",
    • "pendingVersion": "3",
    • "releaseDate": "2019-08-24T14:15:22Z",
    • "reviewStatus": "APPROVED",
    • "version": "3",
    • "visibility": "PUBLIC"

    }

  ],
• "createdBy": {

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

  },
• "dateCreated": "2019-08-24T14:15:22Z",
• "deleted": true,
• "groupType": "string",
• "lastModifiedDate": "2019-08-24T14:15:22Z",
• "name": "string",
• "vendor": {

  • "supportEmail": "boomi@boomi.com",
  • "supportURL": "http://www.google.com",
  • "vendorName": "Boomi",
  • "vendorProduct": "Boomi",
  • "vendorProductVersion": "1"

  },
• "versions": [

  • {

    • "ConnectorVersionMetadata": {

      • "strictClassLoading": "false"

      },
    • "carLink": "string",
    • "changeLog": "string",
    • "deleted": true,
    • "deletedBy": {

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

      },
    • "deletedDate": "2019-08-24T14:15:22Z",
    • "displayVersion": "string",
    • "pendingConnectorReview": {

      • "submittedBy": {

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

        },
      • "submittedDate": "2019-08-24T14:15:22Z"

      },
    • "releaseVersion": true,
    • "reviewStatus": "APPROVED",
    • "uploadedBy": {

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

      },
    • "uploadedDate": "2019-08-24T14:15:22Z",
    • "versionId": "string"

    }

  ]

}