Training Service

KYPO Training - API Reference

 Version: 22.12-rc.1

[ Base URL: localhost:8083/kypo-rest-training/api/v1 ]

Schemes

Cheating detection

POST/cheating-detections/create-detection

Create and Execute cheating detection

DELETE/cheating-detections/{cheatingDetectionId}/delete

Delete detection events of cheating detection

GET/cheating-detections/{cheatingDetectionId}/find-all-events

Get all detection events of cheating detection.

PATCH/cheating-detections/{cheatingDetectionId}/rerun

rerun cheating detection

GET/cheating-detections/{trainingInstanceId}/find-all-detections

Get all cheating detections of training instance.

Clusters

GET/clusters/training-definitions/{definitionId}/hints

Get hint cluster.

GET/clusters/training-definitions/{definitionId}/hints/sse

Get hint cluster SSE.

GET/clusters/training-definitions/{definitionId}/n-dimensional

Get n-dimensional cluster.

GET/clusters/training-definitions/{definitionId}/n-dimensional/sse

Get n-dimensional cluster SSE.

GET/clusters/training-definitions/{definitionId}/wrong-answers

Get wrong answers cluster.

GET/clusters/training-definitions/{definitionId}/wrong-answers/sse

Get wrong answers SSE.

Command Visualizations

GET/visualizations/commands/training-instances/{instanceId}

Get all commands executed in the given training instance associated by training runs

GET/visualizations/commands/training-instances/{instanceId}/aggregated

Get aggregated correct/incorrect commands executed during the given training runs.

GET/visualizations/commands/training-runs/{runId}

Get commands executed during the given training run.

GET/visualizations/commands/training-runs/{runId}/aggregated

Get aggregated correct/incorrect commands executed during the given training runs.

GET/visualizations/commands/training-runs/{runId}/all

Get all commands executed in the given Training Run

GET/visualizations/graphs/reference/training-definitions/{definitionId}

Get reference graph for the given training definition.

GET/visualizations/graphs/reference/training-instances/{instanceId}

Get reference graph for the given training instance.

GET/visualizations/graphs/reference/training-runs/{runId}

Get reference graph for the given training run.

GET/visualizations/graphs/summary/training-instances/{instanceId}

Get summary graph for the given training instance.

GET/visualizations/graphs/trainee/training-runs/{runId}

Get reference graph for the given training run.

GET/visualizations/training-instances/{instanceId}/training-runs

Get finished training runs of the training instance.

Export Imports

GET/exports/training-definitions/{definitionId}

Get exported training definitions and levels.

GET/exports/training-instances/{instanceId}

Archive training instance

GET/exports/training-instances/{instanceId}/scores

Export training instance scores

POST/imports/training-definitions

Import training definition with levels.

Training definitions

GET/training-definitions

Get all Training Definitions.

POST/training-definitions

Create Training Definition

PUT/training-definitions

Update Training Definition

GET/training-definitions/designers

Get designers.

GET/training-definitions/for-organizers

Get all Training Definitions for organizers.

GET/training-definitions/levels/{levelId}

Find level by ID

GET/training-definitions/organizers

Get organizers.

GET/training-definitions/{definitionId}

Get Training Definition by Id.

POST/training-definitions/{definitionId}

Clone training definition

DELETE/training-definitions/{definitionId}

Delete training definition

PUT/training-definitions/{definitionId}/assessment-levels

Update assessment level

GET/training-definitions/{definitionId}/authors

Get authors.

PUT/training-definitions/{definitionId}/authors

Edit authors.

GET/training-definitions/{definitionId}/beta-testers

Get beta testers.

GET/training-definitions/{definitionId}/designers-not-in-training-definition

Get designers not in given training definition.

GET/training-definitions/{definitionId}/has-reference-solution

Get boolean value if the reference solution is defined or not.

PUT/training-definitions/{definitionId}/info-levels

Update info level

PUT/training-definitions/{definitionId}/levels

Update levels

