Jump to

• Request
• Response
• Examples

List Notifications v2

post

/jderest/v2/notification/discover

Request a list of available notifications.

Request

Supported Media Types

• application/json

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", "monitorRequestAndSteps", "monitorRequestIOAndSteps", "monitorRequestAndStepsIO", "monitorRequestIOAndStepsIO" ]

Body ()

The request to notification discover service.

Root Schema : NotificationDiscoveryRequest

Type: object

The request to notification discover service.

Show Source

• deviceName: string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment: string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• jasserver: string
  The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
• notification: string
  The name or omw object name of the notification if a single one is requested.
• password: string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken: string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• role: string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• token: string
  The AIS token, which is required if other authentication methods are not being used.
• username: 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."
        },
        "notification":{
            "type":"string",
            "description":"The name or omw object name of the notification if a single one is requested."
        }
    },
    "description":"The request to notification discover 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: 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 All

The following shows an example of a notification discover request that returns all the notifications available to the calling user. The token passed in this example was received from a separate token request. You can also use other supported authentication methods.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/notification/discover -d 

{   
    "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU="
}

        

Example Response

The following example shows the contents of the response body.

{"notifications": [
      {
      "name": "DemoNotification",
      "description": "DemoNotification",
      "productCode": "55",
      "omwObjectName": "NTF_1708250001TOOLS",
      "user": "DEMO",
      "oncePerSubscriber": false,
      "allowSubscriberOverrides": false,
      "inputs": [      {
         "name": "Input1",
         "type": "String",
         "required": false,
         "displayName": "Input1"
      }],
      "outputType": "string",
      "udoGroup": "Personal",
      "omwObjectOwner": "DEMO",
      "scheduleUDOName": "SCH_1708140001TOOLS"
   },
      {
      "name": "My Notification",
      "description": "Notify users of a watchlist value",
      "productCode": "04",
      "omwObjectName": "NTF_1708020004TOOLS",
      "user": "*PUBLIC",
      "oncePerSubscriber": true,
      "allowSubscriberOverrides": false,
      "inputs": [      {
         "name": "SearchType",
         "type": "String",
         "required": true,
         "defaultValue": "X",
         "displayName": "SearchType"
      }],
      "output": "Watchlist Output",
      "outputType": "wllevel",
      "udoGroup": "Shared",
      "omwObjectOwner": "*PUBLIC",
      "scheduleUDOName": "SCH_1708020004TOOLS"
   }
]}
        

Example Request Single

The following shows an example of a notification discover request that returns the requested notification (if available) to the calling user. The token passed in this example was received from a separate token request. You can also use other supported authentication methods.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/notification/discover -d 

{   
    "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=",
    "notification":"OrdersAwaitingApproval"
}

        

Example Single Response

The following example shows the contents of the response body.

{
    "notifications": [
        {
            "omwObjectName": "NTF_2405150001JDE",
            "studioVersion": "9.2.9.0",
            "name": "OrdersAwaitingApproval",
            "version": "",
            "productCode": "55",
            "locale": "en",
            "updateTime": 1726854126194,
            "description": "OrdersAwaitingApproval",
            "user": "NICOLE",
            "oncePerSubscriber": false,
            "allowSubscriberOverrides": false,
            "orchestration": "OrdersAwaitingApproval",
            "orchUdoName": "ORC_2405150002JDE",
            "watchlistName": "",
            "watchlistUDOName": "",
            "rule": "IsGreaterZero",
            "ruleUdoName": "RUL_2308210002JDE",
            "messageSubject": "${Count} Orders awaiting your approval",
            "messageBody": "",
            "messageBodyAsRichText": "<p>Please see orders awaiting your approval....;",
            "msgAsRichText": true,
            "inputs": [],
            "orchInputs": [],
            "ruleInputs": [
                {
                    "input": "Count",
                    "output": "input",
                    "defaultValue": ""
                }
            ],
            "shortcut": {},
            "moreActions": {
                "shortcut": [
                    {
                        "application": "P43081",
                        "form_name": "W43081A",
                        "version": "ZJDE0001",
                        "formInterconnect": {
                            "data_structure_template": "W43081A",
                            "formInputs": [
                                {
                                    "id": "1",
                                    "value": "",
                                    "description": "Hold Code (HCOD)",
                                    "name": "HoldValue"
                                },
                                {
                                    "id": "2",
                                    "value": "",
                                    "description": "Order Type (DCTO)",
                                    "name": "OrderType"
                                },
                                {
                                    "id": "3",
                                    "value": "",
                                    "description": "Document (Order No, Invoice, etc.) (DOCO)",
                                    "name": "DocumentOrderInvoiceE"
                                },
                                {
                                    "id": "4",
                                    "value": "",
                                    "description": "Order Company (Order Number) (KCOO)",
                                    "name": "CompanyKeyOrderNo"
                                },
                                {
                                    "id": "5",
                                    "value": "",
                                    "description": "Line Number (LNID)",
                                    "name": "LineNumber"
                                },
                                {
                                    "id": "6",
                                    "value": "",
                                    "description": "Date - Released (Julian) (RDJ)",
                                    "name": "DateReleasedJulian"
                                },
                                {
                                    "id": "7",
                                    "value": "",
                                    "description": "Time - Released (RDT)",
                                    "name": "TimeReleased"
                                },
                                {
                                    "id": "8",
                                    "value": "",
                                    "description": "Status - Approval (ASTS)",
                                    "name": "StatusApproval"
                                },
                                {
                                    "id": "9",
                                    "value": "",
                                    "description": "Business Unit (MCU)",
                                    "name": "szCostCenter"
                                },
                                {
                                    "id": "10",
                                    "value": "",
                                    "description": "Days - Orders Older Than (DORE1)",
                                    "name": "mnOrdersOlderThan"
                                },
                                {
                                    "id": "11",
                                    "value": "",
                                    "description": "Days - Orders Waiting More Than (DWTE1)",
                                    "name": "mnOrdersWaitingMoreThan"
                                }
                            ]
                        },
                        "linkText": "Orders Awaiting",
                        "linkid": "P43081"
                    }
                ]
            },
            "ddTemplate": {
                "parameter": []
            },
            "services": {},
            "outputType": "String",
            "WATCHLIST_LEVEL": "wllevel",
            "udoGroup": "Personal",
            "omwObjectOwner": "NICOLE",
            "translations": [
                {}
            ],
            "monitoringLevel": [],
            "monitorOnStart": false,
            "monitorAllEnvironments": false,
            "monitorAllUsers": false,
            "monitorEnvironments": [],
            "monitorUsers": [],
            "attachments": {
                "includeBinaryInEmail": true
            },
            "enableReminder": true,
            "reminderRuleOption": "RULE",
            "reminderDateRule": "DAYS",
            "reminderRuleAmount": 1,
            "reminderTime": "T23:55:00",
            "reminderTimeZone": "America/Denver",
            "dateRuleLiteral": true,
            "dataTables": {
                "dataTableList": [
                    {
                        "placeholderName": "OrdersAwaitingApproval_1",
                        "tableTemplate": "figure..."
                    }
                ]
            }
        }
    ]
}
        

Back to Top