Operations

notify

post

This method forces notification of a given transaction.

Body
Responses
200

OK

application/json
Responseobject
post
/operations/notify
POST /gbds/v2/operations/notify HTTP/1.1
Host: <ip>:8085
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 240

{
  "data": {
    "operation": "UNKNOWN",
    "tguid": "text",
    "status": "text",
    "sender": "text",
    "uguid": "text",
    "additionalData": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "relatedTransactions": [
      {
        "status": "text",
        "tguid": "text",
        "pguid": "text",
        "operation": "UNKNOWN"
      }
    ]
  }
}
{}

ping

get

This method is used to check the API availability.

Responses
200

OK

application/json
get
/operations/ping
GET /gbds/v2/operations/ping HTTP/1.1
Host: <ip>:8085
Accept: */*
200

OK

{
  "body": "pong!"
}

getServices

get

Returns the list of the system's internal services and their statuses (active, stopped, etc.) to enable operational monitoring.

Responses
200

OK

application/json
get
/operations/services
GET /gbds/v2/operations/services HTTP/1.1
Host: <ip>:8085
Accept: */*
200

OK

{
  "data": {
    "api": {
      "version": "text",
      "build": "text",
      "apiId": "text",
      "apiType": "LEADER"
    },
    "searchEngine": {
      "version": "text",
      "build": "text",
      "apiId": "text",
      "apiType": "LEADER"
    }
  },
  "httpResponse": {
    "httpCode": 1,
    "body": "text"
  }
}

Stop service

post

Sends a command to stop one or more services indicated in the request body, enabling maintenance or controlled reboot.

Body
Responses
200

OK

application/json
Responseobject
post
/operations/services/stop
POST /gbds/v2/operations/services/stop HTTP/1.1
Host: <ip>:8085
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 167

{
  "data": {
    "api": {
      "version": "text",
      "build": "text",
      "apiId": "text",
      "apiType": "LEADER"
    },
    "searchEngine": {
      "version": "text",
      "build": "text",
      "apiId": "text",
      "apiType": "LEADER"
    }
  }
}
200

OK

{}

Publish operation

post

Publishes an operational event or notification in the system, using the JSON payload to specify title, message and recipients.

Body
operationstring · enumOptional

Operation type of the transaction that notification is related to.

Possible values:
tguidstringOptional

Transaction's global unique ID of the transaction that notification is related to.

statusstringOptional

Current status of the transaction that notification is related to.

senderstringOptional

The notification sender.

uguidstringOptional

Global unique ID of an unsolved latent. Only used when the notification is related to a transaction that treats an unsolved latent.

Responses
200

OK

application/json
Responseobject
post
/operations/notification
POST /gbds/v2/operations/notification HTTP/1.1
Host: <ip>:8085
Content-Type: application/json;charset=UTF-8
Accept: */*
Content-Length: 231

{
  "operation": "UNKNOWN",
  "tguid": "text",
  "status": "text",
  "sender": "text",
  "uguid": "text",
  "additionalData": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "relatedTransactions": [
    {
      "status": "text",
      "tguid": "text",
      "pguid": "text",
      "operation": "UNKNOWN"
    }
  ]
}
200

OK

{}

Was this helpful?