PUT/training-definitions/{definitionId}/levels/{levelIdFrom}/swap-with/{levelIdTo}

Swap levels

PUT/training-definitions/{definitionId}/levels/{levelIdToBeMoved}/move-to/{newPosition}

Move level

DELETE/training-definitions/{definitionId}/levels/{levelId}

Delete specific level from training definition

POST/training-definitions/{definitionId}/levels/{levelType}

Create level

PUT/training-definitions/{definitionId}/states/{state}

Switch state of training definition

PUT/training-definitions/{definitionId}/training-levels

Update training level

Training instances

GET/training-instances

Get all training instances.

POST/training-instances

Create training instance

PUT/training-instances

Update training instance

GET/training-instances/{instanceId}

Get training instance by id.

DELETE/training-instances/{instanceId}

Delete training instance

PATCH/training-instances/{instanceId}/assign-pool

Assign pool to the training instance

GET/training-instances/{instanceId}/organizers

Get organizers of training instance.

PUT/training-instances/{instanceId}/organizers

Edit organizers.

GET/training-instances/{instanceId}/organizers-not-in-training-instance

Get organizers not in given training instance.

GET/training-instances/{instanceId}/training-runs

Get all training runs of specific training instance

PATCH/training-instances/{instanceId}/unassign-pool

Unassign pool of training instance

Training runs

GET/training-runs

Get all training runs.

POST/training-runs

Access training run.

DELETE/training-runs

Delete training runs

GET/training-runs/accessible

Get all accessed training runs.

GET/training-runs/{runId}

Get training run by ID.

PUT/training-runs/{runId}

Finish training run

DELETE/training-runs/{runId}

Delete training run

GET/training-runs/{runId}/answers

Get correct answers of the training run.

PATCH/training-runs/{runId}/archive

Archive training run

PUT/training-runs/{runId}/assessment-evaluations

Evaluate responses to assessment

GET/training-runs/{runId}/hints/{hintId}

Get hint of training level.

POST/training-runs/{runId}/is-correct-answer

Check answer of training level

POST/training-runs/{runId}/is-correct-passkey

Check passkey of the access level

GET/training-runs/{runId}/levels/{levelId}

Get visited level of given training run.

GET/training-runs/{runId}/next-levels

Get level of given training run.

GET/training-runs/{runId}/participant

Get participant.

GET/training-runs/{runId}/resumption

Get current level of resumed training run

GET/training-runs/{runId}/solutions

Get solution of training level.

Visualizations

GET/visualizations/training-definitions/mitre-techniques

Get summarized mitre techniques.

GET/visualizations/training-definitions/{definitionId}

Get necessary data for analytical dashboard.

GET/visualizations/training-definitions/{definitionId}/clustering

Get necessary clustering visualization data for training definition.

GET/visualizations/training-instances/clustering

Get necessary clustering visualization data for the specified training instances.

GET/visualizations/training-instances/{instanceId}

Get necessary visualization info for training instance.

GET/visualizations/training-instances/{instanceId}/clustering

Get necessary clustering visualization data for organizer.

GET/visualizations/training-instances/{instanceId}/level-tabs

Get necessary level tabs visualization info for training instance.

GET/visualizations/training-instances/{instanceId}/levels/{levelId}

Get necessary data for compact level view visualization.

GET/visualizations/training-instances/{instanceId}/participants

Get necessary info about participants for specific training instance.

GET/visualizations/training-instances/{instanceId}/progress

Get necessary visualization info for training instance.

GET/visualizations/training-instances/{instanceId}/table

Get necessary table visualization data for organizer.

GET/visualizations/training-instances/{instanceId}/timeline

Get necessary timeline visualization data for organizer.

GET/visualizations/training-instances/{instanceId}/training-runs/{runId}/commands

Get all commands in a training run.

GET/visualizations/training-runs/{runId}

Get necessary visualization info for training run.

GET/visualizations/training-runs/{runId}/clustering

