Sign in

v1

latestSwagger 2.0Apache 2.02026-07-1731732.7 KB
Catalog administration
Studies

Get a single study

Retrieve a single study by ID

get/studies/{studyId}

Path parameters

studyIdinteger required

Study ID

Headers

api_keystring

Response

successful operation

idinteger
project_type'survey' | 'geospatial'
titlestring
descriptionstring
shortnamestring
collaboratorsstring[]
status'draft' | 'submitted' | 'processed' | 'closed' | 'cancelled' | 'published'

Project status codes

  • draft - Draft mode
  • submitted - Project is submitted and locked for user to make any further changes
  • processed - Project accepted and is being processed
  • closed - Processing completed and project is completed
  • published - Project published to one or more catalogs
  • cancelled - Project was cancelled
createdstring date-time
changedstring date-time

Example response

{
  "collaborators": [
    "user@example.com",
    "user2@example.com"
  ]
}