The basic foundation of REST API is an ApiObject. The ApiObject provides an abstraction of TES objects (thereby hiding the implementation details).
is the "root" class and is extended by the base objects such as
. The base classes are extended by additional objects such as
. A list of currently supported objects in REST API is described in Appendix (A).
has fields for maintaining the integrity of the TES data Model. The current list includes:
has a default behavior of CRUD operations. The list of operations currently includes:
Create Api object – create()
Retrieve Api object(s) – get(), getList()
Update Api object – update()
Delete Api object – delete()
Some REST API objects may override the basic behavior of the CRUD methods. They may also support additional methods (e.g. convenience methods).
A list of selected methods in REST API is described in Appendix (B).
Some commonly used objects and methods from REST API are covered in this guide.