Execute an Orchestration
get
/orchestrator/{orchestration}
Execute the orchestration specified in the URL.
Request
Path Parameters
Query Parameters
-
$environment: string
EnterpriseOne environment, if not using a default environment.
-
$password: string
EnterpriseOne password, if not using an established session.
-
$token: string
The AIS token, use if you have already established a session.
-
$username: string
EnterpriseOne userid, if not using an established session.
-
role: string
EnterpriseOne role, if not using a default role.
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", "monitorRequestAndSteps", "monitorRequestIOAndSteps", "monitorRequestAndStepsIO", "monitorRequestIOAndStepsIO" ]
Response
Supported Media Types
- application/json
- application/xml
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:
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:
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.
Examples
Orchestration request formats are defined within the orchestration, and they are all unique. Use the Orchestrator Studio and the Orchestrator Client to create and run example orchestrations.