NCnceas
Projects

Get all projects

Changed on

Retrieve a paginated collection of all projects recorded in VegBank.

get/projects

Request

Query parameters

searchstring

Search term used for full-text record retrieval

sort'default' | '+default' | '-default' | 'project_name' | '+project_name' | '-project_name' | 'obs_count' | '+obs_count' | '-obs_count'

Sort order for results. Prefix with - for descending order or + for ascending order. Ascending order is the default if no prefix is provided.

Available sort fields:

  • default - Default sort order
  • project_name - Sort by project name
  • obs_count - Sort by observation count

Examples:

  • sort=project_name - Sort by project name ascending
  • sort=-obs_count - Sort by observation count descending
  • sort=+project_name - Sort by project name ascending (explicit)
limitinteger

Maximum number of records to return

offsetinteger

Number of records to skip before starting to return records

create_parquetboolean

If true, return data payload in binary Parquet format

Response

Matching project(s)

pj_codestring

VegBank project identifier

project_namestring

Project name as defined by the principal investigator

project_descriptionstring

Short description of the project including the original purpose for conducting the project

start_datestring date

Project start date

stop_datestring date

Project stop date

obs_countinteger

Number of plot observations associated with this entity

last_plot_added_datestring date

Date a plot observation was last added to this project

Example response

{
  "pj_code": "pj.1",
  "project_name": "Pawnee Grassland Classification",
  "project_description": "Classification of the Pawnee National Grassland",
  "start_date": "2006-05-30",
  "stop_date": "2006-05-30",
  "obs_count": 17,
  "last_plot_added_date": "2006-05-30"
}

Changes

  • 2e123831df6eRevision changes
    • breaking

      for the query request parameter limit, default value 1000 was added

    • breaking

      for the query request parameter offset, default value 0 was added

    • breaking

      the response's body type changed from object to no type for status

    • warning

      for the query request parameter limit, the min was set to 0.00

    • warning

      for the query request parameter offset, the min was set to 0.00

    • warning

      deleted the query request parameter accession_code

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id get-pj was added

    • info

      api tag Projects added

    • info

      added the new optional query request parameter create_parquet

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter sort

    • info

      added to the response body allOf list for the response status

    • info

      added the media type application/vnd.apache.parquet for the response with the status

    • info

      added the non-success response with the status

  • d84030d3fe20Revision changes
    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset