Batch create StudySchema

POST

https://{tenant_name}.benchling.com/api/v3/study-schema:batch-create

POST

/api/v3/study-schema:batch-create

curl -X POST https://{tenant_name}.benchling.com/api/v3/study-schema:batch-create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "items": [
    {
      "description": "Schema for phase II clinical trials.",
      "idGenerationMode": "AUTO_GENERATED_FROM_PREFIX",
      "organizationId": "ent_a0SApq3z",
      "studyType": "CLINICAL",
      "entryTemplateIds": [
        "tmpl_kT6BHBdZ"
      ],
      "fieldDefinitions": [
        {
          "type": "TEXT",
          "isRequired": true,
          "name": "name",
          "systemName": "systemName"
        },
        {
          "type": "INTEGER",
          "isRequired": true,
          "name": "name",
          "systemName": "systemName"
        },
        {
          "type": "BOOLEAN",
          "isRequired": true,
          "name": "name",
          "systemName": "systemName"
        }
      ],
      "isDesignApprovalRequired": true,
      "name": "Phase II Clinical Study",
      "prefix": "CLIN"
    }
  ]
}'

{
  "items": [
    {
      "__typename": "__typename",
      "archiveReason": "archiveReason",
      "archived": true,
      "createdAt": "createdAt",
      "description": "description",
      "entryTemplates": "entryTemplates",
      "fieldDefinitions": "fieldDefinitions",
      "id": "id",
      "idGenerationMode": "AUTO_GENERATED_FROM_PREFIX",
      "isDesignApprovalRequired": true,
      "modifiedAt": "modifiedAt",
      "name": "name",
      "prefix": "prefix",
      "studyType": "CUSTOM"
    }
  ]
}

Batch create StudySchema synchronously in one transaction. Maximum 25 items per request.

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

Created

itemslist of objects

Errors

400

Study Schema Batch Create Request Bad Request Error

403

Study Schema Batch Create Request Forbidden Error

404

Study Schema Batch Create Request Not Found Error

409

Study Schema Batch Create Request Conflict Error

429

Study Schema Batch Create Request Too Many Requests Error

500

Study Schema Batch Create Request Internal Server Error