Jump to

• Request
• Response
• Examples

List Orchestrations

get

/jderest/discover

Request a list of available orchestrations.

Request

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 Request

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Execution

Body ()

Root Schema : OrchestrationDiscoveryResponse

Type: object

Lists avaialble orchestrations.

Show Source

• orchestrations(optional): array orchestrations
  The list of orchestrations.

{
    "type":"object",
    "properties":{
        "orchestrations":{
            "type":"array",
            "description":"The list of orchestrations.",
            "items":{
                "$ref":"#/definitions/SingleOrchestrationDiscovery"
            }
        }
    },
    "description":"Lists avaialble orchestrations."
}

Nested Schema : orchestrations

Type: array

The list of orchestrations.

Show Source

• Array of: object SingleOrchestrationDiscovery
  An available orchestration.

{
    "type":"array",
    "description":"The list of orchestrations.",
    "items":{
        "$ref":"#/definitions/SingleOrchestrationDiscovery"
    }
}

Nested Schema : SingleOrchestrationDiscovery

Type: object

An available orchestration.

Show Source

• category(optional): string
  The Category (tag) for the Orchestration.
• containsContinueOnError(optional): boolean
  If the Orchestration should continue processing after a step error
• description(optional): string
  The orchestration description.
• exampleOutput(optional): string
• exposeInputsInDiscovery(optional): boolean
  If this Orchestrations Inputs should be exposed.
• exposeOrchInDiscovery(optional): boolean
  If this Orchestration should be shown as a discoverable entity.
• fileInputs(optional): boolean
• fileInputsRequired(optional): boolean
• fileOutputs(optional): boolean
• inputFormat(optional): string
  Allowed Values: [ "Generic", "JDE Standard", "Oracle Cloud IoT" ]

  The input format.
• inputs(optional): array inputs
  The list of inputs to the orchestration.
• longDescription(optional): string
  The orchestration long description.
• name(optional): string
  The orchestration name.
• omwObjectName(optional): string
  The omw object name for the orchestration UDO.
• outputs(optional): array outputs
  The list of outputs from the orchestration.
• scheduleUDOName(optional): string
  The schedule assigned to this orchestration.
• udoGroup(optional): string
  Allowed Values: [ "Personal", "Shared", "Reserved", "Pending Approval" ]

  The the UDO group.
• version(optional): string
  The AIS API version used for form and data service requests.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The orchestration name."
        },
        "omwObjectName":{
            "type":"string",
            "description":"The omw object name for the orchestration UDO."
        },
        "udoGroup":{
            "type":"string",
            "description":"The the UDO group.",
            "enum":[
                "Personal",
                "Shared",
                "Reserved",
                "Pending Approval"
            ]
        },
        "description":{
            "type":"string",
            "description":"The orchestration description."
        },
        "inputFormat":{
            "type":"string",
            "description":"The input format.",
            "enum":[
                "Generic",
                "JDE Standard",
                "Oracle Cloud IoT"
            ]
        },
        "version":{
            "type":"string",
            "description":"The AIS API version used for form and data service requests."
        },
        "scheduleUDOName":{
            "type":"string",
            "description":"The schedule assigned to this orchestration."
        },
        "longDescription":{
            "type":"string",
            "description":"The orchestration long description."
        },
        "containsContinueOnError":{
            "type":"boolean",
            "description":"If the Orchestration should continue processing after a step error"
        },
        "category":{
            "type":"string",
            "description":"The Category (tag) for the Orchestration."
        },
        "exposeOrchInDiscovery":{
            "type":"boolean",
            "description":"If this Orchestration should be shown as a discoverable entity."
        },
        "exposeInputsInDiscovery":{
            "type":"boolean",
            "description":"If this Orchestrations Inputs should be exposed."
        },
        "inputs":{
            "type":"array",
            "description":"The list of inputs to the orchestration.",
            "items":{
                "$ref":"#/definitions/OrchestrationInputDiscovery"
            }
        },
        "outputs":{
            "type":"array",
            "description":"The list of outputs from the orchestration.",
            "items":{
                "$ref":"#/definitions/OrchestrationInputDiscovery"
            }
        },
        "fileInputs":{
            "type":"boolean"
        },
        "fileInputsRequired":{
            "type":"boolean"
        },
        "fileOutputs":{
            "type":"boolean"
        },
        "exampleOutput":{
            "type":"string"
        }
    },
    "description":"An available orchestration."
}

