BEbenchling
Entry

Create Entry

Create Entry.

post/api/v3/entry

Request

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

Headers

EARLY-ACCESSstring

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

Request body

authorIdsstring[]

Specifies user or app IDs to set as entry authors. Defaults to the creator (the authenticated user or app). Use [] to create an entry with no authors.

folderIdstring required

Specifies the ID of the folder to create the entry in. The folder must grant the caller append permission. The folder ID can be retrieved from the folder listing resource.

namestring required

Specifies the entry title.

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.

schemaIdstring

Specifies the ID of the entry schema to assign. Omit to create an entry without an entry schema. The schema ID can be retrieved from the entry schema listing resource.

studyIdsstring[]

Deprecated: use studyAssociations instead, which also supports auto-linking. Specifies study IDs to associate with the new entry. Study IDs can be retrieved from the study listing resource.

Response

Created

__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.