Create Entry

Beta

POST

https://{tenant_name}.benchling.com/api/v3/entry

POST

/api/v3/entry

curl -X POST https://{tenant_name}.benchling.com/api/v3/entry \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "folderId": "lib_abc123",
  "name": "Protein Concentration Assay 2025-01-15",
  "parts": [
    {
      "contentType": "section",
      "date": "2025-01-15"
    },
    {
      "contentType": "header",
      "text": "Experiment Results",
      "headerType": "HEADER_1"
    },
    {
      "contentType": "text",
      "text": "The following data was collected on 2025-01-15."
    },
    {
      "contentType": "list_item",
      "text": "Sample A: 0.85 mg/mL",
      "listType": "BULLET"
    },
    {
      "contentType": "list_item",
      "text": "Sample B: 1.23 mg/mL",
      "listType": "BULLET"
    },
    {
      "contentType": "unstructured_table",
      "name": "Concentration Measurements",
      "columnDefinitions": [
        {
          "name": "Sample"
        },
        {
          "name": "Concentration (mg/mL)"
        }
      ],
      "rows": [
        {
          "cells": [
            {
              "inputValue": {
                "type": "text_value",
                "value": "Sample A"
              }
            },
            {
              "inputValue": {
                "type": "text_value",
                "value": "0.85"
              }
            }
          ]
        },
        {
          "cells": [
            {
              "inputValue": {
                "type": "text_value",
                "value": "Sample B"
              }
            },
            {
              "inputValue": {
                "type": "text_value",
                "value": "1.23"
              }
            }
          ]
        },
        {
          "cells": [
            {
              "inputValue": {
                "type": "text_value",
                "value": "Sample C"
              }
            },
            {
              "inputValue": {
                "type": "text_value",
                "value": "0.97"
              }
            }
          ]
        }
      ]
    }
  ],
  "schemaFields": {
    "tsf_H9pW2sTc": {
      "value": "sfso_UcQuhAwx"
    },
    "tsf_R3vNx7kL": {
      "value": "1.2 mg/mL"
    }
  },
  "schemaId": "ts_Km4nP8wQ"
}'

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "parts": "parts",
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "applicableReviewProcesses": "applicableReviewProcesses",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "displayId": "displayId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "review": {
    "__typename": "__typename",
    "id": "id"
  },
  "reviewSource": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "sections": [
    {
      "__typename": "__typename",
      "contents": [
        {}
      ],
      "date": "date",
      "provenanceUuid": "provenanceUuid",
      "title": "title"
    }
  ],
  "selectors": [
    {
      "__typename": "__typename",
      "name": "name",
      "options": [
        "options"
      ],
      "selectorId": "selectorId"
    }
  ],
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  },
  "versionMetadata": {
    "__typename": "__typename",
    "createdAt": "createdAt",
    "versionId": "versionId"
  }
}

Create Entry.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

folderIdstringRequired

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.

namestringRequired

Specifies the entry title.

authorIdslist of stringsOptional

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.

partslist of objectsOptional

Specifies the document content parts to create, in order. When provided as an empty array, a blank document is created using the default behavior for its document type.

schemaFieldsmap from strings to objectsOptional

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.

schemaIdstringOptional

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.

studyIdslist of stringsOptional

Specifies study IDs to associate with the new entry. Study IDs can be retrieved from the study listing resource.

Response

Created

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

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

creatorobject or nullOptional

Identifies who created the entry.

partsstringOptionalformat: "uri"

Lists ordered document parts that make up the document content.

schemaFieldslist of objects or nullOptional

Lists values for fields defined by the entry schema.

applicableReviewProcessesstringOptionalformat: "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 or nullOptional

Specifies the archive reason when the entry is archived.

archivedbooleanOptional

Specifies whether the entry is archived.

createdAtstring or nullOptional

Specifies when the entry was created.

customFieldslist of objects or nullOptional

Lists custom field values on the entry.

displayIdstring or nullOptional

Specifies the display ID for the entry.

folderobject or nullOptional

Specifies the folder that contains the entry.

idstringOptional

Identifies the entry.

modifiedAtstring or nullOptional

Specifies when the entry was last modified.

namestring or nullOptional

Specifies the title of the entry.

reviewobject or nullOptional

Specifies the active review for the entry when one exists. Null when the entry has not been sent for review or the review was retracted.

reviewSourceobjectOptional

Specifies the project that owns the entry and determines which review processes apply.

schemaobject or nullOptional

Specifies the entry schema when one is configured.

sectionslist of objects or nullOptional

selectorslist of objectsOptional

Lists dropdown selectors available to table cells in the document.

typedSchemaobject or nullOptional

versionMetadataobjectOptional

Specifies version metadata for the current revision of the entry.

Errors

400

Entry Create Request Bad Request Error

403

Entry Create Request Forbidden Error

404

Entry Create Request Not Found Error

409

Entry Create Request Conflict Error

429

Entry Create Request Too Many Requests Error

500

Entry Create Request Internal Server Error

Authentication

Headers

Request

Response

Errors