☰API Calls
The NZGD External API is a restful API with different endpoints which return JSON metadata about investigations, monitoring installations, and tests directly from the NZGD. If you aren't able to see a list of APIs on this page, please sign in or sign up if you haven't created an account yet.
Request Overview
Data resources are accessed via standard HTTP requests in UTF-8 format to an API endpoint. The Web API uses the following HTTP verbs:
Method
Action
GET
The available GET APIs allow users to retrieve detailed information about investigations, including related test results, monitoring installations, and metadata about linked files, with the ability to download specific files and count the number of files linked to various test results and installations.
POST
The available POST APIs allow users to create new investigations, upload and link files to investigations, manage investigations through various workflow actions (e.g., move to draft, publish, remove, submit), retrieve SAS tokens for file uploads, and publish files for specific test results and monitoring installations, including inserting file information into the respective tables.
PATCH
The available PATCH API allows users to update an existing investigation using the NZGD ID, including related information like sample test results and monitoring installations, without including files in the payload.