Jump to

• Request
• Response
• Examples

Get Orchestration

get

/jderest/discover/{orchestration}

Request a single orchestration.

Request

Path Parameters

• orchestration(required): string
  The name or OMW object name of the orchestration

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 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 available orchestrations.

Show Source

• orchestrations: array orchestrations
  The list of orchestrations.

{
    "type":"object",
    "properties":{
        "orchestrations":{
            "type":"array",
            "description":"The list of orchestrations.",
            "items":{
                "$ref":"#/definitions/SingleOrchestrationDiscovery"
            }
        }
    },
    "description":"Lists available 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: string
  The Category (tag) for the Orchestration.
• containsContinueOnError: boolean
  If the Orchestration should continue processing after a step error
• description: string
  The orchestration description.
• exampleOutput: string
• exposeInputsInDiscovery: boolean
  If this Orchestrations Inputs should be exposed.
• exposeOrchInDiscovery: boolean
  If this Orchestration should be shown as a discoverable entity.
• fileInputs: boolean
• fileInputsRequired: boolean
• fileOutputs: boolean
• inputFormat: string
  Allowed Values: [ "Generic", "JDE Standard", "Oracle Cloud IoT" ]

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

  The the UDO group.
• version: 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: array array
  The name of the input array (arrays are only shown in discovery inputs).
• defaultValue: string
  The default value defined in the orchestration for this input
• defaultValues: array defaultValues
  The default value defined for this array in the orchestration
• example: string
  The Example Input or Output values used for discovery
• gridId: string
  The id of the grid.
• iterateOver: string
  The name of the Iterate Over object is applicable
• name: string
  The name of the input or output field.
• required: boolean
  If the input is required to be passed to the Orchestration
• stepName: string
  The name of the step that this input or output resides
• title: string
  The title of the grid.
• type: 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"
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value defined in the orchestration for this input"
        },
        "defaultValues":{
            "type":"array",
            "description":"The default value defined for this array in the orchestration",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"object"
                }
            }
        }
    },
    "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"
    }
}

Nested Schema : defaultValues

Type: array

The default value defined for this array in the orchestration

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The default value defined for this array in the orchestration",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"object"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : additionalProperties

Type: object

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

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

{
    "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 this discovery service to request a single orchestration. If found, only one will be returned in the list. Use authentication header jde-AIS-Auth to pass a token or use basic authentication for passing credentials.

Stateless with Token Authorization

curl -i -X GET -H "Content-Type:application/json" -H "jde-AIS-Auth: 0440TS5qGhnT1qYEbEP..." http://ais_server_url/jderest/discover/GetAddressBook_Simple

Example Response

The following example shows the contents of the response body.

{
    "orchestrations": [
        {
            "name": "GetAddressBook_Simple",
            "omwObjectName": "ORC_2410240001JDE",
            "udoGroup": "Personal",
            "description": "GetAddressBook_Simple",
            "inputFormat": "Generic",
            "version": "v3",
            "scheduleUDOName": "",
            "longDescription": "",
            "containsContinueOnError": false,
            "exposeOrchInDiscovery": true,
            "exposeInputsInDiscovery": true,
            "inputs": [
                {
                    "name": "AddressBookNumber",
                    "type": "String",
                    "required": false,
                    "defaultValue": "7"
                }
            ],
            "outputs": [
                {
                    "name": "GetAddressBook_Simple_1",
                    "type": "Grid",
                    "gridId": "1",
                    "stepName": "GetAddressBook_Simple",
                    "required": false,
                    "array": [
                        {
                            "name": "Address Number",
                            "type": "Numeric",
                            "required": false
                        },
                        {
                            "name": "Alpha Name",
                            "type": "String",
                            "required": false
                        },
                        {
                            "name": "Industry Class",
                            "type": "String",
                            "required": false
                        }
                    ]
                },
                {
                    "name": "jde__status",
                    "type": "string",
                    "required": false
                },
                {
                    "name": "jde__startTimestamp",
                    "type": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
                    "required": false
                },
                {
                    "name": "jde__endTimestamp",
                    "type": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
                    "required": false
                },
                {
                    "name": "jde__serverExecutionSeconds",
                    "type": "Numeric",
                    "required": false
                }
            ],
            "fileInputs": false,
            "fileInputsRequired": false,
            "fileOutputs": false,
            "exampleOutput": ""
        }
    ]
}

Back to Top