Resultdata Service

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