Jump to

• Request
• Response
• Examples

FTP Report Output v2

post

/jderest/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(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 Request

  Allowed Values: [ "monitorRequest", "monitorRequestIO" ]

Body ()

Input used to check the status or retrieve the output of a requested report.

Root Schema : PostProcessUBERequest

Type: object

Input used to check the status or retrieve the output of a requested report.

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.
• executionServer(optional): string
  The execution server of the report. The default server will be used if a value is not set.
• 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.
• jobNumber: integer(int32)
  The job number of the report.
• language(optional): string
  For XMPL reports this indicates the language of the output to retreive. If blank will default to the users language.
• logType(optional): string
  Allowed Values: [ "BOTH", "JDE", "JDEDEBUG" ]

  If logs are requested, specify the type of logs you want.
• outputType(optional): string
  Allowed Values: [ "FTP" ]

  Complete if the report output will be sent to a third-party location.
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• pathExt(optional): string
  The directory on a third-party FTP server where you want the output to be sent.
• 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.
• softCodingRecordKey(optional): string
  Specify the soft coding record to identify the third-party system.
• 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.
• viewType(optional): string
  Allowed Values: [ "PDF", "CSV", "OSA", "LOG" ]

  Specify the output to send to the third-party system.

{
    "type":"object",
    "required":[
        "jobNumber"
    ],
    "properties":{
        "environment":{
            "type":"string",
            "description":"Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used."
        },
        "role":{
            "type":"string",
            "description":"The role to use for login. If not specified, the default role configured for the AIS Server will be used."
        },
        "jasserver":{
            "type":"string",
            "description":"The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used."
        },
        "token":{
            "type":"string",
            "description":"The AIS token, which is required if other authentication methods are not being used."
        },
        "deviceName":{
            "type":"string",
            "description":"An identifier for the device making the service call. If not provided, the requesting IP address is used."
        },
        "psToken":{
            "type":"string",
            "description":"Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server."
        },
        "username":{
            "type":"string",
            "description":"JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used."
        },
        "password":{
            "type":"string",
            "description":"The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used."
        },
        "jobNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The job number of the report."
        },
        "executionServer":{
            "type":"string",
            "description":"The execution server of the report. The default server will be used if a value is not set."
        },
        "outputType":{
            "type":"string",
            "description":"Complete if the report output will be sent to a third-party location.",
            "enum":[
                "FTP"
            ]
        },
        "softCodingRecordKey":{
            "type":"string",
            "description":"Specify the soft coding record to identify the third-party system."
        },
        "viewType":{
            "type":"string",
            "description":"Specify the output to send to the third-party system.",
            "enum":[
                "PDF",
                "CSV",
                "OSA",
                "LOG"
            ]
        },
        "language":{
            "type":"string",
            "description":"For XMPL reports this indicates the language of the output to retreive. If blank will default to the users language."
        },
        "pathExt":{
            "type":"string",
            "description":"The directory on a third-party FTP server where you want the output to be sent."
        },
        "logType":{
            "type":"string",
            "description":"If logs are requested, specify the type of logs you want.",
            "enum":[
                "BOTH",
                "JDE",
                "JDEDEBUG"
            ]
        }
    },
    "description":"Input used to check the status or retrieve the output of a requested report."
}

Back to Top

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

Body ()

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.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

500 Response

Server Failed to Process Request

Body ()

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.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

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"
}

Back to Top