WP4: Infrastructure
Space shortcuts
Page tree

Versions Compared

Old Version 17

changes.mady.by.user Marco Soldati

Saved on

compared with

New Version 18

changes.mady.by.user Marco Soldati

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DatabaseResource
Data ArchiveObservation (e.g. FITS-Files)
Staging TableEvent, ... (e.g. Event lists)
Feature Property DatabaseFeature (such as Active Regions), FeatureProperty (e.g. Area, Contour, Zurich-Class, ...)
Predictions Config DBScalars, Vectors, Matrices (e.g. Algo-Configurations)
Prediction DB?
Infrastructure Configuration DBAlgorithm, Person,

 

Standards

This is a test to see if we can create inline comments  And follow up

 

 

The API is self-documenting such that there a single entry point to all databases. This would be access to the resources.

 

Resources

Anything accessible through the API is a "resource". All available resources can be listed.

Get list of observation types
Queryhttps://api.flarecast.eu/
Replace
varrestBaseUrl
/resources/list
Result
Code Block
languagejs
{
	{
    "people" : {
        "description": "Persons or groups responsible",
        "baseURL": "https://api.flarecast.eu/people/"
    },
    "algorithms" : {
        "description" : "Registered algorithms (read-only)",
        "baseURL" : "https://api.flarecast.eu/algorithms/"
    },

    "features" : {
        "description" : "Features accessible through this API",
        "baseURL" : "https://api.flarecast.eu/features/"
    },
    
    "observations" : {
        "description" : "Observations accessible through this API",
        "baseURL" : "https://api.flarecast.eu/observations/"
    },
	...
 }

...

The file archive is basically a directory structure from where the files can be loaded through the http:// protocol.

Get list of available observationsobservation types
Query

https://api.flarecast.eu/observations/list

Replace
varrestBaseUrl
/observations

Result
Code Block
languagejs
{
	"sdo_hmi_720" : {
		"description" : "SDO HMI",
		"baseURL" : "https://api.flarecast.eu/observations/sdo/hmi/fits/",
		"filepattern": "${YYYY}/${MM}/${DD}/hmi.M_720s_nrt.${YYMMDD}_${nr}_TAI.fits",
		"startDatetimeBegin": "2015-01-01T
 01T00:00:00Z",
		"timeEnd": "2015-04-20T00:00:00Z"
    },
	"sdo_hmi_45" : { ... }
}

 

 

 

Search for files
Query https://api.flarecast.eu/
Replace
varrestBaseUrl
/observations/sdo/hmi/list?timerange=20150101T000000.0-20150101T120000.0
Result
Code Block
languagejs
{
	"https://api.flarecast.eu/observations/sdo/hmi/fits/2015/04/20/hmi.M_720s_nrt.20150420_010000_TAI.fits",
	"https://api.flarecast.eu/observations/sdo/hmi/fits/2015/04/20/hmi.M_720s_nrt.20150420_020000_TAI.fits",
	"https://api.flarecast.eu/observations/sdo/hmi/fits/2015/04/20/hmi.M_720s_nrt.20150420_030000_TAI.fits",
	...
}

...

Get list of features
Query https://api.flarecast.eu/
Replace
varrestBaseUrl
/features/list
Result
Code Block
languagejs
{
    "id": {
      "type": "long"
    },
    "timestamp": {
      "type": "datetime"
    },
    "area": {
      "type": "double",
      "unit": "m2",
      "version": 5
    },
    "contour": {
      "type": "int[]",
      "description": "chaincode, 0 is left, 1-7 is direction counter clockwise",
      "version": 1
    }
}
Template
Queryhttps:
Replace
varrestBaseUrl
//api.flarecast.eu/features/query?time_begin=20150101T000000.0&time_end=20150101T000000.0&fields=id,timestamp,area,contour 
Result
Code Block
languagejs
{
    "id": {
      "type": "long"
    },
    "timestamp": {
      "type": "datetime"
    },
    "area": {
      "type": "double",
      "unit": "m2",
      "version": 5
    },
    "contour": {
      "type": "int[]",
      "description": "chaincode, 0 is left, 1-7 is direction counter clockwise",
      "version": 1
    },
    "data": [
      [
        1,
        "2015-01-01T10:20:00.0",
        12321,
        [0,1,1,1,3,3,4,4,4,4,4,5,5,6,6,7,7,7,7,0]
      ],
      [
        2,
        "2015-01-01T10:20:45.0",
        14412,
        [0,1,1,1,3,3,4,4,4,4,4,5,5,6,6,7,7,7,7,0]
      ],
      [
        3,
        "2015-01-01T10:21:30.0",
        14434,
        [0,1,1,1,3,3,4,4,4,4,4,5,5,6,6,7,7,7,7,0]
      ]
    ]
}

...