REST API Documentation

This page documents the current views implementing the REST endpoints of the equinox server. The overall structure of the API is as follows:

  • api_root (overall API root)

  • data_api_root (data API root)
    • DATA_MODEL_api collections of DATA_MODEL

    • DATA_MODEL_detail instances of DATA_MODEL


Some models only implement collective (list) views, detailed views to be implemented in due course

equinox.views.api_root(request, *args, **kwargs)

Returns a list of all active API endpoints in the Equinox installation, grouped by functionality

equinox.views.scorecard_api(request, *args, **kwargs)

List Scorecards (EBA Template)

equinox.views.scorecard_detail(request, *args, **kwargs)