Start a Scheduled Job v2
post
/jderest/v2/scheduler/startjob/{endpoint}
Start a job using the name or OMW object name of the notification or orchestration. 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
Path Parameters
-
endpoint: string
The notification or orchestration OMW object name or it's name
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" ]
Top level object for all AIS service requests, containing authentication information applicable to all services.
Root Schema : AISRequest
Type:
object
Top level object for all AIS service requests, containing authentication information applicable to all 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.
-
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.
-
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.
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 scheduler startjob request, which starts only the individual job requested.
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/startjob/NTF_1708250001TOOLS -d { "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=" }
Example Response
The following example shows the contents of the response body.
{ "startedcount": "1", "jobsstarted": [ { "jobBaseUrl": "ais_server_url", "jobEndpointRequested": "NTF_1708250001TOOLS", "jobLastExecutionTimeMillis": 0, "jobServicePath": [ "jderest", "v2", "notification" ], "jobNextFireTime": "2017-08-25 19:31:13 702", "jobTotalExecutions": 0, "jobTotalErrors": 0, "jobConsecutiveErrors": 0, "jobPercentageErrors": 0, "serviceLongEndpoint": "DemoNotification", "omwServiceDescription": "DemoNotification", "omwScheduleDescription": "Run Once Daily", "scheduleIntervalMinutes": 1440, "jobgroup": "SCH_1708140001TOOLS", "jobname": "NTF_1708250001TOOLS" }] }