Administrator Guide

10.5.0
- 10.5.3
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.2
- 10.2

Back Next

Change Status Event Utility REST API

Use the Change Status Event Utility REST API to change an event status according to the status name, 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 status change.
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 change the status of.
statusName	Specify the status to change the event to.

The following table describes the response body objects:

Object	Arguments
responseStatus	Status of the status change.
responseExtraMessage	Details of the status change.
responseType	Type of action executed.

Request Body Example

The following code shows the request body syntax:

{   
   "command":"changestatus",
   "username":"DX_MFT"
   "passwordEncrypted":"1234",
   "eventID":"100010",
   "statusName":"Complete"
      }

Response Body Example

The following code shows the response body syntax:

   
   {   
      "responseStatus":"SUCCESS",
      "responseExtraMessage":"Event status changed to Complete",
      "responseType":"/eventUtils"
   }

Rename Saved Search

Table of Contents

Administrator Guide

Administrator Guide

Change Status Event Utility REST API

Change Status Event Utility REST API

Request Body Example

Response Body Example