Get the Completion Status of a Report v2
post
/v2/report/status
Use the batch job number to get the completion status of the report.
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" ]
Input used to check the status or retrieve the output of a requested report.
Root Schema : PostProcessUBERequest
Type:
objectInput used to check the status or retrieve the output of a requested report.
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.
-
executionServer:
string
The execution server of the report. The default server will be used if a value is not set.
-
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.
-
jobNumber(required):
integer(int32)
The job number of the report.
-
language:
string
For XMPL reports this indicates the language of the output to retreive. If blank will default to the users language.
-
logType:
string
Allowed Values:
[ "BOTH", "JDE", "JDEDEBUG" ]If logs are requested, specify the type of logs you want. -
outputType:
string
Allowed Values:
[ "FTP" ]Complete if the report output will be sent to a third-party location. -
password:
string
The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
-
pathExt:
string
The directory on a third-party FTP server where you want the output to be sent.
-
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.
-
softCodingRecordKey:
string
Specify the soft coding record to identify the third-party system.
-
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.
-
viewType:
string
Allowed Values:
[ "PDF", "CSV", "OSA", "LOG" ]Specify the output to send to the third-party system.
Response
Supported Media Types
- application/json
200 Response
Successful Execution
Root Schema : UBEProcessingResponse
Type:
objectDetails of the status of the report.
Show Source
-
actualServer:
string
For Virtual Batch Queue use, this is the actual server the UBE executed in.
-
environment:
string
The environment where the report was run.
-
executionServer:
string
The server on which the report was executed.
-
fileName:
string
The filename of the file transferred if output was requested.
-
jobNumber:
integer(int32)
The job number of the report.
-
jobStatus:
string
Allowed Values:
[ "D-Done", "E-Error", "H-Hold", "P-Processing", "S-In Queue", "W-Waiting" ]The status of the report. -
lastDate:
string
The date of last activity for the report in yyyyMMdd format.
-
lastModifiedUser:
string
The last modified user ID.
-
lastTime:
string
The time of last activity for the report in hhmmss 24 hour format.
-
message:
string
A detailed message in case of errors.
-
objectType:
string
The type of the object. UBE is the default for a report.
-
oid:
string
The concatenated report and version name.
-
queueName:
string
The name of the queue in which the report was run.
-
reportName:
string
The name of the report.
-
reportVersion:
string
The version of the report.
-
submitDate:
string
The date the report was submitted in yyyyMMdd format.
-
submitTime:
string
The time the report was submitted in hhmmss 24 hour format.
-
user:
string
The user who submitted the report.
-
xmlpJobGUID:
string
The job GUID for XMLP reports.
-
xmlpOutputDefinitions:
array xmlpOutputDefinitions
A list of all outputs from an XMLP job.
Nested Schema : xmlpOutputDefinitions
Type:
arrayA list of all outputs from an XMLP job.
Show Source
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:
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:
objectError 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 report status request to determine the status of a submitted report. You can also pass executionServer to find the job on a specific server. The token value is from a prior call to the tokenrequest service to establish a session.
curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/report/status -d
{
"token": "044TjRJRrdxJrpBeFs/CaMrJettewfPIz0Fru5FEP/LAgI=MDE5MDEzOTA5NDM1Nzk1ODQ0NjIzODc5OTEwLjEzOS4xMTAuMzgxNTA5NjQxNzAwMjAx",
"jobNumber":1160
}
Example Response
The following example shows the contents of the response body.
{
"reportName": "R064011",
"reportVersion": "XJDE0001",
"jobNumber": 1160,
"executionServer": "myEntServer",
"jobStatus": "D",
"objectType": "UBE",
"user": "JDE",
"environment": "JDV920",
"submitDate": "20171102",
"lastDate": "20171102",
"submitTime": 170157,
"lastTime": 170158,
"oid": "R064011_XJDE0001",
"queueName": "QBATCH"
}