Updated Analysis, Datasets, and Files APIs
Changes to the v2-beta Analyses, and Files APIs are being rolled out on December 4th 2023. Expand for more details. UPDATE these changes no longer impact the /datasets APIs. /datasets APIs will be updated in the future, to be announced at a later date.
What’s changing?
New features and functionality are being added to the Insights Analyses product to improve the ways Benchling users can manipulate and analyze their scientific data. Given the improvements to the way both Datasets and Analyses function in Benchling, a number of changes are being made to the corresponding APIs. Specifically:
- Analyses are being simplified by removing the concept of an “analysis step”
- This means the
analysis-stepsAPI endpoints will be deprecated and replaced with correspondinganalysisAPI endpoints
- This means the
- Datasets and Files are being promoted to first-class Benchling objects, and will be available in search
- This means that the Files API endpoints (and eventually, the Datasets API) will include a new required parameter,
folderId
- This means that the Files API endpoints (and eventually, the Datasets API) will include a new required parameter,
A complete list of API endpoints that are affected, along with specific changes, can be found below:
| Endpoint | Changes |
|---|---|
| `POST /files` | * `folderId` is now a required parameter. |
| `GET /files/{file_id}` | * `folderId` field now included in response |
| `GET /analysis-steps/{step_id}` | * Deprecated; replaced by `GET /analysis/{analysis_id}` |
| `PATCH /analysis-steps/{step_id}` | * Deprecated; replaced by `PATCH /analysis/{analysis_id}` |
| `GET /analysis/{analysis_id}` | * Added; replaces `GET /analysis-steps/{step_id}` |
| `PATCH /analysis-steps/{step_id}` | * Added; replaces `PATCH /analysis-steps/{step_id}` * Now *appends* (instead of replaces) datasets/files * No longer supports removing datasets and files. |
What about the Datasets API?
A previous version of this changelog entry listed the
POST /datasetsandGET /datasets/{dataset_id}endpoints as affected. This is no longer the case; these specific endpoints will not be impacted by the changes being implemented on December 4th. Datasets promotion to first-class objects in Benchling will impact the/datasetsAPI at a later date, at which point a separate announcement will be made.
When is this happening?
These changes will go live on December 4th 2023. Please review and update any apps/integrations that interact with the affected APIs before this date, and contact Benchling Support via email or in-app chat with any concerns.