Jump to

• Request
• Response
• Examples

Execute a Notification v2

post

/v2/notification/{notification}

Execute a notification.

Request

Supported Media Types

• application/json

Path Parameters

• notification(required): string
  The notification name or OMW object name.

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 ()

Root Schema : InputStream

Type: object

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 with OMW Object Name

The following shows an example of a notification request that immediately executes individual notifications. The token passed in this example was received from a separate token request. You can use other supported authentication methods.

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/notification/NTF_1707280008TOOLS  -d 
{   
    "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU="
}

        

Example Response

The following example shows the contents of the response body.

{
   "success": true,
   "received": false
}
        

Example Request with Notification Name

curl -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/notification/MyTestNotification  -d 
{   
    "token": "044QF2SLgaM6vZX081eq8KsVi6XcJiiFL5un5ACH+eBGUg=MDE5MDEyMTY4NzY4NjcwMjI2NzExNzcyNDEwLjE1OS45OS43MzE0NzkxNDU4NDM4ODU="
}

        

Example Response

The following example shows the contents of the response body.

{
   "success": false,
   "received": true
}
        

Example Error Response

The following example shows the contents of the response body when there are no subscribers to a notification. Other error scenarios, like missing dependent UDO objects, will result in error notifications sent to subscribers after notification execution.

  {
   "message": "No subscriptions: NTF_1708280001TOOLS. Add at least one subscription to execute the notification.",
   "exception": "java.lang.Exception",
   "timeStamp": "2017-08-28:13.47.17"
}

        

Back to Top