Module Fdr (v1)#

REST Requests:#

GET /api/v1/fdr/records
DELETE /api/v1/fdr/records/(name)
GET (url)
GET /api/v1/fdr/lite_records
DELETE /api/v1/fdr/lite_records/(name)
GET (url)
GET /api/v1/fdr/bootids
GET /api/v1/fdr/bootids/CURRENT
GET /api/v1/fdr/bootids/(bootid)

Websockets:#

Websocket endpoint: GET /api/v1/fdr/notifications

Websocket Events:

current_record_updated

Websocket endpoint: GET /api/v1/fdr/fdr-lite/notifications

Websocket Events:

lite_record_added

Module Fdr REST API (v1)#

GET /api/v1/fdr/records#

get record list

Status Codes:

200 OK – the record list – JSON Schema: array(record)
500 Internal Server Error – if there is a server internal error

Example:

Get the record list

GET /api/v1/fdr/records

[
  {
    "index": -1,
    "name": "log.bin",
    "date": "19700101T000003+0000",
    "url": "/data/fdr/log.bin",
    "size": 14955817,
    "bootid": "127303FB1AD06551893C0B503F2698EC"
  },
  {
    "index": 730,
    "name": "log-730-6FC6B-19700101T001849+0000.bin",
    "date": "19700101T001849+0000",
    "url": "/data/fdr/log-730-6FC6B-19700101T001849+0000.bin",
    "size": 52458279,
    "bootid": "6FC6B6CDAA73E7ABE748B6A39588BB66"
  },
  {
    "index": 731,
    "name": "log-731-6FC6B-19700101T002805+0000.bin",
    "date": "19700101T002805+0000",
    "url": "/data/fdr/log-731-6FC6B-19700101T002805+0000.bin",
    "size": 52520895,
    "bootid": "6FC6B6CDAA73E7ABE748B6A39588BB66"
  },
  {
    "index": 732,
    "name": "log-732-6FC6B-19700101T003723+0000.bin",
    "date": "19700101T003723+0000",
    "url": "/data/fdr/log-732-6FC6B-19700101T003723+0000.bin",
    "size": 52453199,
    "bootid": "6FC6B6CDAA73E7ABE748B6A39588BB66"
  }
]

DELETE /api/v1/fdr/records/(name)#

delete a record

Parameters:

name (string) – the name of the record

Status Codes:

200 OK – no error
404 Not Found – if the requested record does not exist
500 Internal Server Error – if there is a server internal error

GET (url)#

download a record

Parameters:

url (string) – the relative url of the record (as returned in the record list)

Status Codes:

200 OK – content of the record (in response body) – JSON Schema: array(byte)
404 Not Found – if the requested record does not exist
500 Internal Server Error – if there is a server internal error

GET /api/v1/fdr/lite_records#

get lite record list

Status Codes:

200 OK – the lite record list – JSON Schema: array(lite_record)
500 Internal Server Error – if there is a server internal error

Example:

Get the lite record list

GET /api/v1/fdr/lite_records

[
  {
    "index": 21,
    "name": "log-21-8413C-19700101T000013+0000.bin",
    "date": "19700101T000013+0000",
    "url": "/data/fdr_lite/log-21-8413C-19700101T000013+0000.bin",
    "size": 1195155,
    "bootid": "8413C37C305B207A63302C9F0366B0DC"
  },
  {
    "index": 22,
    "name": "log-22-3F31D-19700101T000005+0000.bin",
    "date": "19700101T000005+0000",
    "url": "/data/fdr_lite/log-22-3F31D-19700101T000005+0000.bin",
    "size": 534839,
    "bootid": "3F31D26D036206F8BF7C126DE40BD98A"
  },
  {
    "index": 23,
    "name": "log-23-0AADF-19700101T000005+0000.bin",
    "date": "19700101T000005+0000",
    "url": "/data/fdr_lite/log-23-0AADF-19700101T000005+0000.bin",
    "size": 26308,
    "bootid": "0AADF2F6A3F06DE83A1859795DE5538B"
  }
]

DELETE /api/v1/fdr/lite_records/(name)#

delete a lite record

Parameters:

name (string) – the name of the lite record

Status Codes:

