Plate Service

This documentation provides information about the REST API for the Plate Service.

API Endpoints

updateWellSubstance

• HTTP Method: PUT
• Path: /wellsubstances/{wellSubstanceId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: WellSubstanceDTO

deleteWellSubstance

• HTTP Method: DELETE
• Path: /wellsubstances/{wellSubstanceId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: WellSubstanceDTO

getProject

• HTTP Method: GET
• Path: /projects/{projectId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: ProjectDTO

updateProject

• HTTP Method: PUT
• Path: /projects/{projectId}
• Description: TODO
• Responses:
  • 200 OK

deleteProject

• HTTP Method: DELETE
• Path: /projects/{projectId}
• Description: TODO
• Responses:
  • 200 OK

getPlateTemplate

• HTTP Method: GET
• Path: /platetemplates/{plateTemplateId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: PlateTemplateDTO

updatePlate

• HTTP Method: PUT
• Path: /platetemplates/{plateTemplateId}
• Description: TODO
• Responses:
  • 200 OK

deletePlate

• HTTP Method: DELETE
• Path: /platetemplates/{plateTemplateId}
• Description: TODO
• Responses:
  • 200 OK

getPlate

• HTTP Method: GET
• Path: /plates/{plateId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: PlateDTO

updatePlate_1

• HTTP Method: PUT
• Path: /plates/{plateId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: PlateDTO

deletePlate_1

• HTTP Method: DELETE
• Path: /plates/{plateId}
• Description: TODO
• Responses:
  • 200 OK

getPlateMeasurementByMeasId

• HTTP Method: GET
• Path: /plates/{plateId}/measurements/{measId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: PlateMeasurementDTO

setActiveMeasurement

• HTTP Method: PUT
• Path: /plates/{plateId}/measurements/{measId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: PlateMeasurementDTO

linkPlate

• HTTP Method: PUT
• Path: /plates/{plateId}/link/{plateTemplateId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: PlateDTO

getExperiment

• HTTP Method: GET
• Path: /experiments/{experimentId}
• Description: TODO
• Responses:
  • 200 OK
    • Schema: ExperimentDTO

updateExperiment

• HTTP Method: PUT
• Path: /experiments/{experimentId}
• Description: TODO
• Responses:
  • 200 OK

deleteExperiment

• HTTP Method: DELETE
• Path: /experiments/{experimentId}
• Description: TODO
• Responses:
  • 200 OK

getWellSubstances_1_1_1_1_1_1

• HTTP Method: GET
• Path: /wellsubstances
• Description: TODO
• Responses:
  • 200 OK

createWellSubstance

• HTTP Method: POST
• Path: /wellsubstances
• Description: TODO
• Responses:
  • 200 OK
    • Schema: WellSubstanceDTO

getProjects

• HTTP Method: GET
• Path: /projects
• Description: TODO
• Responses:
  • 200 OK

createProject

• HTTP Method: POST
• Path: /projects
• Description: TODO
• Responses:
  • 200 OK

createProjectAccess

• HTTP Method: POST
• Path: /projectaccess
• Description: TODO
• Responses:
  • 200 OK

getPlateTemplates_1

• HTTP Method: GET
• Path: /platetemplates
• Description:
• Responses:
  • 200 OK

createPlateTemplate

• HTTP Method: POST
• Path: /platetemplates
• Description:
• Responses:
  • 200 OK
    • Schema: PlateTemplateDTO

getPlatesByExperiment_1

• HTTP Method: GET
• Path: /plates
• Description:
• Responses:
  • 200 OK

createPlate

• HTTP Method: POST
• Path: /plates
• Description:
• Responses:
  • 200 OK
    • Schema: PlateDTO

getPlateMeasurements

• HTTP Method: GET
• Path: /plates/{plateId}/measurements
• Description:
• Responses:
  • 200 OK

addMeasurement

• HTTP Method: POST
• Path: /plates/{plateId}/measurements
• Description:
• Responses:
  • 200 OK
    • Schema: PlateMeasurementDTO

getAllExperiments

• HTTP Method: GET
• Path: /experiments
• Description:
• Responses:
  • 200 OK

createExperiment

• HTTP Method: POST
• Path: /experiments
• Description:
• Responses:
  • 200 OK
    • Schema: ExperimentDTO

getExperimentSummaries

• HTTP Method: GET
• Path: /projects/{projectId}/experimentsummaries
• Description:
• Responses:
  • 200 OK

getExperiments

• HTTP Method: GET
• Path: /projects/{projectId}/experiments
• Description:
• Responses:
  • 200 OK

getProjectAccess

• HTTP Method: GET
• Path: /projectaccess/{projectId}
• Description:
• Responses:
  • 200 OK

getWellTemplatesByPlateTemplateId

• HTTP Method: GET
• Path: /platetemplates/{plateTemplateId}/wells
• Description:
• Responses:
  • 200 OK

getWells

• HTTP Method: GET
• Path: /plates/{plateId}/wells
• Description:
• Responses:
  • 200 OK

getPlates

• HTTP Method: GET
• Path: /experiments/{experimentId}/plates
• Description:
• Responses:
  • 200 OK

deleteProjectAccess

• HTTP Method: DELETE
• Path: /projectaccess/{projectAccessId}
• Description:
• Responses:
  • 200 OK

Schema Components

WellSubstanceDTO

• Type: object
• Properties:
  • id (integer, int64):
  • type (string):
  • name (string):
  • concentration (number, double):
  • wellId (integer, int64):

ProjectDTO

• Type: object
• Properties:
  • id (integer, int64):
  • name (string):
  • description (string):
  • createdOn (string, date-time):
  • createdBy (string):
  • updatedOn (string, date-time):
  • updatedBy (string):
  • tags (array):

PlateTemplateDTO

• Type: object
• Properties:
  • id (integer, int64):
  • name (string):
  • description (string):
  • rows (integer, int32):
  • columns (integer, int32):
  • createdOn (string, date-time):
  • createdBy (string):
  • updatedOn (string, date-time):
  • updatedBy (string):
  • wells (array):
  • tags (array):

WellTemplateDTO

• Type: object
• Properties:
  • id (integer, int64):
  • description (string):
  • row (integer, int32):
  • column (integer, int32):
  • plateTemplateId (integer, int64):
  • wellType (string):
  • skipped (boolean):
  • substanceName (string):
  • substanceType (string):
  • concentration (number, double):

PlateDTO

• Type: object
• Properties:
  • id (integer, int64):
  • barcode (string):
  • description (string):
  • experimentId (integer, int64):
  • rows (integer, int32):
  • columns (integer, int32):
  • sequence (integer, int32):
  • linkStatus (string):
  • linkSource (string):
  • linkTemplateId (string):
  • linkedOn (string, date-time):
  • calculationStatus (string):
  • calculationError (string):
  • calculatedBy (string):
  • calculatedOn (string, date-time):
  • validationStatus (string):
  • validatedBy (string):
  • validatedOn (string, date-time):
  • invalidatedReason (string):
  • approvalStatus (string):
  • approvedBy (string):
  • approvedOn (string, date-time):
  • disapprovedReason (string):
  • uploadStatus (string):
  • uploadedBy (string):
  • uploadedOn (string, date-time):
  • createdOn (string, date-time):
  • createdBy (string):
  • updatedOn (string, date-time):
  • updatedBy (string):
  • tags (array):

PlateMeasurementDTO

• Type: object
• Properties:
  • measurementId (integer, int64):
  • plateId (integer, int64):
  • active (boolean):
  • linkedBy (string):
  • linkedOn (string, date-time):
  • name (string):
  • barcode (string):
  • description (string):
  • rows (integer, int32):
  • columns (integer, int32):
  • createdOn (string, date-time):
  • createdBy (string):
  • wellColumns (array):
  • subWellColumns (array):
  • imageChannels (array):

ExperimentDTO

• Type: object
• Properties:
  • id (integer, int64):
  • name (string):
  • description (string):
  • status (string):
  • projectId (integer, int64):
  • multiploMethod (string):
  • multiploParameter (string):
  • createdOn (string, date-time):
  • createdBy (string):
  • updatedOn (string, date-time):
  • updatedBy (string):
  • tags (array):

ProjectAccessDTO

• Type: object
• Properties:
  • id (integer, int64):
  • projectId (integer, int64):
  • teamName (string):
  • accessLevel (string):

ExperimentSummaryDTO

• Type: object
• Properties:
  • experimentId (integer, int64):
  • nrPlates (integer, int32):
  • nrPlatesCalculated (integer, int32):
  • nrPlatesValidated (integer, int32):
  • nrPlatesApproved (integer, int32):

WellDTO

• Type: object
• Properties:
  • id (integer, int64):
  • plateId (integer, int64):
  • row (integer, int32):
  • column (integer, int32):
  • wellType (string):
  • status (string):
  • description (string):
  • wellSubstance (undefined):
  • tags (array):