Batch update TestDefinition

Beta

PATCH

https://{tenant_name}.benchling.com/api/v3/test-definition:batch-update

PATCH

/api/v3/test-definition:batch-update

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/test-definition:batch-update \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "id": "tdef_J8mQ2xY7",
      "archived": false,
      "description": "Updated set of blood chemistry measurements collected for study samples.",
      "name": "Updated Blood Chemistry Panel",
      "organizationId": "org_v7Q9m2Kx",
      "resultSchemaId": "assaysch_Z3xY7vQb"
    }
  ]
}'

{
  "items": [
    {
      "__typename": "__typename",
      "archiveReason": "archiveReason",
      "archived": true,
      "createdAt": "createdAt",
      "description": "description",
      "id": "id",
      "modifiedAt": "modifiedAt",
      "name": "name"
    }
  ]
}

Batch update Test Definitions synchronously in one transaction. Maximum 25 items per request.

Each item follows the same field requirements and archive constraints as the single-update endpoint. If any item fails validation, the transaction fails and no Test Definitions are updated.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

itemslist of objectsRequired

Response

itemslist of objects

Errors

400

Test Definition Batch Update Request Bad Request Error

403

Test Definition Batch Update Request Forbidden Error

404

Test Definition Batch Update Request Not Found Error

409

Test Definition Batch Update Request Conflict Error

429

Test Definition Batch Update Request Too Many Requests Error

500

Test Definition Batch Update Request Internal Server Error

Authentication

Headers

Request

Response

Errors