200 OK – no error
404 Not Found – if the requested lite log does not exist
500 Internal Server Error – if there is a server internal error

GET (url)#

download a lite record

Parameters:

url (string) – the relative url of the lite record (as returned in the lite record list)

Status Codes:

200 OK – content of the lite record (in response body) – JSON Schema: array(byte)
404 Not Found – if the requested lite record does not exist
500 Internal Server Error – if there is a server internal error

GET /api/v1/fdr/bootids#

get bootid list

Status Codes:

200 OK – the bootid list – JSON Schema: array(string)
500 Internal Server Error – if there is a server internal error

Example:

Get the bootid list

GET /api/v1/fdr/bootids

[
  "6FC6B6CDAA73E7ABE748B6A39588BB66",
  "5E476506E335EB6E204EC85C954358F9",
  "7B4452E36B875C0EA84CE76B4DBE60CF",
  "87AC7BC25F8B97159DD01AE11D240135",
  "944D7E63878B4125051CC581E2377A84",
  "127303FB1AD06551893C0B503F2698EC",
  "95B4AB1710E3996910C0EBFE28C64F1A",
  "ED7C26460F1B24941D9064FCF40DA714"
]

GET /api/v1/fdr/bootids/CURRENT#

get record list for current bootid

Status Codes:

200 OK – the record list for current bootid – JSON Schema: array(record)
500 Internal Server Error – if there is a server internal error

Example:

Get the record list

GET /api/v1/fdr/bootids/CURRENT

[
  {
    "index": -1,
    "name": "log.bin",
    "date": "19700101T000003+0000",
    "url": "/data/fdr/log.bin",
    "size": 14955817,
    "bootid": "127303FB1AD06551893C0B503F2698EC"
  },
  {
    "index": 779,
    "name": "log-779-12730-19700101T000003+0000.bin",
    "date": "19700101T000003+0000",
    "url": "/data/fdr/log-779-12730-19700101T000003+0000.bin",
    "size": 52473573,
    "bootid": "127303FB1AD06551893C0B503F2698EC"
  }
]

GET /api/v1/fdr/bootids/(bootid)#

get record list for a given bootid

Status Codes:

200 OK – the record list for a given bootid – JSON Schema: array(record)
500 Internal Server Error – if there is a server internal error

Example:

Get the record list

GET /api/v1/fdr/bootids/127303FB1AD06551893C0B503F2698EC

[
  {
    "index": -1,
    "name": "log.bin",
    "date": "19700101T000003+0000",
    "url": "/data/fdr/log.bin",
    "size": 14955817,
    "bootid": "127303FB1AD06551893C0B503F2698EC"
  },
  {
    "index": 779,
    "name": "log-779-12730-19700101T000003+0000.bin",
    "date": "19700101T000003+0000",
    "url": "/data/fdr/log-779-12730-19700101T000003+0000.bin",
    "size": 52473573,
    "bootid": "127303FB1AD06551893C0B503F2698EC"
  }
]

Module Fdr Websocket events (v1)#

Endpoint:

GET /api/v1/fdr/notifications#

Request Headers:

Connection – Upgrade
Upgrade – websocket

Events:

current_record_updated

Module Fdr JSON Schema (v1)#

current_record_updated#

type	object
properties
name	string
data	current_record_updated_event_data

current_record_updated_event_data#

type	object
properties
current_record	record

record#

type	object
properties
index	integer
name	string
date	string
url	string
size	integer
bootid	string

lite_record_added_event_data#

type	object
properties
lite_record_added	lite_record

lite_record#

type	object
properties
index	integer
name	string
date	string
url	string
size	integer
bootid	string

Endpoint:

GET /api/v1/fdr/fdr-lite/notifications#

Request Headers:

Connection – Upgrade
Upgrade – websocket

Events:

lite_record_added

Module Fdr JSON Schema (v1)#

lite_record_added#

type	object
properties
name	string
data	lite_record_added_event_data

current_record_updated_event_data#

type	object
properties
current_record	record

record#

type	object
properties
index	integer
name	string
date	string
url	string
size	integer
bootid	string

lite_record_added_event_data#

type	object
properties
lite_record_added	lite_record

lite_record#

type	object
properties
index	integer
name	string
date	string
url	string
size	integer
bootid	string