Phaedra 2 – API Documentation

Documentation: Calculation Service

Mon, 01 Jan 0001 00:00:00 +0000

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

API Endpoints

getFormula

HTTP Method: GET
Path: /formulas/{formulaId}
Description: TODO
Responses:
- 200 OK
  - Schema: FormulaDTO
- 400 Bad Request
- 404 Not Found

updateFormula

HTTP Method: PUT
Path: /formulas/{formulaId}
Description: TODO
Responses:
- 200 OK
  - Schema: FormulaDTO
- 400 Bad Request
- 404 Not Found

deleteFormula

HTTP Method: DELETE
Path: /formulas/{formulaId}
Description: TODO
Responses:
- 204 No Content
- 400 Bad Request
- 404 Not Found

getAllFormulas_1

HTTP Method: GET
Path: /formulas
Description: TODO
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

createFormula

HTTP Method: POST
Path: /formulas
Description: TODO
Responses:
- 201 Created
  - Schema: FormulaDTO
- 400 Bad Request
- 404 Not Found

fitCurve

HTTP Method: POST
Path: /curvefit
Description: TODO
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

calculate

HTTP Method: POST
Path: /calculation
Description: TODO
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

status

HTTP Method: GET
Path: /status
Description: TODO
Responses:
- 200 OK
  - Schema: CalculationStatus
- 400 Bad Request
- 404 Not Found

getFormulaInputNames

HTTP Method: GET
Path: /formulas/{formulaId}/inputs
Description: TODO
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

Schema Components

FormulaDTO

Type: object
Properties:
- id (integer, int64):
- name (string):
- description (string):
- category (string):
- formula (string):
- language (string):
- scope (string):
- previousVersionId (integer, int64):
- versionNumber (string):
- deprecated (boolean):
- createdBy (string):
- createdOn (string, date-time):
- updatedBy (string):
- updatedOn (string, date-time):

CurveFittingRequestDTO

Type: object
Properties:
- plateId (integer, int64):
- featureId (integer, int64):
- featureResultData (undefined):

ResultDataDTO

Type: object
Properties:
- id (integer, int64):
- resultSetId (integer, int64):
- featureId (integer, int64):
- values (array):
- statusCode (string):
- statusMessage (string):
- exitCode (integer, int32):
- createdTimestamp (string, date-time):
- resultFeatureStats (array):

ResultFeatureStatDTO

Type: object
Properties:
- id (integer, int64):
- resultSetId (integer, int64):
- featureId (integer, int64):
- featureStatId (integer, int64):
- value (number, float):
- statisticName (string):
- welltype (string):
- statusCode (string):
- statusMessage (string):
- exitCode (integer, int32):
- createdTimestamp (string, date-time):

CurveDTO

Type: object
Properties:
- id (integer, int64):
- plateId (integer, int64):
- protocolId (integer, int64):
- featureId (integer, int64):
- resultSetId (integer, int64):
- substanceName (string):
- substanceType (string):
- fitDate (string, date-time):
- version (string):
- wells (array):
- wellConcentrations (array):
- featureValues (array):
- plotDoseData (array):
- plotPredictionData (array):
- weights (array):
- curveProperties (array):
- slope (number, float):
- bottom (number, float):
- top (number, float):
- slopeLowerCI (number, float):
- slopeUpperCI (number, float):
- residualVariance (number, float):
- warning (string):
- pic80 (number, float):
- xaxisLabels (array):
- pic50 (string):
- pic50Censor (string):
- pic50StdErr (string):
- emax (number, float):
- emin (number, float):
- emaxConc (number, float):
- eminConc (number, float):
- pic20 (number, float):

CurvePropertyDTO

Type: object
Properties:
- curveId (integer, int64):
- name (string):
- stringValue (string):
- numericValue (number, float):
- binaryValue (array):
- numeric (boolean):
- binary (boolean):
- string (boolean):

CalculationRequestDTO

