Jump to

• Request
• Response
• Examples

Manage Preferences v2

post

/jderest/v2/preference

Enables management of preference records in the User Overrides Table (F98950).

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 preference service, which stores records in the F98950.

Root Schema : PreferenceRequest

Type: object

The input to the preference service, which stores records in the F98950.

Show Source

• action(optional): string
  Allowed Values: [ "GET", "PUT" ]

  The action to perform for this preference key.
• 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.
• formName(optional): string
  The key value to be stored in the Form Name field.
• idList(optional): string
  The key value to be stored in the ID List field.
• 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.
• language(optional): string
  The key value to be stored in the Language field.
• objectName(optional): string
  The key value to be stored in the Object Name field.
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• preferenceData(optional): string
• 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.
• sequence(optional): integer(int32)
  The key value to be stored in the Sequence field.
• 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 key value to be stored in the Version field.

{
    "type":"object",
    "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."
        },
        "objectName":{
            "type":"string",
            "description":"The key value to be stored in the Object Name field."
        },
        "action":{
            "type":"string",
            "description":"The action to perform for this preference key.",
            "enum":[
                "GET",
                "PUT"
            ]
        },
        "preferenceData":{
            "type":"string"
        },
        "sequence":{
            "type":"integer",
            "format":"int32",
            "description":"The key value to be stored in the Sequence field."
        },
        "formName":{
            "type":"string",
            "description":"The key value to be stored in the Form Name field."
        },
        "idList":{
            "type":"string",
            "description":"The key value to be stored in the ID List field."
        },
        "version":{
            "type":"string",
            "description":"The key value to be stored in the Version field."
        },
        "language":{
            "type":"string",
            "description":"The key value to be stored in the Language field."
        }
    },
    "description":"The input to the preference service, which stores records in the F98950."
}

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 PUT Action

The following shows an example of a preference request to save preferences. The data is passed and stored as a JSON string in this example. Any string value is acceptable. The token passed in this example was recieved from a separate token request. The key fields are objectName, formName, version, sequence, idList, and language. In this example only the objectName part of the key is used.

curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/preference/ -d
{
    "token": "044Q1K8vjSvpc9VPrS1m6GyNIx375L0FCdftSDOQ356lEc=MDE5MDEyNjAyNzYyNTEzMjk4OTEwMzUyNTEwLjE1OS45OS43MzE0NzkxNTA2NTY1NzU=",
    "action": "GETPUT",
    "objectName": "M55100",
    "preferenceData": "{\"pref2\":15.45,\"pref1\":\"Preference 1 String\",\"pref3\":8,\"pref4\":1443645908933}"
}

        

Example PUT Response

The following example shows the contents of the response body.

{
   "objectName": "M55100",
   "type": "PS",
   "preferenceData": "{\"pref2\":15.45,\"pref1\":\"Preference 1 String\",\"pref3\":8,\"pref4\":1443645908933}"
}       

Example Request GET Action

The following shows an example of a preference request to get stored preferences.

curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/preference/ -d
{
    "token": "044Q1K8vjSvpc9VPrS1m6GyNIx375L0FCdftSDOQ356lEc=MDE5MDEyNjAyNzYyNTEzMjk4OTEwMzUyNTEwLjE1OS45OS43MzE0NzkxNTA2NTY1NzU=",
    "action": "GET",
    "objectName": "M55100"
}

        

Example GET Response

The following example shows the contents of the response body.

{
   "objectName": "M55100",
   "type": "PS",
   "preferenceData": "{\"pref2\":15.45,\"pref1\":\"Preference 1 String\",\"pref3\":8,\"pref4\":1443645908933}"
}       

Back to Top