v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
z) Global Functionality

List global callbacks

get/eclipse-conductor/rest/v1/global/callback

Query parameters

callbackIdinteger
dateFromInclstring

Start of date range (inclusive). ISO date string.

dateToExclstring

End of date range (exclusive). ISO date string.

limitinteger
offsetinteger
status'DELETED' | 'DO_FAILURE' | 'DO_SUCCESS' | 'PENDING' | 'WAS_DO_FAILURE' | 'WAS_DO_SUCCESS' | 'WAS_FAILURE' | 'WAS_SUCCESS'

Response

OK

callbackIdinteger

CallbackId for callbacks

createdstring date-time

Created Date of callbacks

dependsOnCallbackIdsstring

Depends On Callback IDs means that certain callbacks are dependent on the successful completion of other specific callbacks before they can be executed or processed.

expiresstring date-time

Expiration Date of callbacks

failureDatastring

failureData of a callback represents the data payload or response received when an HTTP request fails to process successfully.

httpMethodstring

The httpMethod of a callback indicates the specific HTTP method used to send the callback request, such as GET, POST, PUT, or DELETE.

lastModifiedstring date-time

Last Modified Date of callbacks

latencyMsinteger

The latency in milliseconds (ms) of callbacks refers to the time taken for the system to process and respond to the callback request.

mediaTypestring

The mediaType of callbacks refers to the format or type of media used to transmit callback data, such as JSON, XML, or multipart/form-data.

pathstring

The path (URL) of callbacks indicates the specific endpoint or route where the callback requests are sent to within the system's architecture.

requestCountinteger

The request count of callbacks indicates the number of times an HTTP request for callbacks has been made.

resultBodystring

resultBody of a callback contains the body of the HTTP response when a result is provided.

resultCodeinteger

The resultCode of callbacks represents the code or status returned by the system to indicate the outcome or result of the callback request.

serviceTypestring

The serviceType of callbacks refers to the specific type or category of the callback services being utilized in the system.

status'DELETED' | 'DO_FAILURE' | 'DO_SUCCESS' | 'PENDING' | 'WAS_DO_FAILURE' | 'WAS_DO_SUCCESS' | 'WAS_FAILURE' | 'WAS_SUCCESS'
successDatastring

successData of a callback denotes the data payload or response received when an HTTP request is successfully processed.

tryUntilstring date-time

The tryUntil date of callbacks indicates the specific date or time until which the system will attempt to process the callback requests.

Example response

[
  {
    "created": "2022-03-10T12:15:50-04:00",
    "expires": "2022-03-10T12:15:50-04:00",
    "lastModified": "2022-03-10T12:15:50-04:00",
    "tryUntil": "2022-03-10T12:15:50-04:00"
  }
]