Type: object
Properties:
- protocolId (integer, int64):
- plateId (integer, int64):
- measId (integer, int64):

CalculationComplexityDTO

Type: object
Properties:
- steps (integer, int32):
- features (integer, int32):
- featureStats (integer, int32):
- featureStatResults (integer, int32):
- sequences (integer, int32):

CalculationStatus

Type: object
Properties:
- complexity (undefined):
- statusCode (string):
- errors (array):
- sequences (object):

ErrorDTO

Type: object
Properties:
- timestamp (string, date-time):
- exceptionClassName (string):
- exceptionMessage (string):
- description (string):
- featureId (integer, int64):
- featureName (string):
- sequenceNumber (integer, int32):
- formulaId (integer, int64):
- formulaName (string):
- civType (string):
- civVariableName (string):
- civSource (string):
- exitCode (integer, int32):
- statusMessage (string):
- featureStatId (integer, int64):
- featureStatName (string):
- newResultSetId (integer, int64):

FeatureStatusDTO

Type: object
Properties:
- status (undefined):
- statStatus (undefined):
- stats (object):

SequenceStatusDTO

Type: object
Properties:
- status (undefined):
- features (object):

StatusDescription

Type: object
Properties:
- statusCode (string):
- statusMessage (string):
- description (string):

Documentation: Measurement Service

Mon, 01 Jan 0001 00:00:00 +0000

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

API Endpoints

getConfig

HTTP Method: GET
Path: /renderconfigurations/{id}
Description: TODO
Responses:
- 200 OK
  - Schema: NamedImageRenderConfig

updateConfig

HTTP Method: PUT
Path: /renderconfigurations/{id}
Description: TODO
Responses:
- 200 OK

deleteConfig

HTTP Method: DELETE
Path: /renderconfigurations/{id}
Description: TODO
Responses:
- 200 OK

getMeasurement

HTTP Method: GET
Path: /measurements/{measurementId}
Description: TODO
Responses:
- 200 OK
  - Schema: MeasurementDTO

updateMeasurement

HTTP Method: PUT
Path: /measurements/{measurementId}
Description: TODO
Responses:
- 200 OK

deleteMeasurement

HTTP Method: DELETE
Path: /measurements/{measurementId}
Description: TODO
Responses:
- 200 OK

getAllConfigs

HTTP Method: GET
Path: /renderconfigurations
Description: TODO
Responses:
- 200 OK

createConfig

HTTP Method: POST
Path: /renderconfigurations
Description: TODO
Responses:
- 200 OK

getMeasurements

HTTP Method: GET
Path: /measurements
Description: TODO
Responses:
- 200 OK

createMeasurement

HTTP Method: POST
Path: /measurements
Description: TODO
Responses:
- 200 OK

getSubWellData_1

HTTP Method: GET
Path: /measurements/{measurementId}/subwelldata/{column}
Description: TODO
Responses:
- 200 OK

setSubWellData

HTTP Method: POST
Path: /measurements/{measurementId}/subwelldata/{column}
Description: TODO
Responses:
- 200 OK

getImageData

HTTP Method: GET
Path: /measurements/{measurementId}/imagedata/{wellNr}
Description: TODO
Responses:
- 200 OK

setImageData

HTTP Method: POST
Path: /measurements/{measurementId}/imagedata/{wellNr}
Description: TODO
Responses:
- 200 OK

getImageData_1

HTTP Method: GET
Path: /measurements/{measurementId}/imagedata/{wellNr}/{channel}
Description: TODO
Responses:
- 200 OK

setImageData_1

HTTP Method: POST
Path: /measurements/{measurementId}/imagedata/{wellNr}/{channel}
Description: TODO
Responses:
- 200 OK

getWellData

HTTP Method: GET
Path: /measurements/{measurementId}/welldata
Description: TODO
Responses:
- 200 OK

getWellData_1

