Stop a Scheduler v2
post
/jderest/v2/scheduler/stopScheduler
Stop the scheduler on a this server. 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(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 scheduler services.
Root Schema : SchedulerRequest
Type:
objectThe input to the scheduler services.
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.
-
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.
-
jobEndpointRequested(optional):
string
Endpoint or service name to use for scheduling.
-
jobServicePath(optional):
array jobServicePath
The service path for the job to be scheduled.
-
numberOfTests(optional):
integer(int32)
-
password(optional):
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
primaryHost(optional):
object SchedulerRequest
The input to the scheduler services.
-
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.
-
scheduleCronString(optional):
string
The cron string that provides r the schedule of the requested endpoint.
-
scheduleIntervalMinutes(optional):
integer(int32)
The interval in minutes for the desired endpoint to be scheduled.
-
schedulerHosts(optional):
array schedulerHosts
A list of scheduler hosts.
-
schedulerServices(optional):
array schedulerServices
A list of scheduler services.
-
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.
Nested Schema : jobServicePath
Type:
arrayThe service path for the job to be scheduled.
Show Source
Nested Schema : schedulerHosts
Type:
arrayA list of scheduler hosts.
Show Source
-
Array of:
object SchedulerRequest
The input to the scheduler services.
Nested Schema : schedulerServices
Type:
arrayA 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:
objectThe input to the scheduler services where a list is requested.
Show Source
-
environment(optional):
string
-
role(optional):
string
-
serviceEndpoint:
string
Endpoint or service name to use for scheduling.
-
username(optional):
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:
objectError 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:
objectError 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 stop scheduler request, , which stops one scheduler instance, and does clear any scheduled notifications or orchestrations from the scheduler. If the scheduler restarts, the jobs will resume.
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 for all calls to scheduler services.
curl -X POST -H "Content-Type:application/json" http://ais_server_host/jderest/v2/scheduler/stopScheduler -d
{
"token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU="
}
Example Response
The following example shows the contents of the response body.
{
"schedulerstopped": "http://ais_server_host"
}