Skip to main content
Version: Next

StatusDto

database object
statusstringrequired
Example: connected
memoryUsage object
does_zap_garbagenumberrequired
Example: 1024
external_memorynumberrequired
Example: 2048
heap_size_limitnumberrequired
Example: 4096
malloced_memorynumberrequired
Example: 512
number_of_detached_contextsnumberrequired
Example: 0
number_of_native_contextsnumberrequired
Example: 2
peak_malloced_memorynumberrequired
Example: 1024
total_available_sizenumberrequired
Example: 8192
total_global_handles_sizenumberrequired
Example: 256
total_heap_sizenumberrequired
Example: 16384
total_heap_size_executablenumberrequired
Example: 4096
total_physical_sizenumberrequired
Example: 32768
used_global_handles_sizenumberrequired
Example: 128
used_heap_sizenumberrequired
Example: 8192
uptimenumberrequired
Example: 3600
negotiations objectrequired
localIdstringrequired
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
remoteIdstringrequired
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa7
remotePartystringrequired
Example: Remote Party Name
rolestringrequired

Possible values: [provider, consumer]

Example: provider
remoteAddressstringrequired
Example: 192.168.1.100
statestringrequired

Possible values: [dspace:REQUESTED, dspace:OFFERED, dspace:ACCEPTED, dspace:AGREED, dspace:VERIFIED, dspace:FINALIZED, dspace:TERMINATED]

Example: dspace:REQUESTED
dataSetstringrequired
Example: defaultDataSet
modifiedDatedate-timerequired
Example: 2023-10-11T00:00:00.000Z
transfers objectrequired
localIdstringrequired
Example: local-12345
remoteIdstring
Example: remote-98765
rolestringrequired
Example: provider
remoteAddressstringrequired
Example: http://example.com/
remotePartystringrequired
Example: party-identifier-001
statestringrequired

Possible values: [dspace:REQUESTED, dspace:STARTED, dspace:TERMINATED, dspace:COMPLETED, dspace:SUSPENDED]

Example: dspace:REQUESTED
process object
@typestringrequired
Example: dspace:TransferProcess
dspace:providerPidstringrequired
Example: provider-pid-789
dspace:consumerPidstringrequired
Example: consumer-pid-123
dspace:agreementIdstringrequired
Example: agreement-id-456
dspace:statestringrequired
Example: COMPLETED
agreementIdstringrequired
Example: agreement-45678
formatstring
Example: application/json
modifiedDatedate-timerequired
Example: 2023-10-01T12:34:56Z
StatusDto
{
  "database": {
    "status": "connected"
  },
  "memoryUsage": {
    "does_zap_garbage": 1024,
    "external_memory": 2048,
    "heap_size_limit": 4096,
    "malloced_memory": 512,
    "number_of_detached_contexts": 0,
    "number_of_native_contexts": 2,
    "peak_malloced_memory": 1024,
    "total_available_size": 8192,
    "total_global_handles_size": 256,
    "total_heap_size": 16384,
    "total_heap_size_executable": 4096,
    "total_physical_size": 32768,
    "used_global_handles_size": 128,
    "used_heap_size": 8192
  },
  "uptime": 3600,
  "negotiations": {
    "localId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "remoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
    "remoteParty": "Remote Party Name",
    "role": "provider",
    "remoteAddress": "192.168.1.100",
    "state": "dspace:REQUESTED",
    "dataSet": "defaultDataSet",
    "modifiedDate": "2023-10-11T00:00:00.000Z"
  },
  "transfers": {
    "localId": "local-12345",
    "remoteId": "remote-98765",
    "role": "provider",
    "remoteAddress": "http://example.com/",
    "remoteParty": "party-identifier-001",
    "state": "dspace:REQUESTED",
    "process": {
      "step": "upload",
      "progress": 50
    },
    "agreementId": "agreement-45678",
    "format": "application/json",
    "modifiedDate": "2023-10-01T12:34:56Z"
  }
}