HTTP Method: GET
Path: /measurements/{measurementId}/welldata/{column}
Description: TODO
Responses:
- 200 OK

getSubWellData

HTTP Method: GET
Path: /measurements/{measurementId}/subwelldata
Description: TODO
Responses:
- 200 OK

getSubWellData_2

HTTP Method: GET
Path: /measurements/{measurementId}/subwelldata/{column}/{wellNr}
Description: TODO
Responses:
- 200 OK

renderImage

HTTP Method: GET
Path: /measurements/{measurementId}/images/{wellNr}
Description: TODO
Responses:
- 200 OK

renderImage_1

HTTP Method: GET
Path: /measurements/{measurementId}/images/{wellNr}/{channel}
Description: TODO
Responses:
- 200 OK

Schema Components

ChannelRenderConfig

Type: object
Properties:
- name (string):
- rgb (integer, int32):
- alpha (number, float):
- contrastMin (number, float):
- contrastMax (number, float):

ImageRenderConfig

Type: object
Properties:
- format (string):
- gamma (number, float):
- scale (number, float):
- region (object):
- channelConfigs (array):

NamedImageRenderConfig

Type: object
Properties:
- id (integer, int64):
- name (string):
- createdOn (string, date-time):
- createdBy (string):
- config (undefined):

MeasurementDTO

Type: object
Properties:
- id (integer, int64):
- name (string):
- barcode (string):
- description (string):
- rows (integer, int32):
- columns (integer, int32):
- createdOn (string, date-time):
- createdBy (string):
- updatedOn (string, date-time):
- updatedBy (string):
- wellColumns (array):
- subWellColumns (array):
- imageChannels (array):

NewMeasurementDTO

Type: object
Properties:
- id (integer, int64):
- name (string):
- barcode (string):
- description (string):
- rows (integer, int32):
- columns (integer, int32):
- createdOn (string, date-time):
- createdBy (string):
- wellColumns (array):
- subWellColumns (array):
- imageChannels (array):
- welldata (object):

Documentation: Metadata Service

Mon, 01 Jan 0001 00:00:00 +0000

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

API Endpoints

getProperties

HTTP Method: GET
Path: /properties
Description: TODO
Responses:
- 200 OK

updateProperty

HTTP Method: PUT
Path: /properties
Description: TODO
Responses:
- 200 OK

createProperty

HTTP Method: POST
Path: /properties
Description: TODO
Responses:
- 200 OK

deleteProperty

HTTP Method: DELETE
Path: /properties
Description: TODO
Responses:
- 200 OK

getTagsByObjectIdAndObjectClass

HTTP Method: GET
Path: /tags
Description: TODO
Responses:
- 200 OK

addTag

HTTP Method: POST
Path: /tags
Description: TODO
Responses:
- 200 OK

removeTag

HTTP Method: DELETE
Path: /tags
Description: TODO
Responses:
- 200 OK

getMetadata

HTTP Method: GET
Path: /metadata
Description: TODO
Responses:
- 200 OK

Schema Components

PropertyDTO

Type: object
Properties:
- propertyName (string):
- propertyValue (string):
- objectId (integer, int64):
- objectClass (string):

TaggedObjectDTO

Type: object
Properties:
- objectId (integer, int64):
- objectClass (string):
- tag (string):

Documentation: Plate Service

Mon, 01 Jan 0001 00:00:00 +0000

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):

Documentation: Protocol Service

Mon, 01 Jan 0001 00:00:00 +0000

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

API Endpoints

getProtocol

HTTP Method: GET
Path: /protocols/{protocolId}
Description: TODO
Responses:
- 200 OK
  - Schema: ProtocolDTO
- 400 Bad Request
- 404 Not Found

updateProtocol

HTTP Method: PUT
Path: /protocols/{protocolId}
Description: TODO
Responses:
- 200 OK
  - Schema: ProtocolDTO
- 400 Bad Request
- 404 Not Found

deleteProtocol

