{ "openapi" : "3.0.3", "info" : { "title" : "DRES Client API", "version" : "2.0.4", "description" : "Client API for DRES (Distributed Retrieval Evaluation Server), Version 2.0.4" }, "paths" : { "/api/v2/client/evaluation/currentTask/{evaluationId}" : { "get" : { "tags" : [ "Evaluation Client" ], "summary" : "Returns an overview of the currently active task for a run.", "operationId" : "getApiV2ClientEvaluationCurrentTaskByEvaluationId", "parameters" : [ { "name" : "evaluationId", "in" : "path", "description" : "The evaluation ID.", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } }, { "name" : "session", "in" : "query", "description" : "Session Token", "required" : false, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiClientTaskTemplateInfo" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/client/evaluation/list" : { "get" : { "tags" : [ "Evaluation Client" ], "summary" : "Lists an overview of all evaluation runs visible to the current client.", "operationId" : "getApiV2ClientEvaluationList", "parameters" : [ { "name" : "session", "in" : "query", "description" : "Session Token", "required" : false, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiClientEvaluationInfo" } } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/evaluation/info/list" : { "get" : { "tags" : [ "Evaluation" ], "summary" : "Lists an overview of all evaluations visible to the current user.", "operationId" : "getApiV2EvaluationInfoList", "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiEvaluationInfo" } } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/evaluation/state/list" : { "get" : { "tags" : [ "Evaluation" ], "summary" : "Lists an overview of all evaluation visible to the current user.", "operationId" : "getApiV2EvaluationStateList", "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiEvaluationState" } } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/evaluation/{evaluationId}/info" : { "get" : { "tags" : [ "Evaluation" ], "summary" : "Returns basic information about a specific evaluation.", "operationId" : "getApiV2EvaluationByEvaluationIdInfo", "parameters" : [ { "name" : "evaluationId", "in" : "path", "description" : "The evaluation ID.", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiEvaluationInfo" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/evaluation/{evaluationId}/state" : { "get" : { "tags" : [ "Evaluation" ], "summary" : "Returns the state of a specific evaluation.", "operationId" : "getApiV2EvaluationByEvaluationIdState", "parameters" : [ { "name" : "evaluationId", "in" : "path", "description" : "The evaluation ID.", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiEvaluationState" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/log/query/{evaluationId}" : { "post" : { "tags" : [ "Log" ], "summary" : "Accepts query logs from participants for the specified evaluation.", "operationId" : "postApiV2LogQueryByEvaluationId", "parameters" : [ { "name" : "evaluationId", "in" : "path", "description" : "The evaluation ID.", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } }, { "name" : "session", "in" : "query", "description" : "Session Token", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryEventLog" } } }, "required" : false }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessStatus" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/log/result/{evaluationId}" : { "post" : { "tags" : [ "Log" ], "summary" : "Accepts result logs from participants for the specified evaluation.", "operationId" : "postApiV2LogResultByEvaluationId", "parameters" : [ { "name" : "evaluationId", "in" : "path", "description" : "The evaluation ID.", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } }, { "name" : "session", "in" : "query", "description" : "Session Token", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/QueryResultLog" } } }, "required" : false }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessStatus" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/login" : { "post" : { "tags" : [ "User" ], "summary" : "Sets roles for session based on user account and returns a session cookie.", "operationId" : "postApiV2Login", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LoginRequest" } } }, "required" : false }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUser" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/logout" : { "get" : { "tags" : [ "User" ], "summary" : "Clears all user roles of the current session.", "operationId" : "getApiV2Logout", "parameters" : [ { "name" : "session", "in" : "query", "description" : "Session Token", "required" : false, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessStatus" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/status/time" : { "get" : { "tags" : [ "Status" ], "summary" : "Returns the current time on the server.", "operationId" : "getApiV2StatusTime", "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CurrentTime" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/submit/{evaluationId}" : { "post" : { "tags" : [ "Submission" ], "summary" : "Endpoint to accept submissions.", "operationId" : "postApiV2SubmitByEvaluationId", "parameters" : [ { "name" : "evaluationId", "in" : "path", "description" : "The ID of the evaluation the submission belongs to.", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } }, { "name" : "session", "in" : "query", "description" : "Session Token", "required" : false, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "description" : "Some notes regarding the submission format. At least one answerSet is required, taskId, taskName are inferred if not provided, at least one answer is required, mediaItemCollectionName is inferred if not provided, start and end should be provided in milliseconds.For most evaluation setups, an answer is built in one of the three following ways: A) only text is required: just provide the text property with a meaningful entry B) only a mediaItemName is required: just provide the mediaItemName, optionally with the collection name. C) a specific portion of a mediaItem is required: provide mediaItemName, start and end, optionally with collection name", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiClientSubmission" } } }, "required" : true }, "responses" : { "200" : { "description" : "The submission was accepted by the server and there was a verdict", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessfulSubmissionsStatus" } } } }, "202" : { "description" : "The submission was accepted by the server and there has not yet been a verdict available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SuccessfulSubmissionsStatus" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "412" : { "description" : "The submission was rejected by the server", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/user" : { "post" : { "tags" : [ "User" ], "summary" : "Creates a new user, if the username is not already taken. Requires ADMIN privileges", "operationId" : "postApiV2User", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUserRequest" } } }, "required" : false }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUser" } } } }, "400" : { "description" : "If the username is already taken", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] }, "get" : { "tags" : [ "User" ], "summary" : "Get information about the current user.", "operationId" : "getApiV2User", "parameters" : [ ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUser" } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/user/session" : { "get" : { "tags" : [ "User" ], "summary" : "Get current sessionId", "operationId" : "getApiV2UserSession", "parameters" : [ { "name" : "session", "in" : "query", "description" : "Session Token", "required" : false, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "text/plain" : { "schema" : { "type" : "string" } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } }, "/api/v2/user/{userId}" : { "delete" : { "tags" : [ "User" ], "summary" : "Deletes the specified user. Requires ADMIN privileges", "operationId" : "deleteApiV2UserByUserId", "parameters" : [ { "name" : "userId", "in" : "path", "description" : "User ID", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUser" } } } }, "404" : { "description" : "If the user could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] }, "patch" : { "tags" : [ "User" ], "summary" : "Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone.", "operationId" : "patchApiV2UserByUserId", "parameters" : [ { "name" : "userId", "in" : "path", "description" : "User ID", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUserRequest" } } }, "required" : false }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUser" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] }, "get" : { "tags" : [ "User" ], "summary" : "Gets details of the user with the given id.", "operationId" : "getApiV2UserByUserId", "parameters" : [ { "name" : "userId", "in" : "path", "description" : "User's UID", "required" : true, "deprecated" : false, "allowEmptyValue" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiUser" } } } }, "404" : { "description" : "If the user could not be found.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } }, "500" : { "description" : "Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorStatus" } } } } }, "deprecated" : false, "security" : [ ] } } }, "components" : { "schemas" : { "LoginRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "username" : { "type" : "string" }, "password" : { "type" : "string" } }, "required" : [ "username", "password" ] }, "ApiMediaCollection" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "basePath" : { "type" : "string" }, "itemCount" : { "type" : "integer", "format" : "int32" } }, "required" : [ "name", "itemCount" ] }, "ApiMediaItem" : { "type" : "object", "additionalProperties" : false, "properties" : { "mediaItemId" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/ApiMediaType" }, "collectionId" : { "type" : "string" }, "location" : { "type" : "string" }, "durationMs" : { "type" : "integer", "format" : "int64" }, "fps" : { "type" : "number", "format" : "float" }, "metadata" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiMediaItemMetaDataEntry" } } }, "required" : [ "mediaItemId", "name", "type", "collectionId", "location", "metadata" ] }, "ApiMediaItemMetaDataEntry" : { "type" : "object", "additionalProperties" : false, "properties" : { "key" : { "type" : "string" }, "value" : { "type" : "string" } }, "required" : [ "key", "value" ] }, "ApiMediaType" : { "type" : "string", "enum" : [ "IMAGE", "VIDEO", "TEXT" ] }, "ApiPopulatedMediaCollection" : { "type" : "object", "additionalProperties" : false, "properties" : { "collection" : { "$ref" : "#/components/schemas/ApiMediaCollection" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiMediaItem" } } }, "required" : [ "collection", "items" ] }, "ApiTemporalPoint" : { "type" : "object", "additionalProperties" : false, "properties" : { "value" : { "type" : "string" }, "unit" : { "$ref" : "#/components/schemas/ApiTemporalUnit" } }, "required" : [ "value", "unit" ] }, "ApiTemporalRange" : { "type" : "object", "additionalProperties" : false, "properties" : { "start" : { "$ref" : "#/components/schemas/ApiTemporalPoint" }, "end" : { "$ref" : "#/components/schemas/ApiTemporalPoint" } }, "required" : [ "start", "end" ] }, "ApiTemporalUnit" : { "type" : "string", "enum" : [ "FRAME_NUMBER", "SECONDS", "MILLISECONDS", "TIMECODE" ] }, "ApiClientEvaluationInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/ApiEvaluationType" }, "status" : { "$ref" : "#/components/schemas/ApiEvaluationStatus" }, "templateId" : { "type" : "string" }, "templateDescription" : { "type" : "string" }, "teams" : { "type" : "array", "items" : { "type" : "string" } }, "taskTemplates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiClientTaskTemplateInfo" } } }, "required" : [ "id", "name", "type", "status", "templateId", "teams", "taskTemplates" ] }, "ApiClientTaskTemplateInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "name" : { "type" : "string" }, "taskGroup" : { "type" : "string" }, "taskType" : { "type" : "string" }, "duration" : { "type" : "integer", "format" : "int64" } }, "required" : [ "name", "taskGroup", "taskType", "duration" ] }, "ApiEvaluation" : { "type" : "object", "additionalProperties" : false, "properties" : { "evaluationId" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/ApiEvaluationType" }, "template" : { "$ref" : "#/components/schemas/ApiEvaluationTemplate" }, "created" : { "type" : "integer", "format" : "int64" }, "started" : { "type" : "integer", "format" : "int64" }, "ended" : { "type" : "integer", "format" : "int64" }, "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTask" } } }, "required" : [ "evaluationId", "name", "type", "template", "created", "tasks" ] }, "ApiEvaluationInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/ApiEvaluationType" }, "status" : { "$ref" : "#/components/schemas/ApiEvaluationStatus" }, "properties" : { "$ref" : "#/components/schemas/ApiRunProperties" }, "templateId" : { "type" : "string" }, "templateDescription" : { "type" : "string" }, "teams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTeamInfo" } }, "taskTemplates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTaskTemplateInfo" } } }, "required" : [ "id", "name", "type", "status", "properties", "templateId", "teams", "taskTemplates" ] }, "ApiEvaluationOverview" : { "type" : "object", "additionalProperties" : false, "properties" : { "state" : { "$ref" : "#/components/schemas/RunManagerStatus" }, "teamOverviews" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTeamTaskOverview" } } }, "required" : [ "state", "teamOverviews" ] }, "ApiEvaluationState" : { "type" : "object", "additionalProperties" : false, "properties" : { "evaluationId" : { "type" : "string" }, "evaluationStatus" : { "$ref" : "#/components/schemas/ApiEvaluationStatus" }, "taskId" : { "type" : "string" }, "taskStatus" : { "$ref" : "#/components/schemas/ApiTaskStatus" }, "taskTemplateId" : { "type" : "string" }, "timeLeft" : { "type" : "integer", "format" : "int64" }, "timeElapsed" : { "type" : "integer", "format" : "int64" } }, "required" : [ "evaluationId", "evaluationStatus", "taskStatus", "timeLeft", "timeElapsed" ] }, "ApiEvaluationStatus" : { "type" : "string", "enum" : [ "CREATED", "ACTIVE", "TERMINATED" ] }, "ApiEvaluationType" : { "type" : "string", "enum" : [ "SYNCHRONOUS", "ASYNCHRONOUS", "NON_INTERACTIVE" ] }, "ApiOverrideAnswerSetVerdictDto" : { "type" : "object", "additionalProperties" : false, "properties" : { "verdict" : { "$ref" : "#/components/schemas/ApiVerdictStatus" } }, "required" : [ "verdict" ] }, "ApiSubmissionInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "evaluationId" : { "type" : "string" }, "taskId" : { "type" : "string" }, "submissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiSubmission" } } }, "required" : [ "evaluationId", "taskId", "submissions" ] }, "ApiTask" : { "type" : "object", "additionalProperties" : false, "properties" : { "taskId" : { "type" : "string" }, "templateId" : { "type" : "string" }, "started" : { "type" : "integer", "format" : "int64" }, "ended" : { "type" : "integer", "format" : "int64" }, "submissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiSubmission" } } }, "required" : [ "taskId", "templateId", "submissions" ] }, "ApiTaskOverview" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string" }, "group" : { "type" : "string" }, "duration" : { "type" : "integer", "format" : "int64" }, "taskId" : { "type" : "string" }, "status" : { "$ref" : "#/components/schemas/ApiTaskStatus" }, "started" : { "type" : "integer", "format" : "int64" }, "ended" : { "type" : "integer", "format" : "int64" } }, "required" : [ "id", "name", "type", "group", "duration", "taskId", "status" ] }, "ApiTaskStatus" : { "type" : "string", "enum" : [ "NO_TASK", "CREATED", "PREPARING", "RUNNING", "ENDED", "IGNORED" ] }, "ApiTaskTemplateInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "templateId" : { "type" : "string" }, "name" : { "type" : "string" }, "comment" : { "type" : "string" }, "taskGroup" : { "type" : "string" }, "taskType" : { "type" : "string" }, "duration" : { "type" : "integer", "format" : "int64" } }, "required" : [ "templateId", "name", "taskGroup", "taskType", "duration" ] }, "ApiTeamInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "color" : { "type" : "string" } }, "required" : [ "id", "name", "color" ] }, "ApiTeamTaskOverview" : { "type" : "object", "additionalProperties" : false, "properties" : { "teamId" : { "type" : "string" }, "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTaskOverview" } } }, "required" : [ "teamId", "tasks" ] }, "ApiViewerInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "viewersId" : { "type" : "string" }, "username" : { "type" : "string" }, "host" : { "type" : "string" }, "ready" : { "type" : "boolean" } }, "required" : [ "viewersId", "username", "host", "ready" ] }, "ApiScore" : { "type" : "object", "additionalProperties" : false, "properties" : { "teamId" : { "type" : "string" }, "score" : { "type" : "number", "format" : "double" } }, "required" : [ "teamId", "score" ] }, "ApiScoreOverview" : { "type" : "object", "additionalProperties" : false, "properties" : { "name" : { "type" : "string" }, "taskGroup" : { "type" : "string" }, "scores" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiScore" } } }, "required" : [ "name", "scores" ] }, "ApiScoreSeries" : { "type" : "object", "additionalProperties" : false, "properties" : { "team" : { "type" : "string" }, "name" : { "type" : "string" }, "points" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiScoreSeriesPoint" } } }, "required" : [ "team", "name", "points" ] }, "ApiScoreSeriesPoint" : { "type" : "object", "additionalProperties" : false, "properties" : { "score" : { "type" : "number", "format" : "double" }, "timestamp" : { "type" : "integer", "format" : "int64" } }, "required" : [ "score", "timestamp" ] }, "ApiTeamGroupValue" : { "type" : "object", "additionalProperties" : false, "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "number", "format" : "double" } }, "required" : [ "name", "value" ] }, "ApiAnswer" : { "type" : "object", "additionalProperties" : false, "properties" : { "type" : { "$ref" : "#/components/schemas/ApiAnswerType" }, "item" : { "$ref" : "#/components/schemas/ApiMediaItem" }, "text" : { "type" : "string" }, "start" : { "type" : "integer", "format" : "int64" }, "end" : { "type" : "integer", "format" : "int64" }, "temporalRange" : { "$ref" : "#/components/schemas/TemporalRange" } }, "required" : [ "type" ] }, "ApiAnswerSet" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "status" : { "$ref" : "#/components/schemas/ApiVerdictStatus" }, "taskId" : { "type" : "string" }, "answers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiAnswer" } } }, "required" : [ "id", "status", "taskId", "answers" ] }, "ApiAnswerType" : { "type" : "string", "enum" : [ "ITEM", "TEMPORAL", "TEXT" ] }, "ApiClientAnswer" : { "type" : "object", "additionalProperties" : false, "properties" : { "text" : { "type" : "string", "nullable" : true }, "mediaItemName" : { "type" : "string", "nullable" : true }, "mediaItemCollectionName" : { "type" : "string", "nullable" : true }, "start" : { "type" : "integer", "format" : "int64", "nullable" : true }, "end" : { "type" : "integer", "format" : "int64", "nullable" : true } } }, "ApiClientAnswerSet" : { "type" : "object", "additionalProperties" : false, "properties" : { "taskId" : { "type" : "string", "nullable" : true }, "taskName" : { "type" : "string", "nullable" : true }, "answers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiClientAnswer" } } }, "required" : [ "answers" ] }, "ApiClientSubmission" : { "type" : "object", "additionalProperties" : false, "properties" : { "answerSets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiClientAnswerSet" } } }, "required" : [ "answerSets" ] }, "ApiSubmission" : { "type" : "object", "additionalProperties" : false, "properties" : { "submissionId" : { "type" : "string" }, "teamId" : { "type" : "string" }, "memberId" : { "type" : "string" }, "teamName" : { "type" : "string" }, "memberName" : { "type" : "string" }, "timestamp" : { "type" : "integer", "format" : "int64" }, "answers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiAnswerSet" } } }, "required" : [ "submissionId", "teamId", "memberId", "teamName", "memberName", "timestamp", "answers" ] }, "ApiVerdictStatus" : { "type" : "string", "enum" : [ "CORRECT", "WRONG", "INDETERMINATE", "UNDECIDABLE" ] }, "ApiJudgement" : { "type" : "object", "additionalProperties" : false, "properties" : { "token" : { "type" : "string" }, "validator" : { "type" : "string" }, "verdict" : { "$ref" : "#/components/schemas/ApiVerdictStatus" } }, "required" : [ "token", "validator", "verdict" ] }, "ApiJudgementRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "token" : { "type" : "string" }, "validator" : { "type" : "string" }, "taskDescription" : { "type" : "string" }, "answerSet" : { "$ref" : "#/components/schemas/ApiAnswerSet" } }, "required" : [ "validator", "taskDescription", "answerSet" ] }, "ApiJudgementValidatorStatus" : { "type" : "object", "additionalProperties" : false, "properties" : { "validatorName" : { "type" : "string" }, "pending" : { "type" : "integer", "format" : "int32" }, "open" : { "type" : "integer", "format" : "int32" } }, "required" : [ "validatorName", "pending", "open" ] }, "ApiVote" : { "type" : "object", "additionalProperties" : false, "properties" : { "verdict" : { "$ref" : "#/components/schemas/ApiVerdictStatus" } }, "required" : [ "verdict" ] }, "ErrorStatus" : { "type" : "object", "additionalProperties" : false, "properties" : { "status" : { "type" : "boolean" }, "description" : { "type" : "string" } }, "required" : [ "status", "description" ] }, "SuccessStatus" : { "type" : "object", "additionalProperties" : false, "properties" : { "status" : { "type" : "boolean" }, "description" : { "type" : "string" } }, "required" : [ "status", "description" ] }, "SuccessfulSubmissionsStatus" : { "type" : "object", "additionalProperties" : false, "properties" : { "status" : { "type" : "boolean" }, "submission" : { "$ref" : "#/components/schemas/ApiVerdictStatus" }, "description" : { "type" : "string" } }, "required" : [ "status", "submission", "description" ] }, "CurrentTime" : { "type" : "object", "additionalProperties" : false, "properties" : { "timeStamp" : { "type" : "integer", "format" : "int64" } }, "required" : [ "timeStamp" ] }, "DresInfo" : { "type" : "object", "additionalProperties" : false, "properties" : { "version" : { "type" : "string" }, "startTime" : { "type" : "integer", "format" : "int64" }, "uptime" : { "type" : "integer", "format" : "int64" }, "os" : { "type" : "string" }, "jvm" : { "type" : "string" }, "args" : { "type" : "string" }, "cores" : { "type" : "integer", "format" : "int32" }, "freeMemory" : { "type" : "integer", "format" : "int64" }, "totalMemory" : { "type" : "integer", "format" : "int64" }, "load" : { "type" : "number", "format" : "double" }, "availableSeverThreads" : { "type" : "integer", "format" : "int32" } }, "required" : [ "version", "startTime", "uptime" ] }, "ApiContentElement" : { "type" : "object", "additionalProperties" : false, "properties" : { "contentType" : { "$ref" : "#/components/schemas/ApiContentType" }, "content" : { "type" : "string" }, "offset" : { "type" : "integer", "format" : "int64" } }, "required" : [ "contentType", "offset" ] }, "ApiContentType" : { "type" : "string", "enum" : [ "EMPTY", "TEXT", "VIDEO", "IMAGE" ] }, "ApiCreateEvaluation" : { "type" : "object", "additionalProperties" : false, "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" } }, "required" : [ "name", "description" ] }, "ApiEvaluationStartMessage" : { "type" : "object", "additionalProperties" : false, "properties" : { "templateId" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/ApiEvaluationType" }, "properties" : { "$ref" : "#/components/schemas/ApiRunProperties" } }, "required" : [ "templateId", "name", "type", "properties" ] }, "ApiEvaluationTemplate" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "created" : { "type" : "integer", "format" : "int64" }, "modified" : { "type" : "integer", "format" : "int64" }, "taskTypes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTaskType" } }, "taskGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTaskGroup" } }, "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTaskTemplate" } }, "teams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTeam" } }, "teamGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTeamGroup" } }, "judges" : { "type" : "array", "items" : { "type" : "string" } }, "viewers" : { "type" : "array", "items" : { "type" : "string" } } }, "required" : [ "id", "name", "taskTypes", "taskGroups", "tasks", "teams", "teamGroups", "judges", "viewers" ] }, "ApiEvaluationTemplateOverview" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "taskCount" : { "type" : "integer", "format" : "int32" }, "teamCount" : { "type" : "integer", "format" : "int32" } }, "required" : [ "id", "name", "taskCount", "teamCount" ] }, "ApiHint" : { "type" : "object", "additionalProperties" : false, "properties" : { "type" : { "$ref" : "#/components/schemas/ApiHintType" }, "start" : { "type" : "integer", "format" : "int64" }, "end" : { "type" : "integer", "format" : "int64" }, "description" : { "type" : "string" }, "path" : { "type" : "string" }, "dataType" : { "type" : "string" }, "item" : { "$ref" : "#/components/schemas/ApiMediaItem" }, "range" : { "$ref" : "#/components/schemas/ApiTemporalRange" } }, "required" : [ "type" ] }, "ApiHintContent" : { "type" : "object", "additionalProperties" : false, "properties" : { "taskId" : { "type" : "string" }, "sequence" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiContentElement" } }, "loop" : { "type" : "boolean" } }, "required" : [ "taskId", "sequence", "loop" ] }, "ApiHintType" : { "type" : "string", "enum" : [ "EMPTY", "TEXT", "VIDEO", "IMAGE" ] }, "ApiTarget" : { "type" : "object", "additionalProperties" : false, "properties" : { "type" : { "$ref" : "#/components/schemas/ApiTargetType" }, "target" : { "type" : "string" }, "range" : { "$ref" : "#/components/schemas/ApiTemporalRange" }, "item" : { "$ref" : "#/components/schemas/ApiMediaItem" } }, "required" : [ "type" ] }, "ApiTargetContent" : { "type" : "object", "additionalProperties" : false, "properties" : { "taskId" : { "type" : "string" }, "sequence" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiContentElement" } } }, "required" : [ "taskId", "sequence" ] }, "ApiTargetType" : { "type" : "string", "enum" : [ "JUDGEMENT", "JUDGEMENT_WITH_VOTE", "MEDIA_ITEM", "MEDIA_ITEM_TEMPORAL_RANGE", "TEXT" ] }, "ApiTaskGroup" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string" } }, "required" : [ "name", "type" ] }, "ApiTaskTemplate" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "taskGroup" : { "type" : "string" }, "taskType" : { "type" : "string" }, "duration" : { "type" : "integer", "format" : "int64" }, "collectionId" : { "type" : "string" }, "targets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTarget" } }, "hints" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiHint" } }, "comment" : { "type" : "string" } }, "required" : [ "name", "taskGroup", "taskType", "duration", "collectionId", "targets", "hints" ] }, "ApiTaskType" : { "type" : "object", "additionalProperties" : false, "properties" : { "name" : { "type" : "string" }, "duration" : { "type" : "integer", "format" : "int64" }, "targetOption" : { "$ref" : "#/components/schemas/ApiTargetOption" }, "hintOptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiHintOption" } }, "submissionOptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiSubmissionOption" } }, "taskOptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTaskOption" } }, "scoreOption" : { "$ref" : "#/components/schemas/ApiScoreOption" }, "configuration" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "required" : [ "name", "duration", "targetOption", "hintOptions", "submissionOptions", "taskOptions", "scoreOption", "configuration" ] }, "ApiHintOption" : { "type" : "string", "enum" : [ "IMAGE_ITEM", "VIDEO_ITEM_SEGMENT", "TEXT", "EXTERNAL_IMAGE", "EXTERNAL_VIDEO" ] }, "ApiScoreOption" : { "type" : "string", "enum" : [ "KIS", "AVS", "LEGACY_AVS" ] }, "ApiSubmissionOption" : { "type" : "string", "enum" : [ "NO_DUPLICATES", "LIMIT_CORRECT_PER_TEAM", "LIMIT_WRONG_PER_TEAM", "LIMIT_TOTAL_PER_TEAM", "LIMIT_CORRECT_PER_MEMBER", "TEMPORAL_SUBMISSION", "TEXTUAL_SUBMISSION", "ITEM_SUBMISSION", "MINIMUM_TIME_GAP" ] }, "ApiTargetOption" : { "type" : "string", "enum" : [ "SINGLE_MEDIA_ITEM", "SINGLE_MEDIA_SEGMENT", "JUDGEMENT", "VOTE", "TEXT" ] }, "ApiTaskOption" : { "type" : "string", "enum" : [ "HIDDEN_RESULTS", "MAP_TO_SEGMENT", "PROLONG_ON_SUBMISSION" ] }, "ApiTeam" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "color" : { "type" : "string" }, "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiUser" } }, "logoData" : { "type" : "string" }, "teamId" : { "type" : "string" } }, "required" : [ "users", "teamId" ] }, "ApiTeamAggregatorType" : { "type" : "string", "enum" : [ "MIN", "MAX", "MEAN", "LAST" ] }, "ApiTeamGroup" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "teams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiTeam" } }, "aggregation" : { "$ref" : "#/components/schemas/ApiTeamAggregatorType" } }, "required" : [ "teams", "aggregation" ] }, "ApiRole" : { "type" : "string", "enum" : [ "ANYONE", "VIEWER", "PARTICIPANT", "JUDGE", "ADMIN" ] }, "ApiUser" : { "type" : "object", "additionalProperties" : false, "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "role" : { "$ref" : "#/components/schemas/ApiRole" }, "sessionId" : { "type" : "string" } } }, "ApiUserRequest" : { "type" : "object", "additionalProperties" : false, "properties" : { "username" : { "type" : "string" }, "password" : { "type" : "string" }, "role" : { "$ref" : "#/components/schemas/ApiRole" } }, "required" : [ "username" ] }, "QueryEvent" : { "type" : "object", "additionalProperties" : false, "properties" : { "timestamp" : { "type" : "integer", "format" : "int64" }, "category" : { "$ref" : "#/components/schemas/QueryEventCategory" }, "type" : { "type" : "string" }, "value" : { "type" : "string" } }, "required" : [ "timestamp", "category", "type", "value" ] }, "QueryEventCategory" : { "type" : "string", "enum" : [ "TEXT", "IMAGE", "SKETCH", "FILTER", "BROWSING", "COOPERATION", "OTHER" ] }, "QueryEventLog" : { "type" : "object", "additionalProperties" : false, "properties" : { "timestamp" : { "type" : "integer", "format" : "int64" }, "events" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryEvent" } } }, "required" : [ "timestamp", "events" ] }, "QueryResultLog" : { "type" : "object", "additionalProperties" : false, "properties" : { "timestamp" : { "type" : "integer", "format" : "int64" }, "sortType" : { "type" : "string" }, "resultSetAvailability" : { "type" : "string" }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RankedAnswer" } }, "events" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/QueryEvent" } } }, "required" : [ "timestamp", "sortType", "resultSetAvailability", "results", "events" ] }, "RankedAnswer" : { "type" : "object", "additionalProperties" : false, "properties" : { "answer" : { "$ref" : "#/components/schemas/ApiClientAnswer" }, "rank" : { "type" : "integer", "format" : "int32" } }, "required" : [ "answer" ] }, "TemporalPoint" : { "type" : "object", "additionalProperties" : false, "properties" : { } }, "TemporalRange" : { "type" : "object", "additionalProperties" : false, "properties" : { "start" : { "$ref" : "#/components/schemas/TemporalPoint" }, "end" : { "$ref" : "#/components/schemas/TemporalPoint" }, "center" : { "type" : "integer", "format" : "int64" } }, "required" : [ "start", "end", "center" ] }, "ApiRunProperties" : { "type" : "object", "additionalProperties" : false, "properties" : { "participantCanView" : { "type" : "boolean" }, "shuffleTasks" : { "type" : "boolean" }, "allowRepeatedTasks" : { "type" : "boolean" }, "limitSubmissionPreviews" : { "type" : "integer", "format" : "int32" } }, "required" : [ "participantCanView", "shuffleTasks", "allowRepeatedTasks", "limitSubmissionPreviews" ] }, "RunManagerStatus" : { "type" : "string", "enum" : [ "CREATED", "ACTIVE", "TERMINATED" ] } }, "securitySchemes" : { "CookieAuth" : { "in" : "cookie", "name" : "SESSIONID", "type" : "apiKey" } } }, "servers" : [ ], "security" : [ ] }