DELETE institution environments - ocariot/api-gateway GitHub Wiki

Description

Deletes all environment measurement data associated with an Institution.

Permissions:

• An Application can delete all Environments of an Institution.

Scope

environment:delete

URL

DELETE https://localhost/v1/institutions/{institution_id}/environments

Parameters

institution_id: string (A 24-byte hex ID)

Curl example

curl -X DELETE "https://localhost/v1/institutions/5a62be07de34500146d9c624/environments" -H "accept: /" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 204 Operation performed successfully. There is no data to be returned.

• 400 Validation errors

  • Invalid institution id
  • Institution does not exist

• 401 Unauthorized Error

• 403 Permission Error

• 429 Too Many Requests Error

• 500 Internal Server Error