HTTP Method: DELETE
Path: /protocols/{protocolId}
Description: TODO
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

tagProtocol

HTTP Method: PUT
Path: /protocols/{protocolId}/tag
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

getFeatureById

HTTP Method: GET
Path: /features/{featureId}
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

updateFeature

HTTP Method: PUT
Path: /features/{featureId}
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

deleteFeature

HTTP Method: DELETE
Path: /features/{featureId}
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

addTagToFeature

HTTP Method: PUT
Path: /features/{featureId}/tag
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

getFeatureStat

HTTP Method: GET
Path: /features/{featureId}/featurestats/{featureStatId}
Description:
Responses:
- 200 OK
  - Schema: FeatureStatDTO
- 400 Bad Request
- 404 Not Found

updateFeatureStat

HTTP Method: PUT
Path: /features/{featureId}/featurestats/{featureStatId}
Description:
Responses:
- 200 OK
  - Schema: FeatureStatDTO
- 400 Bad Request
- 404 Not Found

deleteFeatureStat

HTTP Method: DELETE
Path: /features/{featureId}/featurestats/{featureStatId}
Description:
Responses:
- 204 No Content
- 400 Bad Request
- 404 Not Found

updateCalculationInputValue

HTTP Method: PUT
Path: /features/{featureId}/calculationinputvalues/{calculationInputValueId}
Description:
Responses:
- 200 OK
  - Schema: CalculationInputValueDTO
- 400 Bad Request
- 404 Not Found

deleteCalculationInputValue

HTTP Method: DELETE
Path: /features/{featureId}/calculationinputvalues/{calculationInputValueId}
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

getDefaultFeatureStat

HTTP Method: GET
Path: /defaultfeaturestats/{defaultFeatureStatId}
Description:
Responses:
- 200 OK
  - Schema: DefaultFeatureStatDTO
- 400 Bad Request
- 404 Not Found

updateDefaultFeatureStat

HTTP Method: PUT
Path: /defaultfeaturestats/{defaultFeatureStatId}
Description:
Responses:
- 200 OK
  - Schema: DefaultFeatureStatDTO
- 400 Bad Request
- 404 Not Found

deleteDefaultFeatureStat

HTTP Method: DELETE
Path: /defaultfeaturestats/{defaultFeatureStatId}
Description:
Responses:
- 204 No Content
- 400 Bad Request
- 404 Not Found

getProtocols_1

HTTP Method: GET
Path: /protocols
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

createProtocol

HTTP Method: POST
Path: /protocols
Description:
Responses:
- 200 OK
  - Schema: ProtocolDTO
- 400 Bad Request
- 404 Not Found

getFeatures_1

HTTP Method: GET
Path: /features
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

createFeature

HTTP Method: POST
Path: /features
Description:
Responses:
- 200 OK
  - Schema: FeatureDTO
- 400 Bad Request
- 404 Not Found

getFeatureStatByFeatureId

HTTP Method: GET
Path: /features/{featureId}/featurestats
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

createFeatureStat

HTTP Method: POST
Path: /features/{featureId}/featurestats
Description:
Responses:
- 201 Created
  - Schema: FeatureStatDTO
- 400 Bad Request
- 404 Not Found

getCalculationInputValue

HTTP Method: GET
Path: /features/{featureId}/calculationinputvalues
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

createCalculationInputValue

HTTP Method: POST
Path: /features/{featureId}/calculationinputvalues
Description:
Responses:
- 200 OK
  - Schema: CalculationInputValueDTO
- 400 Bad Request
- 404 Not Found

getDefaultFeatureStats

HTTP Method: GET
Path: /defaultfeaturestats
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

createDefaultFeatureStat

HTTP Method: POST
Path: /defaultfeaturestats
Description:
Responses:
- 201 Created
  - Schema: DefaultFeatureStatDTO
- 400 Bad Request
- 404 Not Found

getFeatureStatByProtocolId

