REST API
The Representational State Transfer (REST) application programming interface (API) provides a way for external applications to query and update application data in Tivoli®'s process automation engine.
The REST API is part of the integration framework, and you can use it to integrate external applications with process automation engine applications. The REST API exposes business objects and integration object structures as REST resources. The REST API can provide resource data in either XML or JavaScript Object Notation (JSON) format. External applications can use the REST API to query and update application data.
REST API resources can be used without any configuration. The object structures that the REST API can query or update have a value of INTEGRATION in the Consumed By field in the Object Structures application.
The REST API supports create, query, update, and delete operations on resources by using standard HTTP GET, POST, PUT, and DELETE methods.
- REST API framework
The REST API is part of the integration framework and handles requests from external consumers. - Supported representations
The REST API supports XML and JSON as representations. Representations are supported by the implementation of serializer classes that are registered in system properties. - Resource handlers and URIs
The REST API provides access to business objects and integration object structures. A handler class for each resource is registered in a system property. - GET method
Use the GET method to retrieve business object resources and object structure resources. - PUT, POST, and DELETE methods
You can modify resources by using the HTTP PUT, POST, and DELETE methods. - Service method queries and updates
The REST API can be used to call methods that are exposed by application services. - HTTP header properties
Several HTTP header properties are relevant to the REST API. - Response codes
Messages from REST resources are propagated from the resource instance to the response. - Security in the REST API
Tivoli's process automation engine provides the authentication layer and authorization support for the REST API. - Customization of the REST API
The REST API can be customized to support different resource representations, such as the XHTML or Atom formats. It can also be customized by adding attributes to the representation of a business object resource or by changing the structure of a representation. - REST query parameters
By using query parameters, you can tailor and filter the responses. - REST system properties
System properties are available to configure how the REST API works for your specific requirements. - External service calls
External REST APIs can be called by using a configured HTTP end point.
