Jump to

• Request
• Response
• Examples

Send Report Output to External REST Service v2

post

/jderest/v2/external/rest/report

Send the output of a report to an external REST service (using multi-part/formdata).

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 Request

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

Body ()

Input to the external report service to send report output through a multi-part external REST call.

Root Schema : ExternalReport

Type: object

Input to the external report service to send report output through a multi-part external REST call.

Show Source

• additionalParts(optional): array additionalParts
  Any additional parts (not files) required to process the multi-part request.
• appendPath(optional): string
  Value to append to the endpoint defined in soft coding for identifying the path to the external endpoint.
• 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 for the report output.
• filePartName(optional): string
  The name of the multi-part part for the file (binary) attachment in the request.
• fireAndForget(optional): boolean
  When the value is true, the external call will run asynchronously in a thread, so that the call will return immediately without waiting for a response from the external service.
• headers(optional): array headers
  A set of name-value pairs to send to the external service as HTTP headers.
• ignoreResponse(optional): boolean
  DEPRECATED - Use FireAndForget - When the value is true, the external call will run asynchronously in a thread, so that the call will return immediately without waiting for a response from the external service.
• 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(optional): integer(int32)
  The job number for the report output.
• logType(optional): string
  Allowed Values: [ "BOTH", "JDE", "JDEDEBUG" ]

  If logs are requested, specify the type of logs you want.
• method: string
  The HTTP method to be used for the external call.
• parameters(optional): array parameters
  A set of name-value pairs to send to the external service as URL parameters.
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• postBody(optional): string
  A string to send as input in the body of the external REST service call.
• 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: string
  The key of the soft coding record configured to call the external service.
• sourceFileName(optional): string
  The name of the AIS local file to be sent to an external multi-part file upload request.
• targetFileName(optional): string
  The name of the file to send to the external REST, if different from the source file name.
• 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 file to send through an external REST service call.

{
    "type":"object",
    "required":[
        "method",
        "softCodingRecordKey"
    ],
    "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."
        },
        "softCodingRecordKey":{
            "type":"string",
            "description":"The key of the soft coding record configured to call the external service."
        },
        "postBody":{
            "type":"string",
            "description":"A string to send as input in the body of the external REST service call."
        },
        "parameters":{
            "type":"array",
            "description":"A set of name-value pairs to send to the external service as URL parameters.",
            "items":{
                "$ref":"#/definitions/NVPair"
            }
        },
        "headers":{
            "type":"array",
            "description":"A set of name-value pairs to send to the external service as HTTP headers.",
            "items":{
                "$ref":"#/definitions/NVPair"
            }
        },
        "ignoreResponse":{
            "type":"boolean",
            "description":"DEPRECATED - Use FireAndForget - When the value is true, the external call will run asynchronously in a thread, so that the call will return immediately without waiting for a response from the external service."
        },
        "method":{
            "type":"string",
            "description":"The HTTP method to be used for the external call."
        },
        "appendPath":{
            "type":"string",
            "description":"Value to append to the endpoint defined in soft coding for identifying the path to the external endpoint."
        },
        "additionalParts":{
            "type":"array",
            "description":"Any additional parts (not files) required to process the multi-part request.",
            "items":{
                "$ref":"#/definitions/MultiPart"
            }
        },
        "filePartName":{
            "type":"string",
            "description":"The name of the multi-part part for the file (binary) attachment in the request."
        },
        "sourceFileName":{
            "type":"string",
            "description":"The name of the AIS local file to be sent to an external multi-part file upload request."
        },
        "targetFileName":{
            "type":"string",
            "description":"The name of the file to send to the external REST, if different from the source file name."
        },
        "jobNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The job number for the report output."
        },
        "executionServer":{
            "type":"string",
            "description":"The execution server for the report output."
        },
        "viewType":{
            "type":"string",
            "description":"Specify the output file to send through an external REST service call.",
            "enum":[
                "PDF",
                "CSV",
                "OSA",
                "LOG"
            ]
        },
        "logType":{
            "type":"string",
            "description":"If logs are requested, specify the type of logs you want.",
            "enum":[
                "BOTH",
                "JDE",
                "JDEDEBUG"
            ]
        },
        "fireAndForget":{
            "type":"boolean",
            "description":"When the value is true, the external call will run asynchronously in a thread, so that the call will return immediately without waiting for a response from the external service."
        }
    },
    "description":"Input to the external report service to send report output through a multi-part external REST call."
}

