Get Orchestration v3

get

/v3/open-api-catalog3/{orchName}

Returns information about a single orchestration REST API's.

Request

Path Parameters
Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

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
Body ()
Root Schema : ServiceErrorResponse
Type: object
Error Response
Show Source
Back to Top

Examples

Example Request

The following shows an example of an open-api-catalog3 call passing in a specific orchestration to get details for only that one.

curl -i -X GET -H "Content-Type:application/json" --user JDE:JDE http://ais_server_url/jderest/v3/open-api-catalog3/Add%20Sales%20Order
        

Example Response

The following example shows the contents of the response body.

{
	"openapi": "3.0.0",
	"info": {
		"description": "This is the JD Edwards Orchestration server.  Enabling 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"
	},
	"externalDocs": {
		"description": "JD Edwards EnterpriseOne Orchestrator",
		"url": "http://docs.oracle.com/cd/E84502_01/learnjde/orchestrator.html"
	},
	"servers": [
		{
			"url": "https://denac144.us.oracle.com:26576/jderest/v3/orchestrator"
		}
	],
	"tags": [
		{
			"name": "Add Sales Order",
			"description": " "
		}
	],
	"paths": {
		"/Add Sales Order": {
			"post": {
				"tags": [
					"Add Sales Order"
				],
				"summary": "Add Sales Order",
				"description": "Add Sales Order",
				"requestBody": {
					"description": "Object for Orchestration Execution",
					"content": {
						"application/json": {
							"schema": {
								"$ref": "#/components/schemas/ORC_1904030007JDE"
							}
						},
						"application/xml": {
							"schema": {
								"$ref": "#/components/schemas/ORC_1904030007JDE"
							}
						}
					}
				},
				"responses": {
					"200": {
						"description": "Successful Execution",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ORC_1904030007JDE_Output"
								}
							},
							"application/xml": {
								"schema": {
									"$ref": "#/components/schemas/ORC_1904030007JDE_Output"
								}
							}
						}
					},
					"406": {
						"description": "Invalid Accept Header"
					},
					"415": {
						"description": "Invalid Content-Type Header"
					},
					"400": {
						"description": "Bad Request - Invalid Input"
					},
					"500": {
						"description": "Server Failed to Process Request",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ERROR"
								}
							},
							"application/xml": {
								"schema": {
									"$ref": "#/components/schemas/ERROR"
								}
							}
						}
					},
					"444": {
						"description": "Invalid Token",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ERROR"
								}
							},
							"application/xml": {
								"schema": {
									"$ref": "#/components/schemas/ERROR"
								}
							}
						}
					},
					"403": {
						"description": "Authorization Failure",
						"content": {
							"application/json": {
								"schema": {
									"$ref": "#/components/schemas/ERROR"
								}
							},
							"application/xml": {
								"schema": {
									"$ref": "#/components/schemas/ERROR"
								}
							}
						}
					}
				},
				"security": [
					{
						"basicAuth": []
					}
				]
			}
		}
	},
	"components": {
		"securitySchemes": {
			"basicAuth": {
				"type": "http",
				"scheme": "basic"
			}
		},
		"schemas": {
			"ORC_1904030007JDESOLines": {
				"type": "object",
				"properties": {
					"Item Number": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Item_0x737063_Number"
						}
					},
					"Quantity Ordered": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Quantity_0x737063_Ordered"
						}
					}
				}
			},
			"ORC_1904030007JDE": {
				"type": "object",
				"properties": {
					"Sold To": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Sold_0x737063_To"
						}
					},
					"Header Branch": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Header_0x737063_Branch"
						}
					},
					"SOLines": {
						"type": "array",
						"items": {
							"$ref": "#/components/schemas/ORC_1904030007JDESOLines"
						}
					}
				}
			},
			"ORC_1904030007JDE_Output": {
				"type": "object",
				"properties": {
					"Previous Order": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Previous_Order"
						}
					},
					"Previous Order Company": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Previous_Order_Company"
						}
					},
					"Previous Order Type": {
						"type": "string",
						"example": "string",
						"xml": {
							"name": "Previous_Order_Type"
						}
					}
				},
				"xml": {
					"name": "Add_Sales_Order"
				}
			},
			"ERROR": {
				"type": "object",
				"properties": {
					"message": {
						"type": "string",
						"example": "string"
					},
					"exception": {
						"type": "string",
						"example": "string"
					},
					"timestamp": {
						"type": "string",
						"example": "2019-05-20T11:43:35.370-0700",
						"format": "date-time"
					}
				}
			}
		}
	}
}     

        
Back to Top