Connectors

A Connector is a piece of software used to move data between specific applications using those applications' APIs and security model. A Connector can be used to retrieve data from a source application or update data in a target application. Connectors must be installed before you can begin creating Connections. Each Connector has its own set of connection requirements. See Managing Connections in the TIBCO Scribe® Help for information on using a specific Connector. Before using the TIBCO Scribe® API to install or uninstall Connectors, review the following:

API Basics

Endpoints — Use the links in the Endpoints section below to access the TIBCO Scribe® Swagger page and try out the API against your Organization.

Fields For Connectors Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Considerations

In some cases there are special considerations or use cases for specific endpoints that you should know about before you use the endpoint.

GET /v1/orgs/{orgId}/connector

Due to a long delay installing Connectors, the list of Connectors returned may include a Connector that has not completed the installation process.

POST /v1/orgs/{orgId}/managedconnectors/{connectorId}/customers/{id}

There can be a long delay when installing a new Connector in an Organization.

PUT /v1/orgs/{orgId}/connectors/{connectorId}/version

You can only lock a Connector at the current production version to prevent a future upgrade. Only TIBCO can lock a Connector hotfix version to prevent an upgrade.

GET /v1/orgs/{orgId}/connectors/{id}/uioptions

Returns UI options for Connectors that use the generic user interface. Options for Connectors with a custom user interface cannot be retrieved using this endpoint. For Connectors distributed by TIBCO Scribe®, refer to the TIBCO Scribe® API Considerations section of the Help for the specific Connector to find the UI options. See Connections for a list of Connectors.
If you request UI options for a Connector with a custom user interface, the following error message is generated: The connector type does not support getting generic UI Elements.

Endpoints

/v1/orgs/{orgId}/connectors

Return a list of Connectors

/v1/orgs/{orgId}/connectors/{connectorId}/preconnect

Setup call for a Connection to be created

/v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId}

Return the status of a preconnect command

/v1/orgs/{orgId}/connectors/{connectorId}/version

Return version information for a Connector

/v1/orgs/{orgId}/connectors/{connectorId}/version

Modify Connector version Locked/Unlocked state

/v1/orgs/{orgId}/connectors/{id}

Return information about a Connector

/v1/orgs/{orgId}/connectors/{id}/delete

Uninstall a Marketplace Connector from all Agents

/v1/orgs/{orgId}/connectors/{id}/install

Install a Connector to all Agents

/v1/orgs/{orgId}/connectors/{id}/uioptions

Return UI options for a Connector

Fields For Connectors Endpoints

The list of fields defined in this table is comprehensive across all Connectors endpoints. See Endpoints for a list of Connectors endpoints with links to the associated Swagger page.

