Version 1 and Version 2 AIS Services (Endpoints)
The AIS Server exposes endpoints that:
Enable access to EnterpriseOne data and applications.
Produce JSON responses.
Each endpoint provides a particular service, referred to as an AIS service, that AIS clients can use to interact with EnterpriseOne applications.
Table 1 describes version 1 AIS services available on the AIS Server. These services are accessed using the following URL path:
https://<AIS_Server>:<Port>/jderest/<endpoint>
With EnterpriseOne Tools release 9.2.1.2 comes the availability of version 2 AIS
services. All version 1 AIS services are included in version 2 AIS services. Table 2 describes additional AIS services available in version 2. All paths
to version 2 AIS services include /v2 in the URL path, for example:
https://<AIS_Server>:<Port>/jderest/v2/<endpoint>
For a detailed description of the methods, operations, and parameters in each AIS service, see the JD Edwards EnterpriseOne Tools REST API for the Application Interface Services Server Guide reference documentation.
Endpoint URI |
HTTP Method |
Description of Service |
|---|---|---|
/defaultconfig |
GET |
The response will include information about the AIS Server including the release level, EnterpriseOne HTML Server configuration, and capabilities list. The capabilities that are available on the AIS Server depend on the EnterpriseOne Tools release applied to the AIS Server. If you are using the latest AIS Client Java API with up-to-date capabilities to develop AIS client applications, you need to make sure the AIS Server is on the latest EnterpriseOne Tools release. See 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. |
/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 "Configuring an Orchestration" in the JD Edwards EnterpriseOne Tools Orchestrator Guide for more information about creating orchestrations that use service requests to invoke EnterpriseOne applications. |
/preference (Release 9.2.0.2) |
POST |
Allows management of preference records in the User Overrides Table (F98950). |
/discover (Release 9.2.1)* |
POST |
Request a list of available orchestrations for that user. |
/admin (Release 9.2.1)* |
POST |
Perform administrative operations such as clearing caches. The user must be configured in the Admin List in Server Manager to use this service. |
/udomanager/<operation> (Release 9.2.1)* |
POST |
Request details about UDO objects. Valid operations are WATCHLIST and QUERY. |
/watchlist (Release 9.2.1)* |
POST |
Execute an EnterpriseOne watchlist. |
*These endpoints are NOT supported in the JDE Mobile Framework API for developing EnterpriseOne mobile enterprise applications.
Endpoint URI |
HTTP Method(s) |
Description of Service |
|---|---|---|
/appstack/next |
GET POST |
Executes stateful calls to get the next set of records in a grid. |
/dataservice/next |
GET POST |
Executes stateful calls to get the next set of records in a grid. |
/dataservice/table/<tableName> |
GET |
Executes simple queries over EnterpriseOne tables. |
/dataservice/view/<viewName> |
GET |
Executes simple queries over EnterpriseOne business views. |
/formservice/<application>/<form> |
GET |
Executes simple queries in EnterpriseOne forms. |
/formservice/<application>/<form>/<version> |
GET |
Executes a simple query in a form in a particular EnterpriseOne application version. |
/message |
POST |
Sends an Enterpriseone message (PPAT) to external email systems or the EnterpriseOne Work Center email system |