Benchling · Schema

EntryCreate

Life SciencesBiotechR&DMolecular BiologyLaboratory Information ManagementElectronic Lab NotebookAssay ManagementInventory ManagementSequence ManagementExperiment WorkflowsRESTWebhooks

Properties

Name Type Description
authorIds object
customFields object Custom fields to add to the entry
entryTemplateId string ID of the template to clone the entry from
fields object Fields to set on the entry. Must correspond with the schema's field definitions.
folderId string ID of the folder that will contain the entry
initialTables array An array of table API IDs and blob id pairs to seed tables from the template while creating the entry. The entryTemplateId parameter must be set to use this parameter. The table API IDs should be the
name string Name of the entry
schemaId string ID of the entry's schema
View JSON Schema on GitHub

JSON Schema

EntryCreate.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/EntryCreate.json",
  "title": "EntryCreate",
  "additionalProperties": false,
  "properties": {
    "authorIds": {
      "oneOf": [
        {
          "deprecated": true,
          "type": "string"
        },
        {
          "description": "IDs of users to set as the entry's authors. Defaults to the creator.\n",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      ]
    },
    "customFields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomFields"
        }
      ],
      "description": "Custom fields to add to the entry"
    },
    "entryTemplateId": {
      "description": "ID of the template to clone the entry from",
      "type": "string"
    },
    "fields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Fields"
        }
      ],
      "description": "Fields to set on the entry. Must correspond with the schema's field definitions.\n"
    },
    "folderId": {
      "description": "ID of the folder that will contain the entry",
      "type": "string"
    },
    "initialTables": {
      "description": "An array of table API IDs and blob id pairs to seed tables from the template while creating the entry. The entryTemplateId parameter must be set to use this parameter. The table API IDs should be the API Identifiers of the tables in the given template.\n- If a template table has one row, the values in that row act as default values for cloned entries.\n- If a template table has multiple rows, there is no default value and those rows are added to the cloned entry along with the provided csv data.\n- If a table has default values, they will be populated in any respective undefined columns in the csv data.\n- If a table has no default values, undefined columns from csv data will be empty.\n- If no csv data is provided for a table, the table in the entry will be populated with whatever values are in the respective template table.\n",
      "items": {
        "$ref": "#/components/schemas/InitialTable"
      },
      "type": "array"
    },
    "name": {
      "description": "Name of the entry",
      "type": "string"
    },
    "schemaId": {
      "description": "ID of the entry's schema",
      "type": "string"
    }
  },
  "required": [
    "name",
    "folderId"
  ],
  "type": "object"
}