Execute a Watchlist v1
post
/jderest/watchlist
Execute the specified Watchlist. The response includes record count as well as Watchlist definition metadata.
Request
Supported Media Types
- application/json
Header Parameters
-
jde-AIS-Auth(optional): string
Token
-
jde-AIS-Auth-Device(optional): string
Device Name
-
jde-AIS-MonitorOnStart(optional): boolean
Monitor on Start
-
jde-AIS-MonitorRequest(optional): string
Monitor RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
The input to the Watchlist service.
Root Schema : WatchListRequest
Type:
object
The input to the Watchlist service.
Show Source
-
deviceName(optional):
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
environment(optional):
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
forceUpdate(optional):
boolean
Force the Watchlist to re-run fetching the data from the database instead of cache.
-
jasserver(optional):
string
The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
-
password(optional):
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
psToken(optional):
string
Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
-
role(optional):
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
setDirtyOnly(optional):
boolean
Indicate that the Watchlist is dirty (but do not re-run it), so data will be fetched from the database not the cache next time.
-
token(optional):
string
The AIS token, which is required if other authentication methods are not being used.
-
username(optional):
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
-
watchlistId(optional):
string
The id of the Watchlist to execute. Either the Watchlist id or object name is required.
-
watchlistObjectName(optional):
string
The Object Management Workbench (OMW) object name of the watchlist. Either this name or the id is required.
Response
Supported Media Types
- application/json
200 Response
Successful Execution
400 Response
Bad Request - Invalid JSON Input
403 Response
Authorization Failure
415 Response
Invalid Content-Type Header - Must use application/json
444 Response
Invalid Token
Root Schema : ServiceErrorResponse
Type:
object
Error Response
Show Source
-
errorText(optional):
string
-
exception(optional):
string
The class of the exception if an exception was thrown.
-
exceptionId(optional):
string
ExceptionId, only if an exception record was written to the F980060
-
message(optional):
string
Details about the error.
-
status(optional):
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp(optional):
string
The timestamp indicating the time the error message was returned.
-
type(optional):
string
Optional type of error
-
userDefinedErrorText(optional):
string
Optional error text added to an orchestration step.
500 Response
Server Failed to Process Request
Root Schema : ServiceErrorResponse
Type:
object
Error Response
Show Source
-
errorText(optional):
string
-
exception(optional):
string
The class of the exception if an exception was thrown.
-
exceptionId(optional):
string
ExceptionId, only if an exception record was written to the F980060
-
message(optional):
string
Details about the error.
-
status(optional):
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp(optional):
string
The timestamp indicating the time the error message was returned.
-
type(optional):
string
Optional type of error
-
userDefinedErrorText(optional):
string
Optional error text added to an orchestration step.
Examples
Example Request
The following shows an example of a Watchlist request. The token passed in this example was received from a separate token request.
curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/watchlist/ -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=", "watchlistObjectName":"OVW0801A_1606210001CUST" }
Example Response
The following example shows the contents of the response body.
Threshold Type is only returned in releases where that field is supported.
{ "watchListOBNM": "P01012", "name": "Ab All in Name", "formtitle": "Work With Addresses", "queryname": "All", "rowcount": { "records": 10, "modifier": false, "gridrows": 11 }, "lastRunTime": 1479146149105, "description": "Has All in Name", "warningThreshold": 3, "criticalThreshold": 10, "queryObjectName": "QRY01012B_1602160001CUST", "maxRecords": 200, "formOID": "P01012_W01012B_ZJDE0001", "isCritical": true, "thresholdType": "ASC", "deprecated": true }