Jump to

• Request
• Response
• Examples

Get Notification Subscriptions v2

post

/jderest/v2/notification/subscriptions

Get the list of subscribers to a specific notification.

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

Body ()

The objects used to request the subscriptions to a notification.

Root Schema : GetSubscriptionsRequest

Type: object

The objects used to request the subscriptions to a notification.

Show Source

• 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.
• notificationId: string
  The OMW object name for the notification (notification name is not acceptable).
• 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.
• webObjectUser: string
  The user that is the owner of the UDO, if shared use *PUBLIC. The default value is *PUBLIC

{
    "type":"object",
    "required":[
        "notificationId",
        "webObjectUser"
    ],
    "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."
        },
        "notificationId":{
            "type":"string",
            "description":"The OMW object name for the notification (notification name is not acceptable)."
        },
        "webObjectUser":{
            "type":"string",
            "description":"The user that is the owner of the UDO, if shared use *PUBLIC. The default value is *PUBLIC"
        }
    },
    "description":"The objects used to request the subscriptions to a notification."
}

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 notification subscriptions request that returns a list of current subscriptions to the notification. The OMW object name of the notification is used for the notificationId. 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/subscriptions -d 

{   
    "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU=",
    "notificationId":"NTF_1707280008TOOLS",
	"webObjectUser":"*PUBLIC"
}

        

Example Response

The following example shows the contents of the response body.

{
   "subscriptions":    [
            {
         "subscriber": "DEMO",
         "id": "c8093053-3f9b-6d1e-2441-7de9b3eddfff",
         "owner": "*PUBLIC",
         "lastRunTime": 0,
         "lastNotifiedTime": 0,
         "inputsOverride": [         {
            "name": "Input1",
            "value": "6044"
         }]
      },
            {
         "subscriber": "SUSER",
         "id": "d84fd888-aa93-68eb-0e0d-99b16a07dc21",
         "owner": "*PUBLIC",
         "lastRunTime": 0,
         "lastNotifiedTime": 0,
         "inputsOverride":          [
                        {
               "name": "Input1",
               "value": "6001"
            },
                        {
               "name": "Input2",
               "value": "SUSER VAL"
            }
         ]
      },           
            {
         "subscriber": "CTUSER",
         "id": "f30eaf3f-8a28-cf37-fa7f-5412d478ffef",
         "owner": "*PUBLIC",
         "lastRunTime": 0,
         "lastNotifiedTime": 0,
         "inputsOverride": [         {
            "name": "Input1",
            "value": "7500"
         }]
      }
   ],
   "environment": "JDV920",
   "wobnm": "NTF_1707280008TOOLS"
}
        

Back to Top