Administrator Guide

Back Next

Discard Event Utility REST API

Use the Discard Status Event Utility REST API to discard an event according to the event ID, username, and password. This API uses the POST method.

Use the following URL for the REST API call:

POST https://<hostName>:<portNumber>/dx-server-rest-api/v1/eventUtils

is the host name or IP address of the B2B Data Exchange server.

is the port number of the B2B Data Exchange server. The utility connects to the localhost server with the default port 19553.

The following table describes the request body objects:

Object	Arguments
command	Specify the action to execute.
username	Specify which user to execute discard.
password	The password used to connect to the server.
passwordEncrypted	Optional. Indicates whether the password used to connect to the server is encrypted.
eventID	ID of the event to discard.

The following table describes the response body objects:

The following code shows the request body syntax:

{   
   "command":"discard",
   "username":"DX_MFT"
   "passwordEncrypted":"1234",
   "eventID":"100010"
      }

The following code shows the response body syntax:

   
   {   
      "responseStatus":"SUCCESS",
      "responseExtraMessage":"Event discarded",
      "responseType":"/eventUtils"
   }