Marketplace

The TIBCO Scribe® Marketplace is a portal used to provide Connectors to TIBCO Scribe® users. Use these Connectors to perform specific tasks within TIBCO Scribe® or to allow your business to work with other software applications. Use the Marketplace endpoint to view a list of TIBCO Scribe® Certified Connectors. See Marketplace TIBCO Scribe® Certified Connectors.

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 Marketplace Endpoints — Review the field definition table below the list of Endpoints for detailed field level information.

Endpoints

/v1/marketplace/connectors

Return a list of Marketplace Connectors

Fields For Marketplace Endpoints

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

Name Type Data Type	Description	Endpoints
Parameters
filterByDescription query string	Text contained in the Connector description. Use this field to filter the list. When used in conjunction with filterByName, both fields are used in the filter with an OR. For example, if filterByName contains Microsoft and filterByDescription contains Customer Connectors with either Microsoft in the name or Customer in the description are returned.	GET /v1/marketplace/connectors
filterByName query string	Name of the Connector. Use this field to filter the list. When used in conjunction with filterByDescription, both fields are used in the filter with an OR. For example, if filterByName contains Microsoft and filterByDescription contains Customer Connectors with either Microsoft in the name or Customer in the description are returned.	GET /v1/marketplace/connectors
orgId query integer	Unique ID for each Organization. Required to include Private Managed Connectors in results. If no OrgId is provided, the endpoint returns all public Connectors installed in any Organization where the user is a member.	All
Response
adapterTypeId response string	The GUID / UUID of the Connector.	GET /v1/marketplace/connectors
agentId response string	The GUID / UUID of the Agent where the Connector is being installed. See agentInstallStatuses.	GET /v1/marketplace/connectors
agentInstallStatuses response array	Array that contains the installation status for each Agent during the installation process for this Connector. Connector files are installed in the Agent folder. The default location is ..\Program Files (x86)\Scribe Software\TIBCO Scribe® Online Agent\Connectors Fields include: agentId agentName status	GET /v1/marketplace/connectors
agentName response string	Name of the Agent where the Connector is being installed. Agent name is based on the machine name of the computer where the Agent is installed. See agentInstallStatuses.	GET /v1/marketplace/connectors
certificationDate response string	Date and time in UTC time that this Connector was certified by TIBCO Scribe®.	GET /v1/marketplace/connectors
contactUrl response string	Contact URL provided by the Connector vendor for Connectors that require payment.	GET /v1/marketplace/connectors
description response string	Vendor-specified description of the Connector.	GET /v1/marketplace/connectors
installed response boolean	Indicates whether or not this Connector has been installed for the specified Organization. true — Connector has been installed. false — Connector has not been installed. Note: Depending on network connectivity and whether or not Agents are running, there could be a delay in completing the Connector installation.	GET /v1/marketplace/connectors
isAssociated response boolean	Indicates whether or not this Connector is installed in your Organization. true — Connector is installed. false — Connector is not installed.	GET /v1/marketplace/connectors
isFree response boolean	Indicates whether this Connector is free or must be purchased. true — Connector is free. false — Connector must be purchased.	GET /v1/marketplace/connectors
isHotFix response boolean	Indicates whether the specified version of the Connector is a Hotfix. See Marketplace. true — Connector version is a HotFix. false — Connector version is a not HotFix.	GET /v1/marketplace/connectors
isLocked response boolean	Indicates whether the specified version of the Connector is locked and cannot be updated. See Marketplace. true — Connector version is locked. false — Connector version is unlocked.	GET /v1/marketplace/connectors
isisSource response boolean	Indicates whether or not this Connector can be used in a Source Connection for an Integration Map. true — Supports Integration Source Connections. false — Does not support Integration Source Connections.	GET /v1/marketplace/connectors
isisTarget response boolean	Indicates whether or not this Connector can be used in a Target Connection for an Integration Map. true — Supports Integration Target Connections. false — Does not support Integration Target Connections.	GET /v1/marketplace/connectors
ismsSource response boolean	Indicates whether or not this Connector can be used in a Source Connection for a Migration Services Map. true — Supports Migration Source Connections. false — Does not support Migration Source Connections.	GET /v1/marketplace/connectors
ismsTarget response boolean	Indicates whether or not this Connector can be used in a Target Connection for a Migration Services Map. true — Supports Migration Target Connections. false — Does not support Migration Target Connections.	GET /v1/marketplace/connectors
isPublic response boolean	Connectors can be Public or Managed. Managed Connectors are not available in the Marketplace, but a Customer can be given access to the Connector privately. Indicates whether or not this Connector is publicly available. true — Connector is publicly available. false — Connector is not publicly available.	GET /v1/marketplace/connectors
isrsSource response boolean	Indicates whether or not this Connector can be used in a Source Connection for a Replication Services Solution. true — Supports Replication Services Source Connections. false — Does not support Replication Services Source Connections.	GET /v1/marketplace/connectors
isrsTarget response boolean	Indicates whether or not this Connector can be used in a Target Connection for a Replication Services Solution. true — Supports Replication Services Target Connections. false — Does not support Replication Services Target Connections.	GET /v1/marketplace/connectors
lastModificationDate response string	Last date the specified version of the Connector was modified. See Marketplace.	GET /v1/marketplace/connectors
link response string	Link to the Vendor's website or to the Help page for the Connector.	GET /v1/marketplace/connectors
logo response string	This field is not used.	GET /v1/marketplace/connectors
logoUrl response string	Link and file ID of the location of the Connector logo on the TIBCO Scribe® server.	GET /v1/marketplace/connectors
name response string	Name of the Connector.	GET /v1/marketplace/connectors
providerName response string	Name of the Connector vendor, such as TIBCO Software Inc. or Silverpop.	GET /v1/marketplace/connectors
requiresJava response boolean	This field is not used.	GET /v1/marketplace/connectors
status response string	Installation status of the Connector during the installation process on the Agent. Statuses include: SendingCommandToTheAgent AgentReceivedCommand AgentDownloadingConnectorUpdate AgentServiceRestarting InstallFailed InstallTimedOut Installed See agentInstallStatuses.	GET /v1/marketplace/connectors
supportsCloudAgents response boolean	Indicates whether or not this Connector supports the Cloud Agent. true — Connector supports Cloud Agents. false — Connector does not support Cloud Agents.	GET /v1/marketplace/connectors
version response integer	Version number of the Connector. See Marketplace. Version number is composed of several integer fields as follows: major minor build revision majorRevision minorRevision	GET /v1/marketplace/connectors

See

Endpoints

API Basics