FTP Report Output v2
post
/v2/external/ftp/report
Using the report job number, transfer the output of the report to an external FTP server.
Request
Supported Media Types
- application/json; charset=UTF-8
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; charset=UTF-8
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:
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 output request to transfer the output of a completed report using FTP. The softCodingRecordKey is the key to the soft coding/connection record; it contains the details and credentials of the FTP site. 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/external/ftp/report -d
{
"jobNumber": 1207,
"softCodingRecordKey":"MYFTP",
"executionServer": "myEntServer"
}
Example Response - Transfer Logs
The following example shows the contents of the response body.
{
"reportName": "R064011",
"reportVersion": "XJDE0001",
"jobNumber": 1207,
"executionServer": "myEntServer",
"jobStatus": "D",
"objectType": "UBE",
"user": "JDE",
"environment": "JDV920",
"submitDate": "20171102",
"lastDate": "20171102",
"submitTime": 170157,
"lastTime": 170158,
"oid": "R064011_XJDE0001",
"queueName": "QBATCH",
"fileName": "/FTP_Reports/R064011_XJDE0001_1207_PDF.pdf"
}
Example Request - Transfer Logs
The following example shows the contents of the response body.
curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/external/ftp/report -d
{
"jobNumber": 1207,
"softCodingRecordKey":"MYFTP",
"executionServer": "myEntServer"
"viewType":"LOG",
"logType":"BOTH"
}
Example Response - Transfer Logs
The following example shows the contents of the response body.
{
"reportName": "R064011",
"reportVersion": "XJDE0001",
"jobNumber": 1207,
"executionServer": "myEntServer",
"jobStatus": "D",
"objectType": "UBE",
"user": "JDE",
"environment": "JDV920",
"submitDate": "20171102",
"lastDate": "20171102",
"submitTime": 170157,
"lastTime": 170158,
"oid": "R064011_XJDE0001",
"queueName": "QBATCH",
"fileName": "/FTP_Reports/R064011_XJDE0001_1207_PDF.log"
}