HTTP Method: GET
Path: /protocols/{protocolId}/featurestats
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

getProtocolFeatures

HTTP Method: GET
Path: /protocols/{protocolId}/features
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

getCalculationInputValueByProtocolIds

HTTP Method: GET
Path: /protocols/{protocolId}/calculationinputvalues
Description:
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

Schema Components

CalculationInputValueDTO

Type: object
Properties:
- id (integer, int64):
- featureId (integer, int64):
- formulaId (integer, int64):
- variableName (string):
- sourceMeasColName (string):
- sourceFeatureId (integer, int64):
- inputSource (string):

DRCModelDTO

Type: object
Properties:
- featureId (integer, int64):
- name (string):
- description (string):
- method (string):
- slope (string):
- script (string):
- inputParameters (object):
- outputParameters (object):

FeatureDTO

Type: object
Properties:
- id (integer, int64):
- name (string):
- alias (string):
- description (string):
- format (string):
- type (string):
- sequence (integer, int32):
- protocolId (integer, int64):
- formulaId (integer, int64):
- civs (array):
- drcModel (undefined):
- trigger (string):
- status (string):
- deleted (boolean):

ProtocolDTO

Type: object
Properties:
- id (integer, int64):
- name (string):
- description (string):
- lowWelltype (string):
- highWelltype (string):
- previousVersion (string):
- versionNumber (string):
- features (array):
- createdOn (string, date-time):
- createdBy (string):
- updatedOn (string, date-time):
- updatedBy (string):

FeatureStatDTO

Type: object
Properties:
- id (integer, int64):
- featureId (integer, int64):
- plateStat (boolean):
- welltypeStat (boolean):
- name (string):
- formulaId (integer, int64):

DefaultFeatureStatDTO

Type: object
Properties:
- id (integer, int64):
- plateStat (boolean):
- welltypeStat (boolean):
- name (string):
- formulaId (integer, int64):

Documentation: Resultdata Service

Mon, 01 Jan 0001 00:00:00 +0000

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

API Endpoints

getResultSet

HTTP Method: GET
Path: /resultsets/{id}
Description: TODO
Responses:
- 200 OK
  - Schema: ResultSetDTO
- 400 Bad Request
- 404 Not Found

updateResultSet

HTTP Method: PUT
Path: /resultsets/{id}
Description: TODO
Responses:
- 200 OK
  - Schema: ResultSetDTO
- 400 Bad Request
- 404 Not Found

deleteResultSet

HTTP Method: DELETE
Path: /resultsets/{id}
Description: TODO
Responses:
- 204 No Content
- 400 Bad Request
- 404 Not Found

getResultSets

HTTP Method: GET
Path: /resultsets
Description: TODO
Responses:
- 200 OK
  - Schema: PageDTOResultSetDTO
- 400 Bad Request
- 404 Not Found

createResultSet

HTTP Method: POST
Path: /resultsets
Description: TODO
Responses:
- 201 Created
  - Schema: ResultSetDTO
- 400 Bad Request
- 404 Not Found

getResultFeatureStat

HTTP Method: GET
Path: /resultsets/{resultSetId}/resultfeaturestats
Description: TODO
Responses:
- 200 OK
  - Schema: PageDTOResultFeatureStatDTO
- 400 Bad Request
- 404 Not Found

createResultFeatureStat

HTTP Method: POST
Path: /resultsets/{resultSetId}/resultfeaturestats
Description: TODO
Responses:
- 201 Created
- 400 Bad Request
- 404 Not Found

getResultData

HTTP Method: GET
Path: /resultsets/{resultSetId}/resultdata
Description: TODO
Responses:
- 200 OK
  - Schema: PageDTOResultDataDTO
- 400 Bad Request
- 404 Not Found

createResultData

HTTP Method: POST
Path: /resultsets/{resultSetId}/resultdata
Description: TODO
Responses:
- 201 Created
  - Schema: ResultDataDTO
