Benchling · Schema

CustomEntityBaseRequest

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

Properties

Name	Type	Description
aliases	array	Aliases to add to the custom entity
authorIds	array	IDs of users to set as the custom entity's authors.
customFields	object	Custom fields to add to the custom entity. Every field should have its name as a key, mapping to an object with information about the value of the field.
fields	object	Schema fields to set on the custom entity. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the
folderId	string	ID of the folder that the entity is moved into
name	string
schemaId	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/CustomEntityBaseRequest.json",
  "title": "CustomEntityBaseRequest",
  "properties": {
    "aliases": {
      "description": "Aliases to add to the custom entity",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "authorIds": {
      "description": "IDs of users to set as the custom entity's authors.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "customFields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomFields"
        }
      ],
      "description": "Custom fields to add to the custom entity. Every field should have its name as a key, mapping to an object with information about the value of the field.\n"
    },
    "fields": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Fields"
        }
      ],
      "description": "Schema fields to set on the custom entity. Must correspond with the schema's field definitions. Every field should have its name as a key, mapping to an object with information about the value of the field.\n"
    },
    "folderId": {
      "description": "ID of the folder that the entity is moved into",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "schemaId": {
      "type": "string"
    }
  },
  "type": "object"
}