CustomEntity

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/benchling/main/json-schema/benchling-custom-entity-schema.json",
  "title": "CustomEntity",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/benchling-custom-entities-api-openapi.yml#/components/schemas/CustomEntity",
  "properties": {
    "aliases": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "apiURL": {
      "description": "The canonical url of the Custom Entity in the API.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "archiveRecord": {
      "allOf": [
        {
          "$ref": "#/$defs/ArchiveRecord"
        }
      ]
    },
    "authors": {
      "items": {
        "$ref": "#/$defs/UserSummary"
      },
      "type": "array"
    },
    "createdAt": {
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creator": {
      "allOf": [
        {
          "$ref": "#/$defs/UserSummary"
        },
        {
          "readOnly": true
        }
      ]
    },
    "customFields": {
      "$ref": "#/$defs/CustomFields"
    },
    "entityRegistryId": {
      "type": [
        "string",
        "null"
      ]
    },
    "fields": {
      "$ref": "#/$defs/Fields"
    },
    "folderId": {
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "registrationOrigin": {
      "allOf": [
        {
          "$ref": "#/$defs/RegistrationOrigin"
        }
      ],
      "readOnly": true
    },
    "registryId": {
      "type": [
        "string",
        "null"
      ]
    },
    "schema": {
      "allOf": [
        {
          "$ref": "#/$defs/SchemaSummary"
        }
      ]
    },
    "url": {
      "description": "The path of the web URL, omitting the tenant domain",
      "type": "string"
    },
    "webURL": {
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "ArchiveRecord": {
      "properties": {
        "reason": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "CustomField": {
      "properties": {
        "value": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "CustomFields": {
      "additionalProperties": {
        "$ref": "#/$defs/CustomField"
      },
      "type": "object"
    },
    "Field": {
      "properties": {
        "displayValue": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "isMulti": {
          "readOnly": true,
          "type": "boolean"
        },
        "textValue": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "allOf": [
            {
              "$ref": "#/$defs/FieldType"
            }
          ],
          "readOnly": true
        },
        "value": {
          "description": "For single link fields, use the id of the item you want to link (eg. \"seq_jdf8BV24\").\nFor multi-link fields, use an array of ids of the items you want to link (eg. [\"seq_jdf8BV24\"])\n",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "type": "boolean"
            },
            {
              "type": "number"
            },
            {
              "type": "object"
            },
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          ]
        }
      },
      "required": [
        "value"
      ],
      "type": "object"
    },
    "FieldType": {
      "enum": [
        "dna_sequence_link",
        "aa_sequence_link",
        "custom_entity_link",
        "entity_link",
        "mixture_link",
        "molecule_link",
        "dropdown",
        "part_link",
        "translation_link",
        "aa_part_link",
        "base_molecule_link",
        "blob_link",
        "text",
        "long_text",
        "batch_link",
        "storage_link",
        "entry_link",
        "assay_request_link",
        "assay_result_link",
        "assay_run_link",
        "boolean",
        "float",
        "integer",
        "datetime",
        "date",
        "json"
      ],
      "type": "string"
    },
    "Fields": {
      "additionalProperties": {
        "$ref": "#/$defs/Field"
      },
      "type": "object"
    },
    "PartySummary": {
      "properties": {
        "handle": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "RegistrationOrigin": {
      "properties": {
        "originEntryId": {
          "readOnly": true,
          "type": [
            "string",
            "null"
          ]
        },
        "registeredAt": {
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "SchemaSummary": {
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "UserSummary": {
      "allOf": [
        {
          "$ref": "#/$defs/PartySummary"
        },
        {}
      ]
    }
  }
}