Bucket Expiry EDRs

Purpose

Bucket expiry EDRs are generated by the OCS “engine” subsystem when a bucket is removed by the engine. This will happen when an wallet is removed due to lifecycle processing, along with when a bucket expires due to the expiry set on the bucket.

An OCS bucket expiry EDR is identified by the type equal bucket-expiry. In addition, the correlation-info.ocs-inner-intent.intention will always be EXPIRY.

Note that bucket expiry will never be tied to an externally triggered event directly via the slee-session-id. The OCS wallet processing is always done using a GUID generated specifically for the purpose of the processing.

Example

{
  "type": "bucket-expiry",
  "node-name": "marc",
  "event-timestamp": "2023-03-25T23:32:31.144364600Z",
  "correlation-info": {
    "slee-session-id": "8afe308d-0cca-4d86-9b68-d99e273e11f0",
    "slee-event-id": "1/1",
    "ocs-inner-intent": {
      "intention": "EXPIRY"
    }
  },
  "source-info": {
    "source-service": "localhost:62995",
    "source-system": "n2ocs",
    "source-endpoint": "localhost:10800",
    "source-subsystem": "http-api"
  },
  "status-message": "",
  "account-info": {
    "account-id": "TestAccount02a560d8-37ca-456e-94f6-ab4ca9bb4434"
  },
  "bucket-id": "CbqMYI",
  "bucket-info-initial": {
    "bucket-id": "CbqMYI",
    "bucket-amount": 1234,
    "bucket-unit": "bytes",
    "bucket-expiry": "2023-03-25T23:32:28.693924700Z"
  }
}

Fields

Field Type Presence Description
account-info Object Always Information on the wallet the bucket was attached to.
account-info.account-id String Always The unique ID of the wallet that the bucket was attached to.
bucket-id String Always The ID of the bucket from the wallet. This will always be unique within the wallet itself.
bucket-info-initial Object Always Information of the bucket that expired and was removed from the wallet.

In the bucket-info-initial object the bucket’s details will be included. This includes all the information that would normally be retrieved about the bucket through the OCS API.