Data Payloads and Supported Media Types

Requests that use POST/PUT methods may use or require a data payload that must be supplied in the body of the message (for example, completing a work item when a user has updated the associated data).

The BPM REST API supports XML and JSON media types for the content of request and response messages. The HTTP headers that can be used to specify the required media types in a request are:

Header name Status Description
Content-Type Optional Indicates the media type of the request body. Supported types are:
  • application/xml - for XML content
  • application/json - for JSON content (default value)
Accept Optional Indicates the media types that are acceptable for use in the response message. Supported types are:
  • application/xml - for XML content
  • application/json - for JSON content

TIBCO recommends that you set this header explicitly to the value you require, because otherwise different browsers and different REST clients exhibit different default behaviors.

If the BPM runtime cannot respond with the requested media type, a 406 Not Acceptable HTTP status code is returned.