Call External REST Service v2
post
/jderest/v2/external/rest
Enables callers to invoke an external REST service configured with soft coding record.
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 RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO" ]
Input to External Service, to invoke external orchestrations.
Root Schema : ExternalRequest
Type:
object
Input to External Service, to invoke external orchestrations.
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.
-
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.
-
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.
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
Nested Schema : headers
Type:
array
A set of name-value pairs to send to the external service as HTTP headers.
Show Source
Nested Schema : parameters
Type:
array
A set of name-value pairs to send to the external service as URL parameters.
Show Source
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.
Response
Supported Media Types
- application/json
- application/octet-stream
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.