Nested Schema : inputs

Type: array

The list of inputs to the orchestration.

Show Source

• Array of: object OrchestrationInputDiscovery
  An input to an orchestration.

{
    "type":"array",
    "description":"The list of inputs to the orchestration.",
    "items":{
        "$ref":"#/definitions/OrchestrationInputDiscovery"
    }
}

Nested Schema : outputs

Type: array

The list of outputs from the orchestration.

Show Source

• Array of: object OrchestrationInputDiscovery
  An input to an orchestration.

{
    "type":"array",
    "description":"The list of outputs from the orchestration.",
    "items":{
        "$ref":"#/definitions/OrchestrationInputDiscovery"
    }
}

Nested Schema : OrchestrationInputDiscovery

Type: object

An input to an orchestration.

Show Source

• array(optional): array array
  The name of the input array (arrays are only shown in discovery inputs).
• example(optional): string
  The Example Input or Output values used for discovery
• gridId(optional): string
  The id of the grid.
• iterateOver(optional): string
  The name of the Iterate Over object is applicable
• name(optional): string
  The name of the input or output field.
• required(optional): boolean
  If the input is required to be passed to the Orchestration
• stepName(optional): string
  The name of the step that this input or output resides
• title(optional): string
  The title of the grid.
• type(optional): string
  Allowed Values: [ "Array", "String", "Numeric", "Milliseconds", "MM/dd/yyyy", "dd/MMyyyy", "MM/dd/yy", "dd/MM/yy", "yyyy/MM/dd", "yy/MM/dd", "yyy-MM-dd'T'HH:mm:ss.SSSZ" ]

  The type of the input or output field.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the input or output field."
        },
        "type":{
            "type":"string",
            "description":"The type of the input or output field.",
            "enum":[
                "Array",
                "String",
                "Numeric",
                "Milliseconds",
                "MM/dd/yyyy",
                "dd/MMyyyy",
                "MM/dd/yy",
                "dd/MM/yy",
                "yyyy/MM/dd",
                "yy/MM/dd",
                "yyy-MM-dd'T'HH:mm:ss.SSSZ"
            ]
        },
        "gridId":{
            "type":"string",
            "description":"The id of the grid."
        },
        "title":{
            "type":"string",
            "description":"The title of the grid."
        },
        "iterateOver":{
            "type":"string",
            "description":"The name of the Iterate Over object is applicable"
        },
        "stepName":{
            "type":"string",
            "description":"The name of the step that this input or output resides"
        },
        "required":{
            "type":"boolean",
            "description":"If the input is required to be passed to the Orchestration"
        },
        "array":{
            "type":"array",
            "description":"The name of the input array (arrays are only shown in discovery inputs).",
            "items":{
                "$ref":"#/definitions/OrchestrationInputDiscovery"
            }
        },
        "example":{
            "type":"string",
            "description":"The Example Input or Output values used for discovery"
        }
    },
    "description":"An input to an orchestration."
}

Nested Schema : array

Type: array

The name of the input array (arrays are only shown in discovery inputs).

Show Source

• Array of: object OrchestrationInputDiscovery
  An input to an orchestration.

{
    "type":"array",
    "description":"The name of the input array (arrays are only shown in discovery inputs).",
    "items":{
        "$ref":"#/definitions/OrchestrationInputDiscovery"
    }
}

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

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

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

Examples

Example Request

Use the discovery service to request a list of available orchestrations. This GET only supports basic authentication for passing credentials.

Stateless with Basic Authorization

curl -i -X GET -H "Content-Type:application/json" -H "Authorization: Basic SkRFOkpERQ==" http://ais_server_url/jderest/discover

Example Response

The following example shows the contents of the response body.

