Skip to main content

Create Test Sample (v1)

Method & Path

POST /api/v1/workspace/:workspaceId/labs/test-samples

Actual backend path: /v1/workspace/:workspaceId/labs/test-samples

Description

Create a new test sample in the workspace.

Authentication

Required: JWT token in Authorization header

Required Permissions:

  • labs.manage

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesBearer token: Bearer <token>
Content-TypestringYesapplication/json

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstringYesWorkspace identifier (MongoDB ObjectId)

Request Body

{
"sampleTypeTitle": "Blood"
}
FieldTypeRequiredDescription
sampleTypeTitlestringYesTest sample title (1-500 characters)

Response 201 Created

{
"testSample": {
"id": "507f1f77bcf86cd799439011",
"workspaceId": "507f1f77bcf86cd799439012",
"sampleTypeTitle": "Blood",
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-15T10:00:00.000Z",
"deletedAt": null
}
}

Common Errors

400 Bad Request: Invalid request body or missing required fields

401 Unauthorized: Missing or invalid authentication token

403 Forbidden: Insufficient permissions (labs.manage required)

404 Not Found: Workspace not found

409 Conflict: Test sample with the same title already exists

422 Validation Error: Invalid workspace ID format or validation errors