Update CustomEntity

PATCH

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

PATCH

/api/v3/custom-entity/:custom_entity_id

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

{
  "__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"
  }
}

Update CustomEntity.

Authentication

AuthorizationBearer

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

Path parameters

custom_entity_idstringRequired

ID of the CustomEntity.

Request

This endpoint expects an object.

aliaseslist of stringsOptional

allowCustomFieldDeletionbooleanOptional

When true, custom fields present on the entity but omitted from the update payload will be deleted. When false or omitted, omitting existing custom fields is an error. Defaults to false.

archiveReasonstringOptional

archivedbooleanOptional

If the CustomEntity is archived

authorIdslist of stringsOptional

customFieldsmap from strings to objectsOptional

entityRegistryIdstringOptional

Registry ID to assign to the entity. When registering, specifying this value sets the registry ID of the entity. When already registered, specifying this value updates the entity’s registry ID. If set, naming_strategy must be unspecified.

folderIdstringOptional

namestringOptional

Name of the item.

namingStrategyenumOptional

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

registryIdstring or nullOptional

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

schemaFieldsmap from strings to objectsOptional

schemaIdstringOptional

Response

__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 Update Request Bad Request Error

403

Custom Entity Update Request Forbidden Error

404

Custom Entity Update Request Not Found Error

409

Custom Entity Update Request Conflict Error

429

Custom Entity Update Request Too Many Requests Error

500

Custom Entity Update Request Internal Server Error