Create Sample

POST

/projects/{projectId}/samples

Authorizations

• bearer

Parameters

Path Parameters

projectId

required

string

Project UUID

Request Body ^required

object

quantity

Quantity

number

Example

2

replicates

Replicates

string

Allowed values: available not collected

Example

available

unit

Unit

string

Example

ml

photos

File path

Array<string>

Example

[
  "https://<s3>/<bucket>/<filepath>"
]

barcode

required

Barcode

string

Example

G-2407-E-L-11-09

originalSampleBarcode

Barcode of original sample if exist

string

Example

G-2407-E-L-11-09

site

required

Site UUID

object

Example

Site id

team

required

Team UUID

object

Example

Team id

diseases

required

Disease ID array

Array<object>

object

Example

[
  "diseaseId1",
  "diseaseId2"
]

testDate

When the sample is tested

string format: date-time

Example

2025-03-21T10:00:00Z

collectedBy

Who collected the sample

object

Example

User id

receivedBy

Who received the sample

object

Example

User id

extractedBy

Who extracted the sample

object

Example

User id

testedBy

Who tested the sample

object

Example

User id

reportGeneratedBy

Who generated the sample report

object

Example

User id

latitude

Latitude

number

Example

40.2331

longitude

Longitude

number

Example

-70.4453

sampleStatus

Sample status enum [picked-up, received, extracted, tested, rejected, test-report-generated]

string

Allowed values: pending picked-up received pre-processed virus-isolation extracted tested rejected test-report-generated

Example

tested

comment

Comments

string

Example

Anything regarding sample

visit

required

Visit UUID

object

Example

Visit id

sampleType

required

Sample type UUID

object

Example

Sample type UUID

species

Species UUID

object

Example

Species UUID

rejectReason

Reason for rejection

string

nullable

Example

Sample contaminated

receivedAt

Timestamp when the sample was received

string format: date-time

nullable

Example

2025-03-21T10:00:00Z

receivedVolumeValue

Received volume value

string

nullable

Example

5

receivedVolumeUnit

Received volume unit

string

nullable

Example

ml

receivedLabStorageDetails

Received lab storage details

string

nullable

Example

Stored in freezer -20°C

referenceBatchId

Reference batch ID

string

nullable

Example

BATCH-2025-001

batchReferenceDocument

Batch reference document (URL or filename)

string

nullable

Example

doc-url

accessionId

Accession ID

string

nullable

Example

ACC-2025-001

extractionDateTime

Timestamp when extraction was performed

string format: date-time

nullable

Example

2025-03-21T12:30:00Z

extractionSampleUsedValue

Sample used value for extraction

string

nullable

Example

3

extractionSampleUsedUnit

Sample used unit for extraction

string

nullable

Example

ml

extractionSampleRemainingValue

Remaining sample value after extraction

string

nullable

Example

2

extractionSampleRemainingUnit

Remaining sample unit after extraction

string

nullable

Example

ml

extractionComments

Comments related to the extraction process

string

nullable

Example

Sample extracted successfully

preprocessingSteps

Pre-processing steps data

Array<object>

object

preprocessingDate

Pre-processing date

string format: date-time

nullable

preprocessingStorageTemperature

Pre-processing storage temperature

string

nullable

preprocessingStorageDetails

Pre-processing storage details

string

nullable

preprocessingPerformedBy

User who performed pre-processing

object

pooledSampleIds

IDs of samples pooled with this sample

Array<string>

pooledWith

Samples pooled with this sample (resolved entities)

Array<object>

object

isPooledSample

Whether this is a pooled sample

boolean

details

Additional dynamic details (e.g. extraction metadata)

object

Responses

201

object

success

required

boolean

message

required

string

data

required

object

replicates

string

Allowed values: available not collected

sampleStatus

required

string

Allowed values: pending picked-up received pre-processed virus-isolation extracted tested rejected test-report-generated

barcode

required

string

id

required

string

sampleCode

string

nullable

collectedAt

required

string format: date-time

quantity

number

nullable

unit

string

nullable

habitat

string

nullable

conc

string

nullable

collectionTime

required

string format: date-time

photos

required

Array<string>

comment

string

nullable

rejectReason

string

nullable

receivedAt

string format: date-time

nullable

receivedVolumeValue

string

nullable

receivedVolumeUnit

string

nullable

receivedLabStorageDetails

string

nullable

extractionDateTime

string format: date-time

