This chapter contains the following topics:
With the Application Interface Services (AIS) Client Java API, you can use any development tool that works with Java APIs to create custom applications that interact with EnterpriseOne. Whether you need a simplified kiosk application for your warehouse, an application that composites features from multiple EnterpriseOne applications into a single purpose-built interface, or an application for the latest wearable device, the AIS Client Java API enables you to choose the development platform that fits your needs.
The AIS Client Java API enables developers to create applications, referred to as AIS clients, that communicate with the JD Edwards EnterpriseOne AIS Server. The AIS Server is a REST services server that when configured with the EnterpriseOne HTML Server, enables access to EnterpriseOne forms and data. The AIS Client Java API provides classes and methods that enable AIS clients to manage (create, read, update, delete) data in EnterpriseOne through REST services.
Note:
The EnterpriseOne HTML Server also executes some Java processing; therefore, it is sometimes referred to as the Java Application Server (JAS). The terms HTML Server and JAS Server are synonymous.See Also:
"EnterpriseOne Application Interface Services (AIS) Server" in the JD Edwards EnterpriseOne Tools System Overview Guide for an overview and illustration of the AIS Server architecture.
The AIS Server exposes endpoints that:
Enable access to EnterpriseOne data and applications.
Produce JSON responses.
Each endpoint provides a particular service that AIS clients can use to interact with EnterpriseOne applications. Table 1-1 describes the services that the AIS Server endpoints provide. The AIS Client Java API enables easy access to all endpoints; all of the communication is handled for you. You can access AIS Server endpoints using this URL format: http://<server>:<port>/jderest/<URI>
All POST calls expect JSON formatted request payloads.
When you use the API, you work with Java objects, not the JSON strings. But it is still important to understand how the data is transmitted. The following chapters in this guide describe in detail how to use the services the endpoints provide and the Java objects required to use them:
Table 1-1 Endpoint URIs for Accessing EnterpriseOne Applications and Data
| Endpoint URI | HTTP Method | Description of Service |
|---|---|---|
|
/defaultconfig |
GET |
The response will include information about the AIS Server including the release level, JAS Server configuration, and capabilities list. The AIS Server has different capabilities based on the version of the EnterpriseOne Tools release applied to the AIS Server. Therefore, even if the version of the AIS Client Java API has the latest, up-to-date capabilities, the AIS Server may not. See Understanding AIS Server Capabilities for a list of capabilities available by EnterpriseOne Tools release. |
|
/tokenrequest |
POST |
Based on the input, the response will contain login information including a login token and user details. |
|
/tokenrequest/logout |
POST |
Based on the input (AIS token), the response will be a code of 200 if successful and 500 if the logout fails. |
|
/formservice |
POST |
Based on the input, the response will contain a JSON representation of the form requested. |
|
/batchformservice |
POST |
Based on the input, the response will contain a JSON representation of all of the forms requested. |
|
/file/gettext |
POST |
Based on the input, the response will contain the text for the first text media object. |
|
/file/updatetext |
POST |
Base on the input, the response will contain the status of the text update. |
|
/file/list |
POST |
Based on the input, the response will contain the list of media objects for the structure and key requested. |
|
/file/upload |
POST (Multi-Part Form) |
The response will contain the details of the uploaded file, including the media object sequence number. |
|
/file/download |
POST |
This response will contain a multi-part form including the data for the attachment. |
|
/file/addurl |
POST |
The response will contain the details of the URL media object, including the URL text and the sequence number (Release 9.1.5.2). |
|
/file/delete |
POST |
The response indicates the success or failure to delete the media object for the sequence number passed in. |
|
/appstack |
POST |
Based on the input, the response will contain the current form open on the stack and any stack related information. |
|
/poservice |
POST |
Based on the input, the response will contain the processing option values for the requested application and version. |
|
/log |
POST |
Base on the input, the AIS Server will write a log entry with the information passed to the log service. |
|
/jargonservice |
POST |
Based on the input and the logged in users language, the correct item description will be returned for each data item provided. |
|
/dataservice |
POST |
Based on the input, the response will contain either a count or a list of records matching a query of a table or view. |
|
/orchestrator/<Name> |
POST |
Based on the input and the URI, the requested orchestration will run. See the JD Edwards EnterpriseOne Tools IoT Orchestrator Guide for more information about creating orchestrations that use form service requests to invoke EnterpriseOne applications. |