List Scheduled Jobs v2
post
/v2/scheduler/list
List the status of all notifications and orchestrations that are scheduled to run. IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service for all calls to scheduler services.
Request
Supported Media Types
- application/json
Header Parameters
-
jde-AIS-Auth: string
Token
-
jde-AIS-Auth-Device: string
Device Name
-
jde-AIS-MonitorOnStart: boolean
Monitor on Start
-
jde-AIS-MonitorRequest: string
Monitor RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
The input to the scheduler services.
Root Schema : SchedulerRequest
Type:
object
The input to the scheduler services.
Show Source
-
deviceName:
string
An identifier for the device making the service call. If not provided, the requesting IP address is used.
-
environment:
string
Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
-
jasserver:
string
The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
-
jobEndpointRequested:
string
Endpoint or service name to use for scheduling.
-
jobServicePath:
array jobServicePath
The service path for the job to be scheduled.
-
password:
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
psToken:
string
Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
-
role:
string
The role to use for login. If not specified, the default role configured for the AIS Server will be used.
-
scheduleCronString:
string
The cron string that provides r the schedule of the requested endpoint.
-
scheduleIntervalMinutes:
integer(int32)
The interval in minutes for the desired endpoint to be scheduled.
-
schedulerHosts:
array schedulerHosts
A list of scheduler hosts.
-
schedulerServices:
array schedulerServices
A list of scheduler services.
-
token:
string
The AIS token, which is required if other authentication methods are not being used.
-
username:
string
JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
Nested Schema : jobServicePath
Type:
array
The service path for the job to be scheduled.
Show Source
Nested Schema : schedulerHosts
Type:
array
A list of scheduler hosts.
Show Source
-
Array of:
object SchedulerRequest
The input to the scheduler services.
Nested Schema : schedulerServices
Type:
array
A list of scheduler services.
Show Source
-
Array of:
object SchedulerService
The input to the scheduler services where a list is requested.
Nested Schema : SchedulerService
Type:
object
The input to the scheduler services where a list is requested.
Show Source
-
environment:
string
-
role:
string
-
serviceEndpoint(required):
string
Endpoint or service name to use for scheduling.
-
username:
string
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:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
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:
string
-
exception:
string
The class of the exception if an exception was thrown.
-
exceptionId:
string
ExceptionId, only if an exception record was written to the F980060
-
message:
string
Details about the error.
-
status:
string
Allowed Values:
[ "ERROR", "WARNING" ]
Status determined by exception handling -
timeStamp:
string
The timestamp indicating the time the error message was returned.
-
type:
string
Optional type of error
-
userDefinedErrorText:
string
Optional error text added to an orchestration step.
Examples
Example Request
The following shows an example of a scheduler list request, which shows a listing of Notifications and Orchestrations that are scheduled to run.
The token passed in this example was received from a separate token request. You can also use other supported authentication methods.
IMPORTANT: If using a token for authentication, you must get the token using the v2 tokenrequest service and use the token for calls to all scheduler services.
curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/scheduler/list -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=" }
Example Response
The following example shows the contents of the response body.
{ "jobs": [{ "jobname": "NTF_1903210002JDE", "jobgroup": "SCH_1903210001JDE", "jobVersion": "V2", "jobStartTimeUserLocale": "05/15/19 19:51:28", "jobStartTimeUTC": "2019-05-15T19:51:28.768Z", "jobNextFireTimeUserLocale": "05/15/19 19:51:28", "jobNextFireTimeUTC": "2019-05-15T19:51:28.768Z", "jobNextFireTime": "2019-05-15 12:51:28 768", "jobLastExecutionTimeMillis": 0, "jobLastExecutionDateTime": null, "jobTotalExecutions": 0, "jobTotalCompletions": 0, "jobTotalErrors": 0, "jobConsecutiveErrors": 0, "jobPercentageErrors": 0, "udoServiceType": "NOTIFICATION", "jobEndpointRequested": "NTF_1903210002JDE", "omwServiceDescription": "\"A\" Search Type LI AB LI WL 1 and 2", "jobServicePath": [ "jderest", "v2", "notification" ], "serviceShortEndpoint": "NTF_1903210002JDE", "serviceLongEndpoint": "Search Type LI AB LI WL 1 and 2", "jobLastExecutionBaseUrl": "ais_server_url", "jobBaseUrl": "ais_server_url", "omwScheduleDescription": "Minutely", "scheduleCronString": "0 0/1 * 1/1 * ? *", "scheduleIntervalMinutes": -1, "userName": "USER", "environment": "JDV920", "role": "*ALL" }], "scheduler": { "isResilient": false, "isStarted": true, "runningSinceUTC": "2019-05-15T19:51:28.790Z", "runningSinceUserLocale": "05/15/19 19:51:28", "schedulerInstanceJobsExecuted": 0 } }