Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added "report" field to SubmissionStatus

...

Synapse Evaluations are constructed around three primary objects: Evaluation, Participant, and Submission. These objects are defined by eponymous JSON schema files in the Synapse Repository Services.

Evaluation
Object representing a Synapse Evaluation

...

  • submissionID
  • eTag - optimistic concurrency flag; changes with each update
  • status - enum describing the state of the Submission, one of: OPEN, CLOSED, SCORED, INVALID
  • score - numerical score for this Submission (double between 0 and 1)
  • report - String describing this Submission and/or its scoring. May contain additional scoring information, error logs, etc.

REST API

Evaluation

URLHTTP TypeDescription
/evaluationPOST

Create a new Evaluation

/evaluation/{evaluationId}GETGet a Evaluation
/evaluation/{evaluationId}PUT

Update a Evaluation

/evaluation/{evaluationId}DELETEDelete a Evaluation
/evaluationGET

Batch Get Evaluations (Paginated)

Optional request parameters:
limit (long), offset (long)

/evaluation/countGETGet the number of Evaluations
/evaluation/name/{name}GETFind a Evaluation by name

Note that the name must be URL-encoded

...