REST-API

GET /health

Check if TIRA is up and running

GET /info

General information about the running server

GET /v1/datasets

Returns a (optionally filtered) list of all datasets

POST /v1/datasets

Creates a new dataset and returns it

GET /v1/datasets/{datasetId}

Returns information on the specified dataset

PATCH /v1/datasets/{datasetId}

Updates the specified dataset

DELETE /v1/datasets/{datasetId}

Deletes the specified dataset

GET /v1/evaluations

GET /v1/organizers

Returns a (optionally filtered) list of all organizers

POST /v1/organizers

Creates a new organizer and returns its URL

GET /v1/organizers/{organizerId}

Returns the specified organizer

PATCH /v1/organizers/{organizerId}

Updates the specified organizer

DELETE /v1/organizers/{organizerId}

Deletes the specified organizer

GET /v1/runs/{runId}

Returns a (optionally filtered) list of all runs

PATCH /v1/runs/{runId}

Updates the specified organizer

DELETE /v1/runs/{runId}

Deletes the specified organizer

GET /v1/runs/{runId}/review

Returns the review of the specified run.

PATCH /v1/runs/{runId}/review

Updates the specified review

GET /v1/tasks

Returns a (optionally filtered) list of all tasks

POST /v1/tasks

Creates a new task and returns its URL

GET /v1/tasks/{taskId}

Returns the specified task

DELETE /v1/tasks/{taskId}

Deletes the specified task

GET /v1/tasks/{taskId}/evaluations

Returns a list of all evaluations associated with this task

GET /v1/tasks/{taskId}/registrations

Returns a list of all users registered for the task referenced by taskId

POST /v1/tasks/{taskId}/registrations

Registers a new user for the task referenced by taskId

GET /v1/tasks/{taskId}/submissions

Returns a (optionally filtered) list of all submissions for the task references by taskId

POST /v1/tasks/{taskId}/submissions

Submits a new submission for the authenticated user

GET /v1/tirex/components

Returns a description of all tirex components

GET /v1/tirex/components/{componentId}/snippet

Returns a snippet demonstrating the usage of the specified TIREx component

GET /v1/tools

Returns a list of tools

POST /v1/tools/{tool}

Invokes the specified tool

GET /v1/user

The user associated with the authenticated state

GET /v1/users/{userId}/submissions

Returns all submissions of the specified user Returns all submissions of the specified user.