[BETA] Datasets API updated to Data Frames API
The v2-beta Datasets API is being updated to the Data Frames API. This update includes changes to Datasets API endpoints, as well as field changes for the related Analyses API. These changes will be rolled out on January 22nd 2024.
What’s changing?
As Benchling continues to improve and expand the Insights product, the existing v2-beta APIs must be updated to reflect the changes to the underlying functionality. To that effect, the existing v2-beta Datasets API is being renamed to the Data Frames API to better reflect the underlying data model and reserve the “Dataset” terminology for future updates.
These changes involve a one-to-one update to existing endpoints, as well as some field changes in related APIs, in order to ensure consistent use of “Data Frames.” The following is a complete list of the endpoint(s) and fields being updated:
| Endpoint | Changes |
|---|---|
POST /datasets | Updated to POST /data-frames |
PATCH /datasets/<id> | Updated to PATCH /data-frames/<id> |
GET /datasets/<id> | Updated to GET /data-frames/<id> |
GET /analyses/<id> | datasetsIds field renamed to dataFramesIds |
PATCH /analyses/<id> | datasetsIds field renamed to dataFramesIds |
When is this happening?
These changes will be rolled out on January 22nd, 2024. If you have any apps or integrations that leverage the Datasets API or Analyses API, please ensure they are updated to reflect these changes before this date.