Get necessary clustering visualization data for trainee.

GET/visualizations/training-runs/{runId}/table

Get necessary table visualization data for trainee.

GET/visualizations/training-runs/{runId}/timeline

Get necessary timeline visualization data for trainee.

GET/visualizations/users

Get users by IDs.

Models

AbstractDetectionEventDTO

AbstractLevelDTO

AbstractLevelExportDTO

AbstractLevelImportDTO

AbstractLevelUpdateDTO

AbstractLevelVisualizationDTO

AccessLevelDTO

AccessLevelExportDTO

AccessLevelImportDTO

AccessLevelUpdateDTO

AccessLevelVisualizationDTO

AccessTrainingRunDTO

AccessedTrainingRunDTO

AccessedTrainingRunRestResource

AnswerSimilarityDetectionEventDTO

ApiEntityError

ApiError

ApiMicroserviceError

ApiSubError

AssessmentLevelDTO

AssessmentLevelExportDTO

AssessmentLevelImportDTO

AssessmentLevelUpdateDTO

AssessmentLevelVisualizationDTO

AttachmentImportDTO

BasicLevelInfoDTO

BetaTestingGroupCreateDTO

BetaTestingGroupUpdateDTO

CheatingDetectionDTO

CheatingDetectionRestResource

ClusteringLevelDTO

ClusteringLevelPlayerDTO

ClusteringVisualizationDTO

CompactLevelViewDTO

CompactLevelViewEventDTO

CompactLevelViewUserDTO

CorrectAnswerDTO

DetectionEventParticipantDTO

DetectionEventRestResource

EntityErrorDetail

ExportTrainingDefinitionAndLevelsDTO

ExtendedMatchingOptionDTO

ExtendedMatchingStatementDTO

ForbiddenCommandsDetectionEventDTO

HintDTO

HintExportDTO

HintImportDTO

ImportTrainingDefinitionDTO

InfoLevelDTO

InfoLevelExportDTO

InfoLevelImportDTO

InfoLevelUpdateDTO

InfoLevelVisualizationDTO

IsCorrectAnswerDTO

JavaApiError

LevelAnalyticalDashboardDTO

LevelTabsHintDTO

LevelTabsLevelDTO

LevelTabsPlayerDTO

LocationSimilarityDetectionEventDTO

MinimalSolveTimeDetectionEventDTO

MitreTechniqueDTO

NoCommandsDetectionEventDTO

Pageable

ParticipantAnalyticalDashboardDTO

ParticipantLevelAnalyticalDashboardDTO

PlayerDataDTO

PythonApiError

QuestionAnswerDTO

QuestionChoiceDTO

QuestionDTO

ReferenceSolutionNodeDTO

RoleDTO

SnapshotHookDTO

Sort

TakenHintDTO

TimeProximityDetectionEventDTO

TimelineDTO

TrainingDefinitionByIdDTO

TrainingDefinitionCreateDTO

TrainingDefinitionDTO

TrainingDefinitionInfoDTO

TrainingDefinitionMitreTechniqueDTO

TrainingDefinitionRestResource

TrainingDefinitionUpdateDTO

TrainingInstanceAnalyticalDashboardDTO

TrainingInstanceArchiveDTO

TrainingInstanceAssignPoolIdDTO

TrainingInstanceBasicInfoDTO

TrainingInstanceCreateDTO

TrainingInstanceDTO

TrainingInstanceFindAllResponseDTO

TrainingInstanceRestResource

TrainingInstanceUpdateDTO

TrainingLevelDTO

TrainingLevelExportDTO

TrainingLevelImportDTO

TrainingLevelUpdateDTO

TrainingLevelVisualizationDTO

TrainingResultsDTO

TrainingRunByIdDTO

TrainingRunDTO

TrainingRunRestResource

UserInfoDTO

UserInfoRestResource

UserRefDTO

ValidateAnswerDTO

ValidatePasskeyDTO

VisualizationInfoDTO