-
Notifications
You must be signed in to change notification settings - Fork 10
In addition to a web-based front-end for the IOOS Compliance Checker project where users can upload files or provide remote OPeNDAP urls, an API is provided for users interested in batch processing files hosted via OPeNDAP. Details on how to use the API are provided below.
Build a GET request to return the results of a IOOS compliance checker run.
Example:
/api/run?report_format=html&test=acdd&url=https://chlthredds.erdc.dren.mil/thredds/dodsC/frf/oceanography/ctd/eop-ctd/2014/FRF-ocean_ctd_eop-ctd_201405.nc
test - This is the ID of the checker you want to test against. Some examples are:
acdd:1.3
acdd:1.1
cf:1.6
gliderdac
ioos:1.1
ncei-grid:1.1
ncei-point
ncei-profile-incomplete
ncei-profile-orthogonal
ncei-timeseries-incomplete:latest
ncei-timeseries-orthogonal
ncei-timeseries-profile-incomplete:1.1
ncei-timeseries-profile-incompletetime-orthdepth:latest
ncei-timeseries-profile-orthogonal
ncei-timeseries-profile-orthtime-incompletedepth
ncei-trajectory
ncei-trajectory-profile-incomplete:1.1
ncei-trajectory-profile-orthogonal
url - This is the full url to the OPeNDAP endpoint of the data set you want to check.
report_format - This sets the format of the results. Currently only supports json and html. The html option simply redirects to the standard compliance-checker-web report page.
Compiles the checks, results and scores into an aggregate JSON object with the following keys:
{
"scored_points": 286,
"low_count": 0,
"possible_points": 293,
"testname": "cf",
"medium_count": 1,
"source_name": "http://chlthredds.erdc.dren.mil/thredds/dodsC/frf/oceanography/waves/waverider-26m/2016/FRF-ocean_waves_waverider-26m_201608.nc",
"high_count": 4,
"all_priorities" : [...],
"high_priorities": [...],
"medium_priorities" : [...],
"low_priorities" : [...]
}
all_priorities - All of the priorities checked
high_count - Number of failed high priority checks
high_priorities - List of objects containing each of the high priority checks, their score, and any corrective actions
medium_count - Number of failed medium priority checks
medium_priorities - List of objects containing each of the medium priority checks, their score, and any corrective actions
low_count - Number of failed low priority checks
low_priorities - List of objects containing each of the low priority checks, their score, and any corrective actions
ncdump - Text representation of the metadata in the file
possible_points - Total number of possible points
scored_points - Total number of scored points
source_name - Name of the file (URL)
testname - Name of the test being run (see test above)