BEbenchling
Result Schema

Update ResultSchema

Update ResultSchema.

patch/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.

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

namestring

Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.

systemNamestring

Updated SQL identifier for the warehouse table name. When provided, must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.

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.