Create CustomEntity

POST

https://{tenant_name}.benchling.com/api/v3/custom-entity

POST

/api/v3/custom-entity

curl -X POST https://{tenant_name}.benchling.com/api/v3/custom-entity \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "folderId": "folderId",
  "name": "name",
  "schemaId": "schemaId"
}'

{
  "__typename": "__typename",
  "authors": "authors",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "aliases": [
    "aliases"
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "customFields": [
    {
      "__typename": "__typename",
      "name": "name",
      "value": "value"
    }
  ],
  "entityRegistryId": "entityRegistryId",
  "folder": {
    "__typename": "__typename",
    "id": "id"
  },
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "registrationOrigin": {
    "__typename": "__typename",
    "originEntry": {
      "__typename": "__typename",
      "id": "id"
    },
    "registeredAt": "registeredAt"
  },
  "registry": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "typedSchema": {
    "__typename": "__typename",
    "id": "id"
  }
}

Create CustomEntity.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

folderIdstringRequired

namestringRequired

Name of the item.

schemaIdstringRequired

aliaseslist of stringsOptional

authorIdslist of stringsOptional

customFieldsmap from strings to objectsOptional

entityRegistryIdstringOptional

Registry ID to assign to the entity. If one is specified, the labeling_strategy must be unspecified.

namingStrategyenumOptional

Strategy to use for labeling the item in the registry. If one is specified, the entity_registry_id must be unspecified.

registryIdstring or nullOptional

A not null value means the entity should be registered. If not null, the value must match the registry of the item's schema.

schemaFieldsmap from strings to objectsOptional

Response

Created

__typenamestringOptional

authorsstring or nullOptionalformat: "uri"

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

aliaseslist of strings or nullOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

createdAtstring or nullOptional

customFieldslist of objects or nullOptional

entityRegistryIdstring or nullOptional

The registry-assigned identifier for this item (e.g. its registry ID shown in the UI), present only once the item has been registered. Null if the item is not registered.

folderobject or nullOptional

idstringOptional

modifiedAtstring or nullOptional

namestring or nullOptional

Name of the item.

projectobject or nullOptional

registrationOriginobject or nullOptional

Provenance of this item’s registration — where and when it was registered. Null if unregistered.

registryobject or nullOptional

The Registry this item belongs to, if registered. Null if unregistered.

schemaobject or nullOptional

Use typedSchema instead, which returns the per-type schema.

typedSchemaobject or nullOptional

Errors

400

Custom Entity Create Request Bad Request Error

403

Custom Entity Create Request Forbidden Error

404

Custom Entity Create Request Not Found Error

409

Custom Entity Create Request Conflict Error

429

Custom Entity Create Request Too Many Requests Error

500

Custom Entity Create Request Internal Server Error