Skip to content

GetReceivedEvents

Diego Ramos edited this page Apr 27, 2023 · 1 revision

Gets The Received Events - Rest API

Gets the received events paginated

Base Url : http://your-app-base-url.com

Endpoint : /event

Method : GET

Auth required : Yes

header key header value description
Authorization BEARER jwtToken access_token generated using /token

Permissions required : Access string 'event:select'

Request

type: query

{
  "itemsPerPage": 5,
  "pageIndex": 0,
  "order": "desc"
}

Request Fields Description

key value description
itemsPerPage 5 events per page
pageIndex 0 pagination page index
order desc pagination order

Response

{
  "code": 200000,
  "message": "Select completed",
  "content": {
    "items": [
      {
        "id": 1,
        "systemId": 1,
        "eventId": 1,
        "systemName": "System Name",
        "systemIdentifier": "system_identifier",
        "eventName": "Event name",
        "eventIdentifier": "event_identifier",
        "eventDescription": "Description"
      }
    ],
    "pageIndex": 0,
    "itemsPerPage": 5,
    "totalItems": 1,
    "totalPages": 1
  }
}

Response Fields Description

key value description
code 200000 result code
message Select completed result message
content Object the event select pagination
pageIndex 0 the page position index
itemsPerPage 5 events per page
totalItems 1 total events
totalPages 1 total pages of the pagination
items Array of event object The list of events

Response codes

  • If response is success, http status will be 200 and code in body will be 200000
code description
500000 Not categorized error
200000 event list selected

Eventhos

Configurations

Deployment

Usage

Endpoints

Send event

Oauth2

For UI

  • get all events
    • GET /event
  • create events
    • POST /event
  • update events
    • PUT /event
  • delete event
    • DELETE /event
  • get all received events
  • get details of received event
    • GET /event/received/:id
  • get details of executed contracts
    • GET /received/execution-detail/:id
  • create system

Queue Manager

Mail notifications

Ports

Contributions

CDN

Clone this wiki locally