Jump to

• Request
• Response
• Examples

Get Processing Options v2

post

/jderest/v2/poservice

Get the values of the processing options for the specified application and version.

Request

Supported Media Types

• application/json

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

Body ()

The input to the processing option service.

Root Schema : ProcessingOptionRequest

Type: object

The input to the processing option service.

Show Source

• applicationName: string
  The application name to fetch processing option values for.
• deviceName(optional): string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment(optional): string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• jasserver(optional): string
  The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken(optional): string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• role(optional): string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• token(optional): string
  The AIS token, which is required if other authentication methods are not being used.
• username(optional): string
  JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.
• version(optional): string
  The version of the application to get processing options for, if not passed the default version ZJDE0001 will be used.

{
    "type":"object",
    "required":[
        "applicationName"
    ],
    "properties":{
        "environment":{
            "type":"string",
            "description":"Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used."
        },
        "role":{
            "type":"string",
            "description":"The role to use for login. If not specified, the default role configured for the AIS Server will be used."
        },
        "jasserver":{
            "type":"string",
            "description":"The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used."
        },
        "token":{
            "type":"string",
            "description":"The AIS token, which is required if other authentication methods are not being used."
        },
        "deviceName":{
            "type":"string",
            "description":"An identifier for the device making the service call. If not provided, the requesting IP address is used."
        },
        "psToken":{
            "type":"string",
            "description":"Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server."
        },
        "username":{
            "type":"string",
            "description":"JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used."
        },
        "password":{
            "type":"string",
            "description":"The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used."
        },
        "applicationName":{
            "type":"string",
            "description":"The application name to fetch processing option values for."
        },
        "version":{
            "type":"string",
            "description":"The version of the application to get processing options for, if not passed the default version ZJDE0001 will be used."
        }
    },
    "description":"The input to the processing option service."
}

Back to Top

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

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

The following shows an example of a processing options request for all the tasks. The token value is from a prior call to the tokenrequest service to establish a session.

{
  "token" : "044zdgq3HTrdXXI547NUmJbkL/6KsjigD838pqtWFjF7AM=MDE5MDA4NzQzMTEwOTA1MDQ4MjgzOTM0MU15RGV2aWNlMTQ4MjE3MDY4OTgxMA==",
  "deviceName" : "MyDevice",
  "ssoEnabled" : false,
  "applicationName" : "P12120U",
  "version" : "ZJDE0001"
}

Example Response

The following example shows the contents of the response body.

{
  "application" : "P12120U",
  "version" : "ZJDE0001",
  "processingOptions" : {
    "cOdometerDisplay_EV01_5" : {
      "type" : 1,
      "value" : "1"
    },
    "cFuelDisplay_EV01_6" : {
      "type" : 1,
      "value" : "1"
    },
    "cHourDisplay_EV01_7" : {
      "type" : 1,
      "value" : "1"
    },
    "cMeter4Display_EV01_27" : {
      "type" : 1,
      "value" : " "
    },
    "cMeter5Display_EV01_28" : {
      "type" : 1,
      "value" : " "
    },
    "cMeter6Display_EV01_29" : {
      "type" : 1,
      "value" : " "
    },
    "szTemplateName_TEMPNAME_26" : {
      "type" : 2,
      "value" : " "
    },
    "cUpdateChildCurrentMeter_EV01_1" : {
      "type" : 1,
      "value" : "1"
    },
    "cUpdateChildOriginalMeter_EV01_2" : {
      "type" : 1,
      "value" : " "
    },
    "cAutoLoadTemplate_YN01_25" : {
      "type" : 1,
      "value" : " "
    },
    "szR12807Version_VERS_3" : {
      "type" : 2,
      "value" : " "
    },
    "mnToleranceLevel_PCT1_4" : {
      "type" : 9,
      "value" : "0"
    }
  },
  "errors" : ""
}

Back to Top