Benchling · Schema

CustomEntity

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

Properties

Name Type Description
aliases array
apiURL string The canonical url of the Custom Entity in the API.
archiveRecord object
authors array
createdAt string
creator object
customFields object
entityRegistryId string
fields object
folderId string
id string
modifiedAt string
name string
registrationOrigin object
registryId string
schema object
url string The path of the web URL, omitting the tenant domain
webURL string
View JSON Schema on GitHub

JSON Schema

CustomEntity.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/benchling/json-schema/CustomEntity.json",
  "title": "CustomEntity",
  "properties": {
    "aliases": {
      "items": {
        "example": "sBN000",
        "type": "string"
      },
      "type": "array"
    },
    "apiURL": {
      "description": "The canonical url of the Custom Entity in the API.",
      "example": "https://benchling.com/api/v2/custom-entities/bfi_xCUXNVyG",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "archiveRecord": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArchiveRecord"
        }
      ],
      "nullable": true
    },
    "authors": {
      "items": {
        "$ref": "#/components/schemas/UserSummary"
      },
      "type": "array"
    },
    "createdAt": {
      "example": "2017-04-18T05:54:56.247545+00:00",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserSummary"
        },
        {
          "readOnly": true
        }
      ]
    },
    "customFields": {
      "$ref": "#/components/schemas/CustomFields"
    },
    "entityRegistryId": {
      "example": "sBN000",
      "nullable": true,
      "type": "string"
    },
    "fields": {
      "$ref": "#/components/schemas/Fields"
    },
    "folderId": {
      "example": "lib_R8KcsjhW",
      "nullable": true,
      "type": "string"
    },
    "id": {
      "example": "bfi_xCUXNVyG",
      "type": "string"
    },
    "modifiedAt": {
      "example": "2017-04-18T05:55:48.685345+00:00",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "example": "sBN000",
      "type": "string"
    },
    "registrationOrigin": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RegistrationOrigin"
        }
      ],
      "nullable": true,
      "readOnly": true
    },
    "registryId": {
      "example": "src_NetYd96a",
      "nullable": true,
      "type": "string"
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SchemaSummary"
        }
      ],
      "example": {
        "id": "ts_EM122lfJ",
        "name": "Strain"
      },
      "nullable": true
    },
    "url": {
      "description": "The path of the web URL, omitting the tenant domain",
      "type": "string"
    },
    "webURL": {
      "example": "https://benchling.com/benchling/f/R8KcsjhW-academic-registry/bfi-xCUXNVyG-sbn000/edit",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}