API Basics
The following sections provide information for using the TIBCO Cloud™ Integration API:
- Enabling API Access
- Authentication
- Creating Resources
- Reading Resources
- Updating Resources
- Deleting Resources
- Command Objects
Additional Information
- Timeouts — Requests to the TIBCO Cloud Integration API time out after 120 seconds.
- HTTP Requests — All HTTP calls to the API are redirected to HTTPS.
- Subscription Locator — All HTTP calls to the API, except the
GET /v1/userinfocall, require a Subscription Locator to identify the organization you want to access. If you enter a 0 or do not provide a Subscription Locator, the API defaults to the Subscription Locator of the organization associated with your OAuth Token. - Required Roles — Any role requirements imposed in the TIBCO Cloud Integration User Interface are also imposed by theTIBCO Cloud Integration API.
- Model Data — To see the enumerated data types for the values in a model, click the Schema link in the TIBCO Cloud Integration Swagger API documentation for the method. See the Swagger page to view the examples.
- Name parameters —
- Do not support wild cards.
- Are not case-sensitive.
- Object naming — TIBCO Cloud Integration uses the lower camel case naming convention for JSON data across the TIBCO Cloud Integration API and endpoints.
For example, the convention to write the object holding a last name would be:
lastName. - Timestamps — Datetime field values are in Epoch time.
- App types — App type names used in the API correspond to the following in the User Interface:
bw— TIBCO BusinessWorks apps, which fall under the Integrate category.flogo— TIBCO Flogo® apps, which fall under the Develop category.node— Node.js apps, which fall under the Develop category.scribe— On schedule, On event, or Data Replication apps, which fall under the Connect or TIBCO Cloud™ Integration - Connect category.Note: The scribe app type is returned only for theGET /v1/subscriptions/{subscriptionLocator}/monitoringmethod. All other methods for this app type are accessed using the TIBCO Cloud Integration - Connect API. See the Developer Portal for more information.
- App Upgrades — TIBCO Cloud™ infrastructure supports Integrate, Develop, and Node.js apps on seamless upgrade paths. When one of these app is upgraded, the new app version is started up before the old version is stopped.
- Fault Tolerance — TIBCO Cloud™ Integration app instances are fault-tolerant. TIBCO® Cloud Integration checks if app instances are still running. If it detects that an app instance has failed, it will automatically restart a new instance. For example, if an app's desired instance count is two, and one of the instances stops running, a second instance will be automatically started.
TIBCO Cloud Integration - Connect has a separate API that allows you to manage objects for that capability. Note that for this API, the orgId field determines which organization you are accessing, while in the TIBCO Cloud Integration API the subscriptionLocator field determines the organization you are accessing.