Name Type Data Type	Description	Endpoints
Parameters
AgentId query string	Filters the list of Connectors and returns only those Connectors installed on the selected Agent.	GET /v1/orgs/{orgId}/connectors
agentId query string	Use this to select an Agent to return the Connector UI options. If this Agent is not available, the system chooses the best available Agent.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect
commandId query string	ID of the preconnect command. Required	GET /v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId}
connectorId query string	GUID/UUID of the Connector. Required	POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect GET /v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId} GET /v1/orgs/{orgId}/connectors/{connectorId}/version PUT /v1/orgs/{orgId}/connectors/{connectorId}/version
id query string	GUID/UUID of the Connector. Required	GET /v1/orgs/{orgId}/connectors/{id} DELETE /v1/orgs/{orgId}/connectors/{id}/delete POST /v1/orgs/{orgId}/connectors/{id}/install GET /v1/orgs/{orgId}/connectors/{id}/uioptions
isLocked query boolean	Sets the locked state of the Connector version. Locking a Connector version stops a Connector upgrade to the Agents in your Organization. The Connector is locked at the version specified in the updateVersion field. Default is true. true — Locks the version. false — Unlocks the version.	PUT /v1/orgs/{orgId}/connectors/{connectorId}/version
isOauth query boolean	Indicates whether or not the Connector supports OAuth. true — Supports OAuth. false — Does not Support OAuth	POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect
limit query integer	Maximum number of Connectors to return. Default value is 100. See Reading Resources for more information on offset and limit parameters.	GET /v1/orgs/{orgId}/connectors
name query string	Vendor specified name for the Connector.	GET /v1/orgs/{orgId}/connectors
offset query integer	Number of Connectors to skip before returning results. Default value is 0. See Reading Resources for more information on offset and limit parameters.	GET /v1/orgs/{orgId}/connectors
orgId path integer	Unique ID for each Organization. Required	All
properties body model	Property array containing key value pairs. Each key contains the name of a Connection parameter. The associated value contains the value for the Connection parameter. For example, for the Eloqua Connection you have a key named Company and its corresponding value contains the company name as defined in Eloqua. Note: You must provide a key value pair for each Connection property when creating or updating a Connection. Otherwise, the properties are set to blank values. Note: Connection properties are encrypted. See Connection Properties for additional information. Required	POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect
updateVersion query string	Version number of the Connector. This is the version you want to assign to the Connector when multiple versions exist. For example, if a new version of the Connector is scheduled for release, you can assign the current version and set the isLocked property to true to prevent a Connector upgrade on your Agents when the new Connector is released. Required	PUT /v1/orgs/{orgId}/connectors/{connectorId}/version
version query string	Version of the Connector to retrieve.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
Response
companyName response string	Name of the company that created the Connector, such as TIBCO Software Inc..	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
connectionLimitReached response boolean	Indicates whether or not a Connection can be added for this Connector. This is based on the TIBCO Scribe® Subscription you purchased. For more information on your TIBCO Scribe® Subscription, contact Sales. true — Connections cannot be added for this Connector. false — Connections can be added for this Connector.	GET /v1/orgs/{orgId}/connectors GET /v1/orgs/{orgId}/connectors/{id}
creationDate response string	Date and time in UTC time that the Connector version was locked. When the Connector is not locked, returns the current date and time.	GET /v1/orgs/{orgId}/connectors/{connectorId}/version PUT /v1/orgs/{orgId}/connectors/{connectorId}/version
description response string	Description of the Connector, such as TIBCO Scribe® Connector for Eloqua.	GET /v1/orgs/{orgId}/connectors
helpURL response string	URL of the help link to the documentation for this Connector.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
id response string	GUID/UUID of the Object. Objects include: Connectors Preconnect command	GET /v1/orgs/{orgId}/connectors POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect GET /v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId}
inputType response string	Property for fields on the Connection dialog for this Connector in TIBCO Scribe®. See uiDecorations. Depending on the input type selected, the text in the associated field is either masked or displayed in the Connector UI. Types include: Text — Contents are not masked. Password — Contents are masked.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
isCloudSupported response boolean	Indicates whether or not the Connector can be used with a Cloud Agent.	GET /v1/orgs/{orgId}/connectors
isLocked response string	Indicates whether or not the Connector version is locked. A locked Connector version is not updated during a Connector upgrade. Default is false. true — The Connector version is locked. false — The Connector version is not locked.	GET /v1/orgs/{orgId}/connectors/{connectorId}/version
isRequired response boolean	Property for fields on the Connection dialog for this Connector in TIBCO Scribe®. See uiDecorations. Indicates whether or not this field is required to configure a Connection using this Connector. true — The field is required. false — The field is not required.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
label response string	Property for fields on the Connection dialog for this Connector in TIBCO Scribe®. See uiDecorations. Label that displays on the User Interface for the associated field.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
lastModificationDate response string	Date and time in UTC time that the Connector version was locked. When the Connector version is not locked, the current date and time are returned.	GET /v1/orgs/{orgId}/connectors/{connectorId}/version PUT /v1/orgs/{orgId}/connectors/{connectorId}/version
modificationBy response string	User name of the person who last modified the locked state of the Connector version.	GET /v1/orgs/{orgId}/connectors/{connectorId}/version PUT /v1/orgs/{orgId}/connectors/{connectorId}/version
name response string	Name of the Object. Objects include: Connectors, such as Eloqua. Value cannot be NULL. Preconnect	GET /v1/orgs/{orgId}/connectors POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect GET /v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId}
options response array	Property for fields on the Connection dialog for this Connector in TIBCO Scribe®. See uiDecorations. Array of key value pairs representing pick list options on the Connection dialog.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
order response integer	Property for fields on the Connection dialog for this Connector in TIBCO Scribe®. See uiDecorations. Controls the order of the fields on the Connection dialog. If no order is specified, fields are displayed in the order in which they were entered in the FormDefinition.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
propertyName response string	Property for fields on the Connection dialog for this Connector in TIBCO Scribe®. See uiDecorations. Name used as a reference by the Connector and the Connection dialog to this field's information.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
reply response string	Data returned by the Connector. Varies by Connector.	POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect GET /v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId}
solutionRoles response array	List of the Solution, Map, and Connection types supported by the Connector. Types include: Scribe.IS2.Source — Source Connection for an Integration Map. Scribe.IS2.Target — Target Connection for an Integration Map. Scribe.RS.Source — Source Connection for a Replication Services Solution. Scribe.RS.Target — Target Connection for a Replication Services Solution. Scribe.MS2.Source — Source Connection for a Migration Map. Scribe.MS2.Target — Target Connection for a Migration Map. The types listed below pertain to Basic Maps, which are no longer supported by TIBCO Scribe®. Scribe.IS.Source — Supports a source Connection for an Integration Services Basic Map. Scribe.IS.Target — Supports a target Connection for an Integration Services Basic Map. Scribe.MS.Source — Supports a source Connection for a Migration Services Basic Map. Scribe.MS.Target — Supports a target Connection for a Migration Services Basic Map.	GET /v1/orgs/{orgId}/connectors
status response string	Status of the preconnect command, includes: Requested	POST /v1/orgs/{orgId}/connectors/{connectorId}/preconnect GET /v1/orgs/{orgId}/connectors/{connectorId}/preconnect/{commandId}
uiDecorations response array	Array of properties for a field on the Connection dialog for this Connector in TIBCO Scribe®. Properties include: inputType isRequired label options order propertyName	GET /v1/orgs/{orgId}/connectors/{id}/uioptions
uiName response string	User interface type that should be loaded in TIBCO Scribe® for the Connection dialog. Types include: ScribeOnline.GenericConnectionUI — Indicates that a call to /v1/orgs/{orgId}/connectors/{id}/uioptions returns a definition of the Connection UI. ScribeOnline.Views.OAuthConnectionUI — Indicates that OAuth should be used. Some Connectors have a custom user interface with a unique name.	GET /v1/orgs/{orgId}/connectors
uiVersion response string	Version of the user interface for the Connection dialog.	GET /v1/orgs/{orgId}/connectors
vendorName response string	Name of the company that created the Connector, such as TIBCO Software Inc..	GET /v1/orgs/{orgId}/connectors
version response string	Version of the Connector.	GET /v1/orgs/{orgId}/connectors/{id}/uioptions GET /v1/orgs/{orgId}/connectors/{connectorId}/version PUT /v1/orgs/{orgId}/connectors/{connectorId}/version

See

Endpoints

API Basics