v8

latestOpenAPI 3.0.2raw.githubusercontent.com2022-09-1612311.4 KB

samples

List sample summaries.

Retrieve a list of all existing SampleSummaries

get/samples/samplesummaries

Response

Sample Summaries were retrieved successfully.

effectiveEndDateTimestring date-time

effectiveStartDateTimestring date-time

errorCode'None' | 'NotCsv' | 'DataError' | 'NotSpecified'

expectedCollectionInstrumentsinteger

idstring uuid

ingestDateTimestring date-time

notesstring

state'ACTIVE' | 'INIT' | 'FAILED'

surveyRefstring

totalSampleUnitsinteger

Example response

[
  {
    "effectiveEndDateTime": "2020-06-08T09:50:25.338Z",
    "effectiveStartDateTime": "2020-06-08T09:50:25.338Z",
    "errorCode": "NotCsv",
    "id": "fd6a1aa3-ba17-43a8-beae-a39e67c6444d",
    "ingestDateTime": "2020-06-08T09:50:25.338Z",
    "notes": "example",
    "state": "ACTIVE",
    "surveyRef": "342",
    "totalSampleUnits": 1
  }
]