API Basics

The following sections provide information for using the TIBCO Scribe® API:

Additional Information

  • Timeouts - Requests to the TIBCO Scribe® API timeout after 90 seconds.
  • HTTP Requests - All HTTP calls to the API are redirected to HTTPS.  
  • Required Roles - Any role requirements imposed in the TIBCO Scribe® User Interface are also imposed by the TIBCO Scribe® API.
  • Model Data - To see the enumerated data types for the values in a model, click the Model link in the TIBCO Scribe® Swagger API documentation for the method. See Endpoints to view the examples.
  • Invited User -
    • An invited User is a user who has a pending invitation to join an Organization. You can delete and update the information about an invited User.
    • If you call the DELETE user method to delete a User who has an outstanding invitation, an error occurs.
  • Name parameters -
    • Do not support wild cards.
    • Are not case-sensitive.
  • Organizations -
    • If you want to retrieve failed records, set the IsSourceDataLocal property to false.
    • If you specify a parent Organization without API access, related child Organizations are returned.
  • Object naming - TIBCO Scribe® uses the lower camel case naming convention for JSON data across the TIBCO Scribe® API and endpoints.

    For example, the convention to write the object holding a first name would be: firstName

  • Organization ID - All HTTP calls to the API require an organization ID to identify the Organization you want to access except for the following: 
    • GET /v1/marketplace/connectors
    • GET /v1/orgs
    • POST /v1/orgs
    • GET /v1/users
    • PUT /v1/users
    • GET /v1/users/{userId}/alertsettings
    • PUT /v1/users/{userId}/alertsettings
    • GET /v1/users/invitations
    • PUT /v1/users/invitations

    Note: TIBCO Cloud Integration has a separate API that allows you to manage objects for the Integrate and Develop capabilities. For that API, the subscriptionLocator field determines the organization you are accessing. The two unique identifiers are not interchangeable. See TIBCO Cloud Integration - API help for additional information.

See

WEB API Overview

REST 101

Special Properties

How Do I...