Jump to

• Request
• Response

Call External REST Service v2

post

/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: string
  Token
• jde-AIS-Auth-Device: string
  Device Name
• jde-AIS-MonitorOnStart: boolean
  Monitor on Start
• jde-AIS-MonitorRequest: string
  Monitor Request

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

Body ()

Input to External Service, to invoke external orchestrations.

Root Schema : ExternalRequest

Type: object

Input to External Service, to invoke external orchestrations.

Show Source

• additionalParts: array additionalParts
  Any additional parts (not files) required to process the multi-part request.
• appendPath: string
  Value to append to the endpoint defined in soft coding for identifying the path to the external endpoint.
• 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.
• filePartName: string
  The name of the multi-part part for the file (binary) attachment in the request.
• fireAndForget: 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: array headers
  A set of name-value pairs to send to the external service as HTTP headers.
• ignoreResponse: 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: 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(required): string
  The HTTP method to be used for the external call.
• parameters: array parameters
  A set of name-value pairs to send to the external service as URL parameters.
• password: string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• postBody: string
  A string to send as input in the body of the external REST service call.
• 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(required): string
  The key of the soft coding record configured to call the external service.
• sourceFileName: string
  The name of the AIS local file to be sent to an external multi-part file upload request.
• targetFileName: string
  The name of the file to send to the external REST, if different from the source file name.
• 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.

{
    "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."
        },
        "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 External Service, to invoke external orchestrations."
}

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: string
  The content type of the part, any text based Media Type, like application/json or text/xml
• name: string
  The name of the part.
• partBody: 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: string
• value: string

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

Back to Top

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

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error 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.

{
    "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: 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.

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