BEbenchling
Entry

Update Entry

Update Entry.

patch/api/v3/entry/{entry_id}

Request

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

Path parameters

entry_idstring required

ID of the Entry.

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

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.

authorIdsstring[]

Specifies user or app IDs to set as entry authors. Omit to leave authors unchanged. Provide IDs to replace the current author list. Pass an empty array to clear all authors.

namestring

Specifies the entry title. Omit to leave the title unchanged.

schemaFieldsobject

Specifies values for fields defined by the entry schema. Keys must be field API identifiers. Values must be API identifiers or JSON values matching the field type. Exceptions are assay run and assay result link fields, which must be warehouse UUIDs. Permitted only when the entry has a schema associated with it, or schemaId is supplied in the same request. Omit to leave schema field values unchanged.

schemaIdstring nullable

Specifies the ID of the entry schema to assign when the entry has no schema. Omit to leave the schema unchanged. Reassigning the schema is not supported. The schema ID can be retrieved from the entry schema listing resource.

sectionUuidstring uuid

Deprecated. Use partsMutation instead. Do not use for new integrations. Specifies the UUID of the section where legacy content is inserted when using the content field. Content is appended at the end of that section. Omit to append at the end of the document.

Response

OK

__typenamestring
applicableReviewProcessesstring uri

Lists review processes configured for the entry's project. Use the paginated list of applicable review processes for the full list including stages and version details.

archiveReasonstring nullable

Specifies the archive reason when the entry is archived.

archivedboolean

Specifies whether the entry is archived.

createdAtstring datetime nullable

Specifies when the entry was created.

displayIdstring nullable

Specifies the display ID for the entry.

idstring

Identifies the entry.

modifiedAtstring datetime nullable

Specifies when the entry was last modified.

namestring nullable

Specifies the title of the entry.

webUrlstring

Specifies the absolute URL of the entry in the Benchling web app.

authorsstring uri nullable

Lists the authors of the entry. Defaults to the creator but may be edited.

partsstring uri

Lists ordered document parts that make up the document content.

Changes

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