REST API Specification

The REST API specification for managing and accessing data from the Observatory Platform.

GET /v1/dataset_release

get a DatasetRelease

Get the details of a DatasetRelease by passing it’s id.

Query Parameters:

  • id (required) – DatasetRelease id

Status Codes:
POST /v1/dataset_release

create a DatasetRelease

Create a DatasetRelease by passing a DatasetRelease object, without an id.

Status Codes:

  • 201 Created – DatasetRelease created, returning the created object with an id

PUT /v1/dataset_release

create or update a DatasetRelease

Create a DatasetRelease by passing a DatasetRelease object, without an id. Update an existing DatasetRelease by passing a DatasetRelease object with an id.

Status Codes:

  • 200 OK – DatasetRelease updated

  • 201 Created – DatasetRelease created, returning the created object with an id

DELETE /v1/dataset_release

delete a DatasetRelease

Delete a DatasetRelease by passing it’s id.

Query Parameters:

  • id (required) – DatasetRelease id

Status Codes:

  • 200 OK – DatasetRelease deleted

GET /v1/dataset_releases

Get a list of DatasetRelease objects

Get a list of DatasetRelease objects

Query Parameters:

  • dag_id – the dag_id to fetch release info for

  • dataset_id – the dataset_id to fetch release info for

Status Codes: