Result Schema

Get ResultSchema by ID

Get a single ResultSchema by ID.

get/api/v3/result-schema/{result_schema_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

result_schema_idstring required

ID of the ResultSchema.

Query parameters

returningstring[]

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitstring[]

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
createdAtstring datetime nullable
fieldDefinitionsstring uri

Defines the metadata fields for results belonging to this schema

idstring
modifiedAtstring datetime nullable

DateTime the Result Schema was last modified

namestring
systemNamestring

The unique, machine-readable identifier for warehouse and API access.

Changes

No recorded changes to this operation across all 1 revision of this API.