{"orchestrations": [
    {
          "name": "AddSONew",
          "omwObjectName": "ORC_1712130002CUST",
          "udoGroup": "Personal",
          "description": "AddSONew",
          "inputFormat": "JDE Standard",
          "version": "v2",
          "inputs":       [
                      {
                "name": "GridData",
                "type": "Array",
                "array":             [
                                  {
                      "name": "item",
                      "type": "String"
                   },
                                  {
                      "name": "Quantity",
                      "type": "String"
                   }
                ]
             },
                      {
                "name": "BranchPlant",
                "type": "String"
             },
                      {
                "name": "customer",
                "type": "String"
             }
          ],
          "outputs":       [
             {"name": "Previous Order Company"},
             {"name": "Previous Order Type"},
             {"name": "Previous Order Number"}
          ]
       },
    {
          "name": "AddSOOutput",
          "omwObjectName": "ORC_1702210018CUST",
          "udoGroup": "Personal",
          "description": "AddSOOutput",
          "inputFormat": "JDE Standard",
          "version": "v2",
          "inputs":       [
                      {
                "name": "item",
                "type": "String"
             },
                      {
                "name": "BranchPlant",
                "type": "String"
             },
                      {
                "name": "customer",
                "type": "String"
             },
                      {
                "name": "OrderDate",
                "type": "String"
             },
                      {
                "name": "Quantity",
                "type": "String"
             }
          ],
          "outputs":       [
             {"name": "Previous Order Company Output"},
             {"name": "Previous Order Type Output"},
             {"name": "Previous Order Number Output"}
          ]
       },
      {
      "name": "ABMasterSearch",
      "omwObjectName": "ORC_1611030041CUST",
      "udoGroup": "Personal",
      "description": "ABMasterSearch",
      "inputFormat": "JDE Standard",
      "inputs":       [
                  {
            "name": "device",
            "type": "String"
         },
                  {
            "name": "ABFilter",
            "type": "String"
         },
                  {
            "name": "ABType",
            "type": "String"
         }
      ]
     },     
      {
      "name": "AddCBM",
      "omwObjectName": "ORC_1611030031CUST",
      "udoGroup": "Personal",
      "description": "AddCBM",
      "inputFormat": "Generic",
      "inputs":       [
                  {
            "name": "date",
            "type": "Milliseconds"
         },
                  {
            "name": "serialNumber",
            "type": "String"
         },
                  {
            "name": "time",
            "type": "String"
         },
                  {
            "name": "temperature",
            "type": "String"
         }
      ]
   },
      {
      "name": "AddEmployee",
      "omwObjectName": "ORC_1611030018CUST",
      "udoGroup": "Personal",
      "description": "AddEmployee",
      "inputFormat": "JDE Standard",
      "inputs":       [
                  {
            "name": "Company",
            "type": "String"
         },
                  {
            "name": "PayFrequency",
            "type": "String"
         },
                  {
            "name": "Name",
            "type": "String"
         },
                  {
            "name": "SearchType",
            "type": "String"
         },
                  {
            "name": "TaxId",
            "type": "String"
         },
                  {
            "name": "Gender",
            "type": "String"
         },
                  {
            "name": "EthnicCode",
            "type": "String"
         },
                  {
            "name": "HomeBusinessUnit",
            "type": "String"
         },
                  {
            "name": "EEOJobCategory",
            "type": "String"
         },
                  {
            "name": "PayClass",
            "type": "String"
         },
                  {
            "name": "Salary",
            "type": "String"
         },
                  {
            "name": "TaxArea",
            "type": "String"
         }
      ]
   },      
      {
      "name": "AddSalesOrder",
      "omwObjectName": "ORC_1611030005CUST",
      "udoGroup": "Personal",
      "description": "AddSalesOrder",
      "inputFormat": "JDE Standard",
      "inputs":       [
                  {
            "name": "item",
            "type": "String"
         },
                  {
            "name": "BranchPlant",
            "type": "String"
         },
                  {
            "name": "customer",
            "type": "String"
         },
                  {
            "name": "OrderDate",
            "type": "String"
         },
                  {
            "name": "Quantity",
            "type": "String"
         }
      ]
   },     
      {
      "name": "EquipmentLocation",
      "omwObjectName": "ORC_1611030054CUST",
      "udoGroup": "Personal",
      "description": "EquipmentLocation",
      "inputFormat": "JDE Standard",
      "inputs":       [
                  {
            "name": "AddressBookNumber",
            "type": "String"
         },
                  {
            "name": "EquipmentNumber",
            "type": "String"
         },
                  {
            "name": "CustomerNumber",
            "type": "String"
         },
                  {
            "name": "SiteNumber",
            "type": "String"
         },
                  {
            "name": "Latitude",
            "type": "String"
         },
                  {
            "name": "Longitude",
            "type": "String"
         }
      ]
   }
]}

Back to Top