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/553/?format=api

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

{
    "ob_id": 553,
    "uuid": "0de850defd351758a933f3214549b8df",
    "title": "Met Office Cyclone database files",
    "abstract": "Data from the Met Office's Cyclone Database, consisting of flat files from the database covering 2000-2005 with associated charts. The database holds lists of cyclones, their types and structural information about each cyclone and associated features as derived from analysis of the UK Met Office Unified Model.",
    "keywords": "cyclone, Met Office",
    "publicationState": "published",
    "dataPublishedTime": "2009-11-11T02:53:01",
    "doiPublishedTime": null,
    "updateFrequency": "notPlanned",
    "status": "completed",
    "result_field": {
        "ob_id": "https://api.catalogue.ceda.ac.uk/api/v2/observations/554/?format=api",
        "dataPath": "/badc/ukmo-cyclones/data/raw/",
        "oldDataPath": [],
        "storageLocation": "internal",
        "storageStatus": "online",
        "volume": 550897202,
        "numberOfFiles": 7,
        "fileFormat": "Data are in a bespoke ASCII format"
    },
    "timePeriod": "https://api.catalogue.ceda.ac.uk/api/v2/times/153/?format=api",
    "geographicExtent": "https://api.catalogue.ceda.ac.uk/api/v2/bboxes/1/?format=api",
    "nonGeographicFlag": false,
    "phenomena": [],
    "dataLineage": "Data consisting of flat files from the database covering 2000-2005, provided by the Met Office for archiving at the BADC.",
    "removedDataTime": null,
    "removedDataReason": "",
    "language": "English",
    "identifier_set": [
        "https://api.catalogue.ceda.ac.uk/api/v2/identifiers/388/?format=api"
    ],
    "projects": [
        "https://api.catalogue.ceda.ac.uk/api/v2/projects/11721/?format=api"
    ],
    "observationcollection_set": [
        "https://api.catalogue.ceda.ac.uk/api/v2/observationcollections/552/?format=api"
    ],
    "responsiblepartyinfo_set": [
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1570/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1575/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1569/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1572/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1573/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1574/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1576/?format=api",
        "https://api.catalogue.ceda.ac.uk/api/v2/rpis/1571/?format=api"
    ],
    "procedureAcquisition": null,
    "procedureCompositeProcess": null,
    "procedureComputation": null,
    "permissions": [
        {
            "ob_id": "https://api.catalogue.ceda.ac.uk/api/v2/observations/2667/?format=api",
            "useLimitation": null,
            "accessConstraints": null,
            "accessCategory": "registered",
            "accessRoles": null,
            "label": "registered: None group",
            "licenceURL": "https://creativecommons.org/licenses/by-nc-sa/4.0/",
            "licenceClassifications": "personal, academic, policy"
        }
    ],
    "discoveryKeywords": [
        {
            "ob_id": 1138,
            "name": "NDGO0003"
        }
    ]
}