Resource URIs for the IBM BPM resources

The REST resource URIs have the following format:

http://{host}:{port}/rest/{component}/v1/{resource}?{query}

Where:

{host}:{port}

The host address and port of the REST API endpoint, for example, MyProcessServer:9080.

rest/{component}

The configurable context root, including one of the following IBM BPM REST component names:

• /rest/bpm/htm
• rest/bpm/bfm
• /rest/bpm/federated/htm
• /rest/bpm/federated/bfm
• /rest/bpm/wle

/v1

The version of the REST resource. REST resources might be updated by IBM, however the changes will always be compatible with existing REST client applications. The following changes to REST resources are considered to be compatible changes and must be expected by client applications:

• Support for new MIME types or resource representations.
• The addition of new properties to existing JSON objects that are returned to a client. These properties are ignored by clients that are not at the latest level.

{resource}

The hierarchically-organized part of the resource identification.

{'query'}

The non-hierarchical part of the resource identification. Typically, this part of the resource identification consists of parameters that are passed to the method implementation.