Get Orchestration v2
get
/jderest/v2/open-api-catalog/{orchName}
Returns information about a single orchestration REST API's.
Request
Path Parameters
-
orchName: string
The name of an individual Orchesration
Query Parameters
-
$environment(optional): string
EnterpriseOne environment, if not using a default environment.
-
$password(optional): string
The EnterpriseOne user password, which is required if not using an established session.
-
$role(optional): string
The EnterpriseOne role, if not using a default role.
-
$token(optional): string
The AIS token, use if you have already established a session.
-
$username(optional): string
EnterpriseOne user ID, which is required if not using an established session.
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" ]
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
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.
Examples
Example Request
The following shows an example of an open-api-catalog call passing in a specific orchestration to get details for only that one in Swagger 2.0 format.
curl -i -X GET -H "Content-Type:application/json" --user JDE:JDE http://ais_server_url/jderest/v2/open-api-catalog/Add%20Sales%20Order
Example Response
The following example shows the contents of the response body.
{ "swagger": "2.0", "info": { "description": "This is the JD Edwards Orchestration server.\nEnabling you to Collect, Filter, Analyze, and Act on Real-Time Data. \n\nYou can find out more about the JD Edwards Orchestrations at [LearnJDE](http://docs.oracle.com/cd/E84502_01/learnjde/orchestrator.html).", "version": "EnterpriseOne 9.2.3.4 ", "title": "JD Edwards EnterpriseOne" }, "host": "ais_host:port", "basePath": "/jderest/v2/orchestrator", "schemes": [ "https", "http" ], "tags": [], "paths": {}, "definitions": { "ERROR": { "type": "object", "properties": { "message": { "type": "string", "example": "string" }, "exception": { "type": "string", "example": "string" }, "timestamp": { "type": "string", "example": "2019-05-20T12:21:10.881-0700", "format": "date-time" } } } }, "securityDefinitions": { "basicAuth": { "type": "basic" } } }