Get All Orchestrations v2
get
/jderest/v2/open-api-catalog
Returns information about all orchestration REST API's.
Request
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:
objectError 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. Which lists all of the orchestrations available to the user in the Open API 2.0 standard.
curl -i -X GET -H "Content-Type:application/json" --user JDE:JDE http://ais_server_url/jderest/v2/open-api-catalog
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": [
{
"name": "Activate Irrigation",
"description": "Activate Irrigation"
},
{
"name": "Add SO Text MO",
"description": "Add SO Text MO"
},
{
"name": "Create Health and Safety Incident",
"description": "Create a Health and Safety incident. Input is the Incident Description, Person ID (AB number), and Incident Role (01=Victim). Output is the Incident Number."
},
{
"name": "Finish Irrigation Operation",
"description": "Set operation status to finished"
},
{
"name": "Get Vineyard History",
"description": "Get Vineyard History"
},
{
"name": "IncidentPerson",
"description": "IncidentPerson"
},
{
"name": "Print Invoices",
"description": "Print Invoices"
},
{
"name": "SM Health Check Orchestration",
"description": "SM Health Check Orchestration"
},
{
"name": "USPSAddressValidation",
"description": "Calls the USPS Rest API to validate an address and provide a zip code."
},
{
"name": "Vineyard Irrigation Automation",
"description": "Automation of vineyard condition recording, historical and future condition analysis and irrigation operation execution."
},
{
"name": "Add Items from CSV",
"description": "Add Items from CSV"
},
{
"name": "Get Health and Safety Incident Report - Formatted",
"description": "Get Health and Safety Incident Report - Formatted"
},
{
"name": "Send Health and Safety Incident Report",
"description": "Send Incident Report data to nForm. First invoke the Get Health and Safety Incident Report. Input is Incident Number. Then send the incident data to nForm. Get a link back in e-mail to create a PDF."
}
],
"paths": {
"/Activate Irrigation": {
"post": {
"tags": [
"Activate Irrigation"
],
"summary": "Activate Irrigation",
"description": "Activate Irrigation",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811010007JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010007JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Activate Irrigation"
],
"summary": "Activate Irrigation",
"description": "Activate Irrigation",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "OpID",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "Branch",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010007JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Add SO Text MO": {
"post": {
"tags": [
"Add SO Text MO"
],
"summary": "Add SO Text MO",
"description": "Add SO Text MO",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1902050004JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1902050004JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Add SO Text MO"
],
"summary": "Add SO Text MO",
"description": "Add SO Text MO",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "orderNo",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "orderType",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "orderCO",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "orderLine",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "moItemName",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "moText",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1902050004JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Create Health and Safety Incident": {
"post": {
"tags": [
"Create Health and Safety Incident"
],
"summary": "Create Health and Safety Incident",
"description": "Create a Health and Safety incident. Input is the Incident Description, Person ID (AB number), and Incident Role (01=Victim). Output is the Incident Number.",
"consumes": [
"application/json"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1812180003JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1812180003JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Finish Irrigation Operation": {
"post": {
"tags": [
"Finish Irrigation Operation"
],
"summary": "Finish Irrigation Operation",
"description": "Set operation status to finished",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811010002JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Finish Irrigation Operation"
],
"summary": "Finish Irrigation Operation",
"description": "Set operation status to finished",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "OperationID",
"required": true,
"type": "number"
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Get Vineyard History": {
"post": {
"tags": [
"Get Vineyard History"
],
"summary": "Get Vineyard History",
"description": "Get Vineyard History",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811010005JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010005JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Get Vineyard History"
],
"summary": "Get Vineyard History",
"description": "Get Vineyard History",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "Vineyard",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010005JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/IncidentPerson": {
"post": {
"tags": [
"IncidentPerson"
],
"summary": "IncidentPerson",
"description": "IncidentPerson",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811050001JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"IncidentPerson"
],
"summary": "IncidentPerson",
"description": "IncidentPerson",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "IncidentNumber",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "AddressNumber",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "PersonDescription",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Print Invoices": {
"post": {
"tags": [
"Print Invoices"
],
"summary": "Print Invoices",
"description": "Print Invoices",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811190005JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Print Invoices"
],
"summary": "Print Invoices",
"description": "Print Invoices",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "2nd Item Number",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "Order Type",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/SM Health Check Orchestration": {
"post": {
"tags": [
"SM Health Check Orchestration"
],
"summary": "SM Health Check Orchestration",
"description": "SM Health Check Orchestration",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "{}",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1902040005JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"SM Health Check Orchestration"
],
"summary": "SM Health Check Orchestration",
"description": "SM Health Check Orchestration",
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "Successful Execution"
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/USPSAddressValidation": {
"post": {
"tags": [
"USPSAddressValidation"
],
"summary": "USPSAddressValidation",
"description": "Calls the USPS Rest API to validate an address and provide a zip code.",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1901310005JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1901310005JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"USPSAddressValidation"
],
"summary": "USPSAddressValidation",
"description": "Calls the USPS Rest API to validate an address and provide a zip code.",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "addressLine",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "city",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "state",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1901310005JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Vineyard Irrigation Automation": {
"post": {
"tags": [
"Vineyard Irrigation Automation"
],
"summary": "Vineyard Irrigation Automation",
"description": "Automation of vineyard condition recording, historical and future condition analysis and irrigation operation execution.",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811010001JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010001JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Vineyard Irrigation Automation"
],
"summary": "Vineyard Irrigation Automation",
"description": "Automation of vineyard condition recording, historical and future condition analysis and irrigation operation execution.",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "Vineyard",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "Precipitation",
"required": true,
"type": "number"
},
{
"in": "query",
"name": "Moisture Content",
"required": true,
"type": "number"
},
{
"in": "query",
"name": "High Temp",
"required": true,
"type": "number"
},
{
"in": "query",
"name": "Low Temp",
"required": true,
"type": "number"
},
{
"in": "query",
"name": "WeatherCity",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "WeatherState",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010001JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Add Items from CSV": {
"post": {
"tags": [
"Add Items from CSV"
],
"summary": "Add Items from CSV",
"description": "Add Items from CSV",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "{}",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1811010006JDE"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010006JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Add Items from CSV"
],
"summary": "Add Items from CSV",
"description": "Add Items from CSV",
"produces": [
"application/json",
"application/xml"
],
"parameters": [],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1811010006JDE_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Get Health and Safety Incident Report - Formatted": {
"post": {
"tags": [
"Get Health and Safety Incident Report - Formatted"
],
"summary": "Get Health and Safety Incident Report - Formatted",
"description": "Get Health and Safety Incident Report - Formatted",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1803130004CUST"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1803130004CUST_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Get Health and Safety Incident Report - Formatted"
],
"summary": "Get Health and Safety Incident Report - Formatted",
"description": "Get Health and Safety Incident Report - Formatted",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "Incident Number",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "Safety Officer AB Number",
"required": true,
"type": "number"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1803130004CUST_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
},
"/Send Health and Safety Incident Report": {
"post": {
"tags": [
"Send Health and Safety Incident Report"
],
"summary": "Send Health and Safety Incident Report",
"description": "Send Incident Report data to nForm. First invoke the Get Health and Safety Incident Report. Input is Incident Number. Then send the incident data to nForm. Get a link back in e-mail to create a PDF.",
"consumes": [
"application/json",
"application/xml"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "body",
"description": "Object for Orchestration Execution",
"required": true,
"schema": {
"$ref": "#/definitions/ORC_1803290003CUST"
}
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1803290003CUST_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
},
"get": {
"tags": [
"Send Health and Safety Incident Report"
],
"summary": "Send Health and Safety Incident Report",
"description": "Send Incident Report data to nForm. First invoke the Get Health and Safety Incident Report. Input is Incident Number. Then send the incident data to nForm. Get a link back in e-mail to create a PDF.",
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"in": "query",
"name": "Incident Number",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "Safety Officer AB Number",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Successful Execution",
"schema": {
"$ref": "#/definitions/ORC_1803290003CUST_Output"
}
},
"400": {
"description": "Bad Request - Invalid Input"
},
"403": {
"description": "Authorization Failure",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"406": {
"description": "Invalid Accept Header"
},
"415": {
"description": "Invalid Content-Type Header"
},
"444": {
"description": "Invalid Token",
"schema": {
"$ref": "#/definitions/ERROR"
}
},
"500": {
"description": "Server Failed to Process Request",
"schema": {
"$ref": "#/definitions/ERROR"
}
}
},
"security": [
{
"basicAuth": []
}
]
}
}
},
"definitions": {
"ORC_1811010007JDE": {
"type": "object",
"properties": {
"OpID": {
"type": "string",
"example": "string"
},
"Branch": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Activate_Irrigation"
}
},
"ORC_1811010007JDE_Output": {
"type": "object",
"properties": {
"filterDate": {
"type": "string",
"example": "string"
},
"Operation Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Operation_Number"
}
},
"Irrigation Start": {
"type": "string",
"example": "string",
"xml": {
"name": "Irrigation_Start"
}
},
"Irrigation Duration": {
"type": "string",
"example": "string",
"xml": {
"name": "Irrigation_Duration"
}
}
},
"xml": {
"name": "Activate_Irrigation"
}
},
"ORC_1902050004JDE": {
"type": "object",
"properties": {
"orderNo": {
"type": "string",
"example": "string"
},
"orderType": {
"type": "string",
"example": "string"
},
"orderCO": {
"type": "string",
"example": "string"
},
"orderLine": {
"type": "string",
"example": "string"
},
"moItemName": {
"type": "string",
"example": "string"
},
"moText": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Add_SO_Text_MO"
}
},
"ORC_1902050004JDE_Output": {
"type": "object",
"properties": {
"addTextStatus": {
"type": "string",
"example": "string"
},
"sequence": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Add_SO_Text_MO"
}
},
"ORC_1812180003JDEGridData": {
"type": "object",
"properties": {
"Person ID": {
"type": "string",
"example": "string",
"xml": {
"name": "Person_0x737063__0x737063_ID"
}
}
}
},
"ORC_1812180003JDE": {
"type": "object",
"properties": {
"Incident Description": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_0x737063_Description"
}
},
"GridData": {
"type": "array",
"items": {
"$ref": "#/definitions/ORC_1812180003JDEGridData"
}
},
"Incident Role": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_0x737063_Role"
}
}
}
},
"ORC_1812180003JDE_Output": {
"type": "object",
"properties": {
"Incident Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_Number"
}
}
},
"xml": {
"name": "Create_Health_and_Safety_Incident"
}
},
"ORC_1811010002JDE": {
"type": "object",
"properties": {
"OperationID": {
"type": "number",
"example": 0
}
},
"xml": {
"name": "Finish_Irrigation_Operation"
}
},
"ORC_1811010005JDE": {
"type": "object",
"properties": {
"Vineyard": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Get_Vineyard_History"
}
},
"ORC_1811010005JDE_Output": {
"type": "object",
"properties": {},
"xml": {
"name": "Get_Vineyard_History"
}
},
"ORC_1811050001JDE": {
"type": "object",
"properties": {
"IncidentNumber": {
"type": "string",
"example": "string"
},
"AddressNumber": {
"type": "string",
"example": "string"
},
"PersonDescription": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "IncidentPerson"
}
},
"ORC_1811190005JDE": {
"type": "object",
"properties": {
"2nd Item Number": {
"type": "string",
"example": "string",
"xml": {
"name": "2nd_0x737063_Item_0x737063_Number"
}
},
"Order Type": {
"type": "string",
"example": "string",
"xml": {
"name": "Order_0x737063_Type"
}
}
},
"xml": {
"name": "Print_Invoices"
}
},
"ORC_1902040005JDE": {
"type": "object",
"properties": {},
"xml": {
"name": "SM_Health_Check_Orchestration"
}
},
"ORC_1901310005JDE": {
"type": "object",
"properties": {
"addressLine": {
"type": "string",
"example": "string"
},
"city": {
"type": "string",
"example": "string"
},
"state": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "USPSAddressValidation"
}
},
"ORC_1901310005JDE_Output": {
"type": "object",
"properties": {
"address": {
"type": "string",
"example": "string"
},
"city": {
"type": "string",
"example": "string"
},
"state": {
"type": "string",
"example": "string"
},
"zipCode": {
"type": "string",
"example": "string"
},
"zip4": {
"type": "string",
"example": "string"
},
"zip5": {
"type": "string",
"example": "string"
},
"error": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "USPSAddressValidation"
}
},
"ORC_1811010001JDE": {
"type": "object",
"properties": {
"Vineyard": {
"type": "string",
"example": "string"
},
"Precipitation": {
"type": "number",
"example": 0
},
"Moisture Content": {
"type": "number",
"example": 0,
"xml": {
"name": "Moisture_0x737063_Content"
}
},
"High Temp": {
"type": "number",
"example": 0,
"xml": {
"name": "High_0x737063_Temp"
}
},
"Low Temp": {
"type": "number",
"example": 0,
"xml": {
"name": "Low_0x737063_Temp"
}
},
"WeatherCity": {
"type": "string",
"example": "string"
},
"WeatherState": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Vineyard_Irrigation_Automation"
}
},
"ORC_1811010001JDE_Output": {
"type": "object",
"properties": {
"averagePrecip": {
"type": "string",
"example": "string"
},
"averageLow": {
"type": "string",
"example": "string"
},
"averageHigh": {
"type": "string",
"example": "string"
},
"soilMoisture": {
"type": "string",
"example": "string"
},
"forecast.simpleforecast.forecastday[0].qpf_allday.in": {
"type": "string",
"example": "string",
"xml": {
"name": "forecast.simpleforecast.forecastday0.qpf_allday.in"
}
},
"forecast.simpleforecast.forecastday[1].qpf_allday.in": {
"type": "string",
"example": "string",
"xml": {
"name": "forecast.simpleforecast.forecastday1.qpf_allday.in"
}
},
"forecast.simpleforecast.forecastday[2].qpf_allday.in": {
"type": "string",
"example": "string",
"xml": {
"name": "forecast.simpleforecast.forecastday2.qpf_allday.in"
}
},
"createOperation": {
"type": "string",
"example": "string"
},
"duration": {
"type": "string",
"example": "string"
},
"startDateTime": {
"type": "string",
"example": "string"
},
"description": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Vineyard_Irrigation_Automation"
}
},
"ORC_1811010006JDE": {
"type": "object",
"properties": {},
"xml": {
"name": "Add_Items_from_CSV"
}
},
"ORC_1811010006JDE_Repeating_Requests": {
"type": "object",
"properties": {
"Short Item Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Short_Item_Number"
}
},
"Item Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Item_Number"
}
}
}
},
"ORC_1811010006JDE_Output": {
"type": "object",
"properties": {
"Repeating Requests": {
"type": "array",
"items": {
"$ref": "#/definitions/ORC_1811010006JDE_Repeating_Requests"
},
"xml": {
"name": "Repeating_Requests"
}
}
},
"xml": {
"name": "Add_Items_from_CSV"
}
},
"ORC_1803130004CUST": {
"type": "object",
"properties": {
"Incident Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_0x737063_Number"
}
},
"Safety Officer AB Number": {
"type": "number",
"example": 0,
"xml": {
"name": "Safety_0x737063_Officer_0x737063_AB_0x737063_Number"
}
}
},
"xml": {
"name": "Get_Health_and_Safety_Incident_Report_-_Formatted"
}
},
"ORC_1803130004CUST_Output": {
"type": "object",
"properties": {
"Employee Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Employee_Number"
}
},
"Employee Name": {
"type": "string",
"example": "string",
"xml": {
"name": "Employee_Name"
}
},
"Employee Start Date": {
"type": "string",
"example": "string",
"xml": {
"name": "Employee_Start_Date"
}
},
"Gender": {
"type": "string",
"example": "string"
},
"Address": {
"type": "string",
"example": "string"
},
"Case Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Case_Number"
}
},
"Emergency Room Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Emergency_Room_Number"
}
},
"Inpatient Hospitalization": {
"type": "string",
"example": "string",
"xml": {
"name": "Inpatient_Hospitalization"
}
},
"Facility Add No.": {
"type": "string",
"example": "string",
"xml": {
"name": "Facility_Add_No."
}
},
"Incident Date": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_Date"
}
},
"Date of Birth": {
"type": "string",
"example": "string",
"xml": {
"name": "Date_of_Birth"
}
},
"Name of Physician": {
"type": "string",
"example": "string",
"xml": {
"name": "Name_of_Physician"
}
},
"Action When Injured": {
"type": "string",
"example": "string",
"xml": {
"name": "Action_When_Injured"
}
},
"What Happened": {
"type": "string",
"example": "string",
"xml": {
"name": "What_Happened"
}
},
"Physical Object Involved": {
"type": "string",
"example": "string",
"xml": {
"name": "Physical_Object_Involved"
}
},
"Injury or Illness Description": {
"type": "string",
"example": "string",
"xml": {
"name": "Injury_or_Illness_Description"
}
},
"City": {
"type": "string",
"example": "string"
},
"State": {
"type": "string",
"example": "string"
},
"Zip": {
"type": "string",
"example": "string"
},
"Facility Address": {
"type": "string",
"example": "string",
"xml": {
"name": "Facility_Address"
}
},
"Facility City": {
"type": "string",
"example": "string",
"xml": {
"name": "Facility_City"
}
},
"Facility State": {
"type": "string",
"example": "string",
"xml": {
"name": "Facility_State"
}
},
"Facility Zip": {
"type": "string",
"example": "string",
"xml": {
"name": "Facility_Zip"
}
},
"Facility Name": {
"type": "string",
"example": "string",
"xml": {
"name": "Facility_Name"
}
},
"Incident Time": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_Time"
}
},
"Date Reported": {
"type": "string",
"example": "string",
"xml": {
"name": "Date_Reported"
}
},
"Time Work Began": {
"type": "string",
"example": "string",
"xml": {
"name": "Time_Work_Began"
}
},
"Completed by": {
"type": "string",
"example": "string",
"xml": {
"name": "Completed_by"
}
},
"Title": {
"type": "string",
"example": "string"
},
"Phone": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Get_Health_and_Safety_Incident_Report_-_Formatted"
}
},
"ORC_1803290003CUST": {
"type": "object",
"properties": {
"Incident Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Incident_0x737063_Number"
}
},
"Safety Officer AB Number": {
"type": "string",
"example": "string",
"xml": {
"name": "Safety_0x737063_Officer_0x737063_AB_0x737063_Number"
}
}
},
"xml": {
"name": "Send_Health_and_Safety_Incident_Report"
}
},
"ORC_1803290003CUST_Output": {
"type": "object",
"properties": {
"url": {
"type": "string",
"example": "string"
}
},
"xml": {
"name": "Send_Health_and_Safety_Incident_Report"
}
},
"ERROR": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "string"
},
"exception": {
"type": "string",
"example": "string"
},
"timestamp": {
"type": "string",
"example": "2019-05-20T12:03:57.622-0700",
"format": "date-time"
}
}
}
},
"securityDefinitions": {
"basicAuth": {
"type": "basic"
}
}
}