Jump to

• Request
• Response
• Examples

Fetch Jargon and Translations v1

post

/jderest/jargonservice

Jargon service allows users to get the jargon and language specific names for data dictionary items in EnterpriseOne.

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 a jargon request.

Root Schema : JargonRequest

Type: object

The input to a jargon request.

Show Source

• defaultSystemCode(optional): string
  If the system code is not specified for each individual item in the request, then this system code is used for all items in the request.
• 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.
• requestedDataItems(optional): array requestedDataItems
  The list of items to request jargon for.
• 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.

{
    "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."
        },
        "defaultSystemCode":{
            "type":"string",
            "description":"If the system code is not specified for each individual item in the request, then this system code is used for all items in the request."
        },
        "requestedDataItems":{
            "type":"array",
            "description":"The list of items to request jargon for.",
            "items":{
                "$ref":"#/definitions/JargonDataItem"
            }
        }
    },
    "description":"The input to a jargon request."
}

Nested Schema : requestedDataItems

Type: array

The list of items to request jargon for.

Show Source

• Array of: object JargonDataItem
  An individual data item in the jargon request.

{
    "type":"array",
    "description":"The list of items to request jargon for.",
    "items":{
        "$ref":"#/definitions/JargonDataItem"
    }
}

Nested Schema : JargonDataItem

Type: object

An individual data item in the jargon request.

Show Source

• systemCode(optional): string
  The system code to request jargon for the associated data item.
• szDict: string
  The alias of a data dictionary item.

{
    "type":"object",
    "required":[
        "szDict"
    ],
    "properties":{
        "szDict":{
            "type":"string",
            "description":"The alias of a data dictionary item."
        },
        "systemCode":{
            "type":"string",
            "description":"The system code to request jargon for the associated data item."
        }
    },
    "description":"An individual data item in the jargon request."
}

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 Requests

Use the jargon service to get jargon and translated values for data dictionary items. Translations returned are based on the user's language preference in EnterpriseOne. The token value is from a prior call to the token request service to establish a session.

curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/jargonservice -d
{
  "token" : "044JHa5ZJWbI8PeLalEJFL8pU3VEWKJ17kotDHvwf5mFqc=MDE5MDA4OTE4MDAyNzQ2ODg2NDM2NTUxMk15RGV2aWNlMTQ3ODY0MjUyNjYzMw==",
  "deviceName" : "MyDevice",  
  "defaultSystemCode" : "01",
  "requestedDataItems" : [ {
    "szDict" : "AN8"
  }, {
    "szDict" : "MCU",
    "systemCode" : "13"
  }, {
    "szDict" : "PAN8"
  }, {
    "szDict" : "ITM",
    "systemCode" : "55"
  }, {
    "szDict" : "BLT"
  }, {
    "szDict" : "BOOLCHAR"
  }, {
    "szDict" : "BK75"
  }, {
    "szDict" : "B76ASPN"
  }, {
    "szDict" : "BIDA"
  }, {
    "szDict" : "BTDF"
  } ]
}

Example Response

The following example shows the contents of the response body.

{
  "requestedItems" : [ {
    "szDict" : "AN8",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Address             \nNumber",
    "rowDescription" : "Address Number"
  }, {
    "szDict" : "MCU",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Business            \nUnit",
    "rowDescription" : "Business Unit"
  }, {
    "szDict" : "PAN8",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Participant         \nAddress",
    "rowDescription" : "Participant Address"
  }, {
    "szDict" : "ITM",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Short               \nItem No",
    "rowDescription" : "Item Number (Short)"
  }, {
    "szDict" : "BLT",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "LT                  \nLT",
    "rowDescription" : "Ledger Type"
  }, {
    "szDict" : "BOOLCHAR",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Boolean             \nCharacter",
    "rowDescription" : "Boolean Character"
  }, {
    "szDict" : "BK75",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "",
    "rowDescription" : "A/P Bank File Upload - 350 Characters"
  }, {
    "szDict" : "B76ASPN",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Abroad Shipment     \nPlace",
    "rowDescription" : "Abroad Shipment Place"
  }, {
    "szDict" : "BIDA",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "A                   \nE",
    "rowDescription" : "Accessory Expense Type"
  }, {
    "szDict" : "BTDF",
    "systemCode" : " ",
    "language" : "  ",
    "colTitle" : "Accessory           \nExpenses",
    "rowDescription" : "Accessory Expenses"
  } ]
}

Back to Top