REST API

The TIBCO BPM Enterprise REST API provides RESTful interfaces to BPM web services.

Using the REST API, a client application can invoke BPM services using simple HTTP methods and intuitive URIs that identify BPM resources and the operations to be performed on them. Documentation for the REST API is provided in the API Explorer. Access the API Explorer as follows:

Procedure

  1. Enter the following URL in your browser: 
    protocol://host:port/apps/login

    where:

    • protocol is the communications protocol being used, either http or https. This was specified at installation.
    • host is the DNS name or IP address of the server hosting the TIBCO BPM Enterprise runtime.
    • port is the port being used. The default value is 80.
  2. Log in with a valid TIBCO BPM Enterprise username and password.
  3. Click .
  4. Click API Explorer.

    Note: To access the REST API, you need to be logged in.
    Note: For additional details of each API, refer to the specifications of that API.

    For more details, refer to the authentication section below.