List Notifications v2
post
/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 RequestAllowed Values:
[ "monitorRequest", "monitorRequestIO", "monitorRequestAndSteps", "monitorRequestIOAndSteps", "monitorRequestAndStepsIO", "monitorRequestIOAndStepsIO" ]
Top level object for all AIS service requests, containing authentication information applicable to all services.
Root Schema : AISRequest
Type:
object
Top level object for all AIS service requests, containing authentication information applicable to all services.
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.
-
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.
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
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.
500 Response
Server Failed to Process Request
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.
Examples
Example Request
The following shows an example of a notification discover request that returns 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" } ]}