Standardizing filters on List Assay Results Endpoint
Non-standard filter parameters (i.e. minCreatedAt
and maxCreatedAt
) are being marked DEPRECATED in favor of createdAt
for the List Assay Results endpoint
What’s changing?
We’re fixing the filter parameters for the List Assay Results endpoint to accept the documented format, and to inline with the standard filter parameters used across the Benchling API. Previously, filtering the results from this endpoint required using the minCreatedAt
and maxCreatedAt
parameters. Despite the fact that these were documented as accepting RFC 3339 timestamps, in reality the parameters only accept Unix timestamps.
Going forward, we’re correcting the documentation for the minCreatedAt
and maxCreatedAt
parameters to indicate they accept Unix timestamps. As part of this fix, we also added a new createdAt
parameter that accepts the RFC 3339 format. createdAt
additionally accepts operators using dot format (e.g. createdAt.gt
), making the List Assay Results endpoint consistent with other listing endpoints. As a result, we have marked the minCreatedAt
and maxCreateAt
parameters as DEPRECATED in favor of the standard createdAt
parameter. Both minCreatedAt
and maxCreatedAt
will continue to be supported until a future sunset date.
For more information on using the createdAt
filter parameter and operators, check out the Benchling API Reference.
When is this happening?
This change is now live! Assay Results filter parameters are now correctly documented, and the endpoint supports the createdAt
parameter.