nullable

extractionSampleUsedValue

string

nullable

extractionSampleUsedUnit

string

nullable

extractionSampleRemainingValue

string

nullable

extractionSampleRemainingUnit

string

nullable

extractionComments

string

nullable

receivedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

extractedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

collectedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

reportGeneratedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

project

object

id

required

string

name

required

string

code

required

string

site

object

collectionDayOfWeek

Array<string>

nullable

Allowed values: Sunday Monday Tuesday Wednesday Thursday Friday Saturday

collectionStartDate

The date when collection visits should start

string format: date-time

nullable

Example

2026-01-16

farmType

Type of farm/site based on the disease (e.g. Poultry Farm, Wetland, Cattle Farm)

string

nullable

Example

poultry_farm

siteSubType

Sub-type of the farm/site (e.g. Broiler, Breeder, Layer, Backyard)

string

nullable

Example

broiler

siteType

string

Allowed values: private government corporate

id

required

string

name

required

string

siteCode

string

nullable

collectionConsent

string

nullable

collectionFrequencyInterval

number

nullable

collectionFrequency

number

nullable

collectionTime

string

nullable

collectionLastScheduleDate

string format: date-time

nullable

collectionDuration

number

nullable

collectionExpiryDate

string format: date-time

photos

Array<string>

nullable

siteOwnerName

string

nullable

siteOwnerNumber

string

nullable

workerNumber

number

nullable

address

string

nullable

pinCode

number

nullable

comment

string

nullable

createdAt

required

string format: date-time

diseases

required

Array<object>

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

collectionCollector

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

createdBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

team

object

id

required

string

teamName

string

nullable

address

string

nullable

logo

string

nullable

location

object

id

required

string

coordinates

object

coordinates

required

Array<number>

type

required

string

region

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

parentRegion

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

diseases

Array<object>

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

team

object

id

required

string

teamName

string

nullable

address

string

nullable

logo

string

nullable

location

object

id

required

string

coordinates

object

coordinates

required

Array<number>

type

required

string

region

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

parentRegion

object

id

required

string

regionType

required

string

Allowed values: country state district subdistrict city

lgdCode

string

nullable

localName

required

string

name

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

visit

object

visitStartedAt

Timestamp when the collector opened the page

string format: date-time

nullable

visitStatus

required

string

Allowed values: upcoming overdue skipped completed

id

required

string

visitedAt

string format: date-time

nullable

visitScheduledAt

required

string format: date-time

comment

string

isCompleted

required

boolean

rescheduledFrom

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

visitedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

collector

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

labTests

Array<object>

object

testResult

string

Allowed values: pending positive negative unclear

id

required

string

ctValue

string

nullable

variant

string

nullable

viralLoad

string

nullable

kitOrProtocol

string

nullable

labComment

string

nullable

resultDate

string format: date-time

nullable

resultComment

string

nullable

testResultReport

string

nullable

testedAt

string format: date-time

nullable

project

object

id

required

string

name

required

string

code

required

string

sample

object

replicates

string

Allowed values: available not collected

sampleStatus

required

string

Allowed values: pending picked-up received pre-processed virus-isolation extracted tested rejected test-report-generated

barcode

required

string

id

required

string

sampleCode

string

nullable

collectedAt

required

string format: date-time

quantity

number

nullable

unit

string

nullable

habitat

string

nullable

conc

string

nullable

collectionTime

required

string format: date-time

photos

required

Array<string>

comment

string

nullable

rejectReason

string

nullable

receivedAt

string format: date-time

nullable

receivedVolumeValue

string

nullable

receivedVolumeUnit

string

nullable

receivedLabStorageDetails

string

nullable

extractionDateTime

string format: date-time

nullable

extractionSampleUsedValue

string

nullable

extractionSampleUsedUnit

string

nullable

extractionSampleRemainingValue

string

nullable

extractionSampleRemainingUnit

string

nullable

extractionComments

string

nullable

receivedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

extractedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

collectedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

reportGeneratedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

originalSampleId

string

nullable

disease

object

id

required

string

code

required

string

name

required

string

shortName

required

string

index

required

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

status

string

nullable

Allowed values: active inactive deleted

testedBy

object

firstName

string

nullable

Example

John

id

required

string

lastName

string

nullable

profilePicture

string

nullable

designation

string

nullable

contactNumber

required

string

nullable

address

string

nullable

email

string

nullable

hasAI

boolean

originalSampleId

string

nullable