Observation Instance – Django REST framework

Get a list of Observation objects.

### Available end points:

- `/observations/` - Will list all Results in the database
- `/observations.json` - Will return all Results in json format. This can
also be achieved by using the accept header. `application/json`
- `/observations/<object_id>/` - Returns Results object with that id

### Available Methods:

- `GET`
- `HEAD`

### Available filters:

- `title`
- `uuid`
- `keywords`
- `status`
- `result_field`
- `discoveryKeywords`
- `updateFrequency`
- `nonGeographicFlag`
- `publicationState`
- `permissions`

### How to use filters:

These filters can be used like django query filters using __ for related model relationships.

- `/observations/?uuid=d594d53df2612bbd89c2e0e770b5c1a0`
- `/observations/?status=completed`
- `/observations/?results_field__dataPath__startswith=/neodc/esacci`
- `/observations/?discoveryKeywords__name=ESACCI`
- `/observations/?nonGeographicFlag=True`

Filters can be stacked to build an 'AND' relationship. E.g.

- `/observations/?publicationState__in=published,citable&nonGeographicFlag=True`
- `/observations/?publicationState__in=published,citable&discoveryKeyword__name=NDGO0003`

GET /api/v2/observations/41275/?format=api

HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "ob_id": 41275,
    "uuid": "9536459d09fb446d8daee987a039616e",
    "title": "Control run of a 1/12° regional simulation of MITgcm in the North Atlantic Ocean (repeated year forcing from JRA55-do, May 2003-May 2004).",
    "abstract": "This dataset represents a high-resolution (1/12° in the horizontal) regional ocean simulation of the North Atlantic, designed to serve as a control run for further sensitivity tests exploring how various changes in surface and lateral boundary conditions impact the ocean circulation in the region. The MITgcm (Massachusetts Institute of Technology General Circulation Model) ocean general circulation model was used, forced by repeated year forcing conditions from JRA55-do, corresponding to 1 May 2003 to 1 May 2004, and lateral boundary conditions from Arctic STate Estimate (ASTE) dataset (Nguyen et al., 2021). This dataset contains information from 15 years of experiments, and does not include 50 years of model spinup. Full 3D U/V/T/S fields and 2D fields containing information about mixed layer depth, sea ice, sea surface height, heat and freshwater surface fluxes are provided every 5 days. The outputs were generated by the University of Oxford under the Natural Environment Research Council (NERC) project SNAP-DRAGON: Subpolar North Atlantic Processes - Dynamics and pRedictability of vAriability in Gyre and OverturNing (grant reference NE/T013494/1).",
    "keywords": "",
    "publicationState": "citable",
    "dataPublishedTime": "2024-01-12T14:09:04",
    "doiPublishedTime": "2024-01-12T14:09:04",
    "updateFrequency": "",
    "status": "final",
    "result_field": {
        "ob_id": "https://api.catalogue.ceda.ac.uk/api/v2/observations/41274/?format=api",
        "dataPath": "/bodc/UOX230197",
        "oldDataPath": [],
        "storageLocation": "internal",
        "storageStatus": "online",
        "volume": 619843193911,
        "numberOfFiles": 77,
        "fileFormat": "NetCDF and text"
    },
    "timePeriod": "https://api.catalogue.ceda.ac.uk/api/v2/times/11460/?format=api",
    "geographicExtent": "https://api.catalogue.ceda.ac.uk/api/v2/bboxes/4079/?format=api",
    "nonGeographicFlag": false,
    "phenomena": [
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/13238/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/17495/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/17496/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/18405/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/18408/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75320/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75321/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75322/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75323/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75324/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75325/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75326/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75327/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75328/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75329/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75330/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75331/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75332/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75333/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75334/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/phenomona/75335/?format=api"
    ],
    "dataLineage": "The data are archived on the British Oceanographic Data Centre (BODC)'s space at the Centre for Environmental Data Analysis (CEDA) and assigned a DOI. No quality control procedures were applied by BODC.",
    "removedDataTime": null,
    "removedDataReason": "",
    "language": "English",
    "identifier_set": [
        "https://api.catalogue.ceda.ac.uk/api/v2/identifiers/12801/?format=api"
    ],
    "projects": [],
    "observationcollection_set": [],
    "responsiblepartyinfo_set": [
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200965/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200963/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200962/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200961/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200967/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200968/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200969/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200966/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200964/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200970/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200971/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/200972/?format=api"
    ],
    "procedureAcquisition": null,
    "procedureCompositeProcess": null,
    "procedureComputation": null,
    "permissions": [
        {
            "ob_id": "https://api.catalogue.ceda.ac.uk/api/v2/observations/2526/?format=api",
            "useLimitation": null,
            "accessConstraints": null,
            "accessCategory": "public",
            "accessRoles": null,
            "label": "public: None group",
            "licenceURL": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
            "licenceClassifications": "any"
        }
    ],
    "discoveryKeywords": []
}