Nested Schema : additionalParts

Type: array

Any additional parts (not files) required to process the multi-part request.

Show Source

• Array of: object MultiPart
  Input to External Service, information that describes a part of a multi-part request

{
    "type":"array",
    "description":"Any additional parts (not files) required to process the multi-part request.",
    "items":{
        "$ref":"#/definitions/MultiPart"
    }
}

Nested Schema : headers

Type: array

A set of name-value pairs to send to the external service as HTTP headers.

Show Source

• Array of: object NVPair

{
    "type":"array",
    "description":"A set of name-value pairs to send to the external service as HTTP headers.",
    "items":{
        "$ref":"#/definitions/NVPair"
    }
}

Nested Schema : parameters

Type: array

A set of name-value pairs to send to the external service as URL parameters.

Show Source

• Array of: object NVPair

{
    "type":"array",
    "description":"A set of name-value pairs to send to the external service as URL parameters.",
    "items":{
        "$ref":"#/definitions/NVPair"
    }
}

Nested Schema : MultiPart

Type: object

Input to External Service, information that describes a part of a multi-part request

Show Source

• contentType(optional): string
  The content type of the part, any text based Media Type, like application/json or text/xml
• name(optional): string
  The name of the part.
• partBody(optional): string
  The body of the part. This may be JSON text or XML or other String values matching the content type.

{
    "type":"object",
    "properties":{
        "contentType":{
            "type":"string",
            "description":"The content type of the part, any text based Media Type, like application/json or text/xml"
        },
        "name":{
            "type":"string",
            "description":"The name of the part."
        },
        "partBody":{
            "type":"string",
            "description":"The body of the part. This may be JSON text or XML or other String values matching the content type."
        }
    },
    "description":"Input to External Service, information that describes a part of a multi-part request"
}

Nested Schema : NVPair

Type: object

Show Source

• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

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

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 REST request to send report output to an external REST service. The token value is from a prior call to the tokenrequest service to establish an AIS session.

In this example, the media object upload service on another AIS Server is used to demonstrate sending report output via a multi-part HTTP request. The report output PDF file will be uploaded and saved in Media Objects. The AISREST soft coding (connection) record was already configured to point to the URL of the AIS REST ending with jderest.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/external/rest/report -d
{
	"token": "044krG3bJ9WvTHK9FpXOkizBnYCAgqd93G2HtCH9YfSm/E=MDE5MDEzMzYyNzcyNTQxMTA4MTA1MDI1MDEwLjEzOS4xMTAuNjQxNTEwNjgzNjkxMzAw",
   
    "method": "POST",
    "softCodingRecordKey": "AISREST",
    "appendPath": "/v2/file/upload",    
    "filePartName": "file",
    "viewType":"PDF",
    "jobNumber":"1266",
    "executionServer":"den00gyz",   
    "additionalParts": [
        {
            "contentType": "application/json",
            "name": "moAdd",
            "partBody": "{  \"moStructure\": \"ABGT\",  \"file\": {           \"fileName\": \"R064011_XJDE0001_1266.pdf\",      \"itemName\": \"R064011_1266\"  },  \"moKey\": [      \"7\"  ],       \"version\": \"ZJDE0001\",  \"formName\": \"P01012_W01012B\"}"                    
        }
    ]
}

Example Response

The following example shows the contents of the response body. In this case, the response is from the media object upload service, since that is the external service that was called.

{
   "uniquefilename": "FILE-5507065071835691596-1510775215177.pdf",
   "itemName": "R064011_1266.pdf",
   "sequence": 5
}

Back to Top