- 400 Bad Request
- 404 Not Found

getResultFeatureStat_1

HTTP Method: GET
Path: /resultsets/{resultSetId}/resultfeaturestats/{resultFeatureStatId}
Description: TODO
Responses:
- 200 OK
  - Schema: ResultFeatureStatDTO
- 400 Bad Request
- 404 Not Found

deleteResultFeatureStat

HTTP Method: DELETE
Path: /resultsets/{resultSetId}/resultfeaturestats/{resultFeatureStatId}
Description: TODO
Responses:
- 204 No Content
- 400 Bad Request
- 404 Not Found

getResultData_1

HTTP Method: GET
Path: /resultsets/{resultSetId}/resultdata/{resultDataId}
Description: TODO
Responses:
- 200 OK
  - Schema: ResultDataDTO
- 400 Bad Request
- 404 Not Found

deleteResultData

HTTP Method: DELETE
Path: /resultsets/{resultSetId}/resultdata/{resultDataId}
Description: TODO
Responses:
- 204 No Content
- 400 Bad Request
- 404 Not Found

getNMostRecentResultSets

HTTP Method: GET
Path: /resultsets/latest
Description: TODO
Responses:
- 200 OK
- 400 Bad Request
- 404 Not Found

getPlateResults

HTTP Method: GET
Path: /plate-results/{plateId}
Description: TODO
Responses:
- 201 Created
  - Schema: PlateResultDTO
- 400 Bad Request
- 404 Not Found

getLatestPlateResults

HTTP Method: GET
Path: /plate-results/{plateId}/latest
Description: TODO
Responses:
- 201 Created
  - Schema: PlateResultDTO
- 400 Bad Request
- 404 Not Found

Schema Components

ErrorDTO

Type: object
Properties:
- timestamp (string, date-time):
- exceptionClassName (string):
- exceptionMessage (string):
- description (string):
- featureId (integer, int64):
- featureName (string):
- sequenceNumber (integer, int32):
- formulaId (integer, int64):
- formulaName (string):
- civType (string):
- civVariableName (string):
- civSource (string):
- exitCode (integer, int32):
- statusMessage (string):
- featureStatId (integer, int64):
- featureStatName (string):
- newResultSetId (integer, int64):

ResultSetDTO

Type: object
Properties:
- id (integer, int64):
- protocolId (integer, int64):
- plateId (integer, int64):
- measId (integer, int64):
- executionStartTimeStamp (string, date-time):
- executionEndTimeStamp (string, date-time):
- outcome (string):
- errors (array):
- errorsText (string):

ResultFeatureStatDTO

Type: object
Properties:
- id (integer, int64):
- resultSetId (integer, int64):
- featureId (integer, int64):
- featureStatId (integer, int64):
- value (number, float):
- statisticName (string):
- welltype (string):
- statusCode (string):
- statusMessage (string):
- exitCode (integer, int32):
- createdTimestamp (string, date-time):

ResultDataDTO

Type: object
Properties:
- id (integer, int64):
- resultSetId (integer, int64):
- featureId (integer, int64):
- values (array):
- statusCode (string):
- statusMessage (string):
- exitCode (integer, int32):
- createdTimestamp (string, date-time):
- resultFeatureStats (array):

PageDTOResultSetDTO

Type: object
Properties:
- data (array):
- status (undefined):

StatusDTO

Type: object
Properties:
- totalPages (integer, int32):
- totalElements (integer, int64):
- first (boolean):
- last (boolean):

PageDTOResultFeatureStatDTO

Type: object
Properties:
- data (array):
- status (undefined):

PageDTOResultDataDTO

Type: object
Properties:
- data (array):
- status (undefined):

PlateResultDTO

Type: object
Properties:
- protocols (object):

ResultsPerMeasurement

Type: object
Properties:
- resultData (array):

ResultsPerProtocolDTO

Type: object
Properties:
- measurements (object):