Calculation Service

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