Skip to main content

Feature Usage Catalogue

The features whose usage Artemis tracks, as users know them, and the modules and REST resources that implement each one. The catalogue is the UserFeature enum; @FeatureUsage on each controller or handler method assigns an endpoint to one of its entries.

This file is generated. Do not edit it by hand. It is checked in so that the catalogue as a whole can be reviewed in one place and so that a change to it shows up in a pull request diff. FeatureUsageAnnotationTest fails when it drifts from the annotations; regenerate it with:

./gradlew test --tests FeatureUsageAnnotationTest -DupdateFeatureUsageCatalogue=true

For every resource, the columns count its endpoints by how their calls are reported: Actions and Views are use of the feature, Automatic calls are made by the client on its own and System calls by another system, and neither of the last two counts as use. The interaction follows from the HTTP verb unless @UsageInteraction overrides it; every override is listed at the end. See Feature Usage Analysis for how the tracking works.

Currently 20 product areas, 152 features, 1086 REST endpoints in 29 modules, and 62 interaction overrides.

Courses​

My courses​

COURSE_DASHBOARD: The course cards on the start page and the archive of past courses.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0010
courseCourseArchiveResource0100
courseCourseOverviewResource0100

Course page​

COURSE_OVERVIEW: The student view of a course with its sidebar and exercise list.

ModuleResourceActionsViewsAutomaticSystem
courseCourseOverviewResource0510

Enrollment​

COURSE_ENROLLMENT: Self-enrollment into open courses and leaving a course.

ModuleResourceActionsViewsAutomaticSystem
courseCourseAccessResource2300

My statistics and grading key​

STUDENT_COURSE_STATISTICS: A student's own scores per exercise type and the course grading key.

ModuleResourceActionsViewsAutomaticSystem
assessmentGradeStepResource0200
exerciseExerciseScoresChartResource0100

Course calendar​

CALENDAR: Month, week and day views of course events, and the calendar subscription.

ModuleResourceActionsViewsAutomaticSystem
calendarCalendarResource0300

GLOBAL_SEARCH: The search dialog for courses, exercises, lectures and lecture content.

ModuleResourceActionsViewsAutomaticSystem
globalsearchGlobalSearchResource0200
irisIrisGlobalSearchResource0100

Course management​

Course creation and requests​

COURSE_CREATION: Creating courses and requesting a new course from the administrators.

ModuleResourceActionsViewsAutomaticSystem
adminAdminCourseRequestResource3100
adminAdminCourseResource1000
courseCourseRequestResource1000

Course management overview​

COURSE_MANAGEMENT_OVERVIEW: The list of managed courses and the course detail page for staff.

ModuleResourceActionsViewsAutomaticSystem
courseCourseManagementResource0900
courseCourseStatsResource0100

Course settings​

COURSE_SETTINGS: Course configuration, onboarding and the switches for optional features.

ModuleResourceActionsViewsAutomaticSystem
communicationConversationResource1000
courseCourseAthenaConfigResource1100
courseCourseUpdateResource1100

Course members​

COURSE_MEMBERS: Managing students, tutors, editors and instructors of a course.

ModuleResourceActionsViewsAutomaticSystem
accountUserResource0100
courseCourseAccessResource9700

Import from another course​

COURSE_MATERIAL_IMPORT: Importing exercises, lectures, exams and more from an earlier course.

ModuleResourceActionsViewsAutomaticSystem
courseCourseManagementResource0100
courseCourseMaterialImportResource1100

Course statistics​

COURSE_STATISTICS: Activity and performance charts of a course.

ModuleResourceActionsViewsAutomaticSystem
coreStatisticsResource0200
courseCourseStatsResource0200

Course scores​

COURSE_SCORES: The table of every student's points across all exercises.

ModuleResourceActionsViewsAutomaticSystem
assessmentParticipantScoreResource0200
plagiarismPlagiarismCaseResource0100

Course archive and cleanup​

COURSE_ARCHIVE: Archiving a finished course and cleaning up its data.

ModuleResourceActionsViewsAutomaticSystem
courseCourseArchiveResource2100

Course reset and deletion​

COURSE_RESET_DELETE: Resetting or deleting a course, including the progress display.

ModuleResourceActionsViewsAutomaticSystem
adminAdminCourseResource2200

Images in Markdown​

MARKDOWN_UPLOADS: Uploading and showing images and files embedded in Markdown texts.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource1010

Exercises​

Exercise details page​

EXERCISE_DETAILS: The page students open for an exercise, with its problem statement.

ModuleResourceActionsViewsAutomaticSystem
exerciseExerciseResource0410
exerciseProblemStatementRenderingResource0100
programmingPlantUmlResource0020

Start and practice​

EXERCISE_PARTICIPATION: Starting, resuming and practicing an exercise.

ModuleResourceActionsViewsAutomaticSystem
exerciseParticipationResource3000
exerciseParticipationRetrievalResource0200

Results and feedback​

EXERCISE_FEEDBACK: The result and feedback students see for a submission.

ModuleResourceActionsViewsAutomaticSystem
assessmentLongFeedbackTextResource0100
assessmentResultResource0100
fileuploadFileUploadAssessmentResource0100
modelingModelingAssessmentResource0100

Team exercises​

TEAM_EXERCISES: Creating and importing teams and working on an exercise as a team.

ModuleResourceActionsViewsAutomaticSystem
exerciseTeamResource5500

Exercise variant groups​

EXERCISE_VARIANT_GROUPS: Interchangeable exercise variants that share a timeline and score.

ModuleResourceActionsViewsAutomaticSystem
exerciseExerciseVariantGroupResource4200

Exercise management​

EXERCISE_MANAGEMENT: The staff list of a course's exercises and the common exercise actions.

ModuleResourceActionsViewsAutomaticSystem
exerciseExerciseResource1200

Version history​

EXERCISE_VERSION_HISTORY: Browsing earlier versions of an exercise.

ModuleResourceActionsViewsAutomaticSystem
exerciseExerciseVersionResource0200

Review comments​

EXERCISE_REVIEW: Review threads on exercise content and resolving them.

ModuleResourceActionsViewsAutomaticSystem
exerciseExerciseReviewResource9100

Participations​

EXERCISE_PARTICIPATIONS_STAFF: The staff view of participations, individual due dates and submissions.

ModuleResourceActionsViewsAutomaticSystem
exerciseParticipationDeletionResource2000
exerciseParticipationRetrievalResource0400
exerciseParticipationUpdateResource2000
exerciseSubmissionResource1100

Exercise scores and statistics​

EXERCISE_SCORES: Results per student, external results and exercise statistics.

ModuleResourceActionsViewsAutomaticSystem
assessmentResultResource1100
coreStatisticsResource0100

Programming exercises​

Online code editor​

PROGRAMMING_ONLINE_EDITOR: Editing, committing and submitting code in the browser.

ModuleResourceActionsViewsAutomaticSystem
programmingProgrammingExerciseParticipationResource1000
programmingRepositoryProgrammingExerciseParticipationResource8400

Local IDE and Git​

PROGRAMMING_LOCAL_IDE: Cloning and pushing repositories to work in a local IDE.

ModuleResourceActionsViewsAutomaticSystem
programmingIdeSettingsResource2200

Also recorded outside REST by LocalVCUsageTrackingService.

Online IDE​

PROGRAMMING_ONLINE_IDE: Working on a programming exercise in the cloud IDE.

ModuleResourceActionsViewsAutomaticSystem
programmingProgrammingExerciseRetrievalResource0100
programmingTheiaConfigurationResource0100

Repository and commit history​

PROGRAMMING_REPOSITORY_HISTORY: Viewing a repository, its commits and its access log.

ModuleResourceActionsViewsAutomaticSystem
programmingProgrammingExerciseParticipationResource0800
programmingRepositoryProgrammingExerciseParticipationResource0100

Build results and logs​

PROGRAMMING_RESULTS: Automatic test results, build status and build logs.

ModuleResourceActionsViewsAutomaticSystem
assessmentResultResource0100
localciBuildJobQueueResource0010
programmingProgrammingExerciseParticipationResource0420
programmingProgrammingSubmissionResource2000
programmingPublicProgrammingExerciseResultResource0001
programmingRepositoryProgrammingExerciseParticipationResource0100

Also recorded outside REST by LocalVCUsageTrackingService.

Create and edit programming exercises​

PROGRAMMING_AUTHORING: Setting up, updating and deleting programming exercises.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0100
localciAutomaticAfterDueDateResource0100
localciBuildPhasesTemplateResource0100
programmingProgrammingExerciseCreationResource2000
programmingProgrammingExerciseDeletionResource3000
programmingProgrammingExercisePartialUpdateResource2000
programmingProgrammingExerciseRetrievalResource01200
programmingProgrammingExerciseTaskResource0200
programmingProgrammingExerciseUpdateResource1000

Edit exercise repositories​

PROGRAMMING_REPOSITORY_EDITING: Editing the test and auxiliary repositories in the editor, and the template, solution and test repositories over Git.

ModuleResourceActionsViewsAutomaticSystem
programmingAuxiliaryRepositoryResource8300
programmingTestRepositoryResource8300

Also recorded outside REST by LocalVCUsageTrackingService.

Build plan and configuration​

PROGRAMMING_BUILD_CONFIGURATION: Editing the build plan and build settings of an exercise.

ModuleResourceActionsViewsAutomaticSystem
localciBuildPlanResource1100
localciPublicBuildPlanResource0001
programmingProgrammingExerciseBuildConfigResource1000

Test weights and static code analysis​

PROGRAMMING_GRADING_CONFIGURATION: Configuring test case weights, bonus points and code analysis categories.

ModuleResourceActionsViewsAutomaticSystem
programmingProgrammingExerciseGradingResource0100
programmingProgrammingExerciseTestCaseResource2100
programmingStaticCodeAnalysisResource3100

Re-evaluate and trigger builds​

PROGRAMMING_REEVALUATION: Re-evaluating results and triggering the builds of all participants.

ModuleResourceActionsViewsAutomaticSystem
programmingProgrammingExerciseGradingResource1000
programmingProgrammingExerciseUpdateResource1000
programmingProgrammingSubmissionResource2000

Submission policies​

PROGRAMMING_SUBMISSION_POLICY: Limits and penalties for the number of submissions.

ModuleResourceActionsViewsAutomaticSystem
programmingSubmissionPolicyResource4200

Structural consistency check​

PROGRAMMING_CONSISTENCY_CHECK: Checking the repositories and build plans of an exercise for errors.

ModuleResourceActionsViewsAutomaticSystem
exerciseConsistencyCheckResource1000

Import and export programming exercises​

PROGRAMMING_IMPORT_EXPORT: Importing exercises, exporting them and downloading repositories.

ModuleResourceActionsViewsAutomaticSystem
programmingProgrammingExerciseExportImportResource4100
programmingProgrammingExerciseRepositoryExportResource0400

Quizzes​

Live quiz​

QUIZ_LIVE: Taking part in a synchronized, batched or individual quiz.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0020
quizQuizExerciseBatchResource1000
quizQuizExerciseRetrievalResource0100
quizQuizParticipationResource1100
quizQuizSubmissionResource1000

Quiz practice​

QUIZ_PRACTICE: Retaking a quiz after it has ended.

ModuleResourceActionsViewsAutomaticSystem
quizQuizSubmissionResource1000

Quiz training​

QUIZ_TRAINING: Training with the course's question pool and the leaderboard.

ModuleResourceActionsViewsAutomaticSystem
quizQuizTrainingResource3300

Quiz editor​

QUIZ_AUTHORING: Creating quiz questions, including drag and drop from UML diagrams.

ModuleResourceActionsViewsAutomaticSystem
modelingApollonDiagramResource3210
quizQuizExerciseCreationUpdateResource3000
quizQuizExerciseDeletionResource1000
quizQuizExerciseRetrievalResource0400
quizQuizSubmissionResource0100

Quiz start and batches​

QUIZ_LIFECYCLE: Starting and ending a quiz and managing its batches.

ModuleResourceActionsViewsAutomaticSystem
quizQuizExerciseBatchResource2000
quizQuizExerciseResource1000

Quiz statistics and re-evaluation​

QUIZ_EVALUATION: Question statistics and correcting and re-scoring a quiz.

ModuleResourceActionsViewsAutomaticSystem
quizQuizExerciseEvaluationResource2000
quizQuizStatisticsResource0300

Text, modeling and file upload exercises​

Text exercises​

TEXT_EXERCISES: Writing and submitting a text answer.

ModuleResourceActionsViewsAutomaticSystem
textTextExerciseResource0100
textTextSubmissionResource2100

Create text exercises​

TEXT_AUTHORING: Creating, importing and exporting text exercises.

ModuleResourceActionsViewsAutomaticSystem
textTextExerciseCreationUpdateResource3000
textTextExerciseExportImportResource2000
textTextExerciseResource1300

Modeling exercises​

MODELING_EXERCISES: Drawing and submitting a UML diagram.

ModuleResourceActionsViewsAutomaticSystem
modelingApollonConversionResource0100
modelingModelingSubmissionResource2200

Create modeling exercises​

MODELING_AUTHORING: Creating, importing and exporting modeling exercises.

ModuleResourceActionsViewsAutomaticSystem
modelingModelingExerciseResource6300

File upload exercises​

FILE_UPLOAD_EXERCISES: Uploading files as the answer to an exercise.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0100
fileuploadFileUploadSubmissionResource1100

Create file upload exercises​

FILE_UPLOAD_AUTHORING: Creating, importing and exporting file upload exercises.

ModuleResourceActionsViewsAutomaticSystem
fileuploadFileUploadExerciseResource6300

Assessment and grading​

Assessment dashboard​

ASSESSMENT_DASHBOARD: The tutor dashboards of courses, exams and exercises, and assessment locks.

ModuleResourceActionsViewsAutomaticSystem
courseCourseManagementResource0200
courseCourseStatsResource0100
examExamResource0400
exerciseExerciseResource1200
exerciseSubmissionResource0300

Manual assessment​

MANUAL_ASSESSMENT: Assessing text, modeling, file upload and programming submissions.

ModuleResourceActionsViewsAutomaticSystem
fileuploadFileUploadAssessmentResource4000
fileuploadFileUploadSubmissionResource0300
modelingModelingAssessmentResource4000
modelingModelingSubmissionResource0300
programmingProgrammingAssessmentResource4000
programmingProgrammingSubmissionResource0300
programmingRepositoryProgrammingExerciseParticipationResource0400
textTextAssessmentResource5100
textTextSubmissionResource0200

Complaints and feedback requests​

COMPLAINTS: Students complaining about an assessment and tutors responding.

ModuleResourceActionsViewsAutomaticSystem
assessmentComplaintResource1500
assessmentComplaintResponseResource3000
courseCourseOverviewResource0100

Feedback ratings​

FEEDBACK_RATINGS: Students rating the feedback they received.

ModuleResourceActionsViewsAutomaticSystem
assessmentRatingResource2200

Tutor training​

TUTOR_TRAINING: Example submissions with example assessments for training tutors.

ModuleResourceActionsViewsAutomaticSystem
assessmentExampleSubmissionResource5100
assessmentTutorParticipationResource2000
exerciseSubmissionResource0100
modelingModelingAssessmentResource1100
textTextAssessmentResource2100

Tutor effort​

TUTOR_EFFORT: Statistics on the time tutors spend assessing.

ModuleResourceActionsViewsAutomaticSystem
assessmentTutorEffortResource0100
textAdminTextAssessmentEventResource0100
textTextAssessmentEventResource1100

Grading keys​

GRADING_KEYS: Grade steps of courses and exams.

ModuleResourceActionsViewsAutomaticSystem
assessmentGradeStepResource0200
assessmentGradingScaleResource6300

Bonus​

BONUS: Bonus points from another course or exam.

ModuleResourceActionsViewsAutomaticSystem
assessmentBonusResource3200

Results and feedback analysis​

RESULTS_AND_FEEDBACK_ANALYSIS: Aggregated feedback across all submissions of an exercise.

ModuleResourceActionsViewsAutomaticSystem
assessmentResultResource0300
communicationChannelResource1000

Presentation assessments​

PRESENTATION_ASSESSMENT: Managing presentation assessments, presentation instances, presenters, and their grades.

ModuleResourceActionsViewsAutomaticSystem
assessmentPresentationAssessmentResource6300

Exams​

Take an exam​

EXAM_TAKE: Starting an exam, working on it and handing it in.

ModuleResourceActionsViewsAutomaticSystem
examExamResource0300
examExamUserResource0100
examStudentExamResource2100
quizQuizSubmissionResource1000

Test exams​

EXAM_TEST_EXAMS: Practice exams with several attempts.

ModuleResourceActionsViewsAutomaticSystem
examStudentExamResource0100

Exam results and review​

EXAM_RESULTS: The exam summary, the grade and the review period.

ModuleResourceActionsViewsAutomaticSystem
assessmentGradeStepResource0200
examStudentExamResource0200

Create and configure exams​

EXAM_AUTHORING: Creating, importing and configuring exams and exercise groups.

ModuleResourceActionsViewsAutomaticSystem
examExamResource4610
examExerciseGroupResource5200

Exam registration​

EXAM_REGISTRATION: Registering students for an exam.

ModuleResourceActionsViewsAutomaticSystem
examExamResource4000
examExamUserResource1300

Rooms and seats​

EXAM_ROOMS: Exam rooms and distributing students to seats.

ModuleResourceActionsViewsAutomaticSystem
examAdminExamRoomManagementResource1000
examExamRoomDistributionResource2400
examExamRoomManagementResource1100

Attendance check​

EXAM_ATTENDANCE: Checking identities and signatures during the exam.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0200
examExamRoomDistributionResource0100
examExamUserResource1100
examStudentExamResource1000

Exam conduction​

EXAM_CONDUCTION_MANAGEMENT: Generating student exams, test runs, working time and announcements.

ModuleResourceActionsViewsAutomaticSystem
examExamResource5100
examStudentExamResource8500

Suspicious behavior​

EXAM_SUSPICIOUS_BEHAVIOR: Suspicious exam sessions and potential plagiarism in an exam.

ModuleResourceActionsViewsAutomaticSystem
examExamResource0200

Exam scores and statistics​

EXAM_SCORES: The scores and statistics of an exam.

ModuleResourceActionsViewsAutomaticSystem
assessmentParticipantScoreResource0100
examExamResource0200

Exam archive, reset and deletion​

EXAM_ARCHIVE: Archiving, resetting, cleaning up and deleting an exam.

ModuleResourceActionsViewsAutomaticSystem
examExamResource4200

Lectures​

Lecture pages​

LECTURE_PAGES: The list of lectures and the lecture detail page.

ModuleResourceActionsViewsAutomaticSystem
lectureLectureResource0410

Lecture units and slides​

LECTURE_UNITS: Viewing attachments and slides and completing lecture units.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0600
lectureLectureUnitResource1100

Lecture videos and transcripts​

LECTURE_VIDEO: Watching lecture videos and reading their transcripts.

ModuleResourceActionsViewsAutomaticSystem
lectureLectureTranscriptionResource0100
videosourceTumLiveResource0100

Create and manage lectures​

LECTURE_AUTHORING: Creating lectures and their units and importing lectures.

ModuleResourceActionsViewsAutomaticSystem
coreFileResource0100
lectureAttachmentVideoUnitResource2100
lectureExerciseUnitResource1100
lectureLectureResource5200
lectureLectureUnitResource2100
lectureOnlineUnitResource2200
lectureTextUnitResource2100
videosourceGocastApprovalCallbackResource0100
videosourceGocastIntegrationResource2100

Slide splitting and hidden pages​

LECTURE_SLIDE_PROCESSING: Splitting a slide deck into units and hiding pages for students.

ModuleResourceActionsViewsAutomaticSystem
lectureAttachmentVideoUnitResource3200

Automatic content processing​

LECTURE_CONTENT_PROCESSING: Transcription and processing of lecture content.

ModuleResourceActionsViewsAutomaticSystem
irisPyrisInternalIngestionWorkerResource0002
irisPyrisInternalStatusUpdateResource0001
lectureLectureTranscriptionResource0100
lectureLectureUnitResource1100

Communication​

Messages and threads​

MESSAGING: Writing, reading and answering messages in any conversation.

ModuleResourceActionsViewsAutomaticSystem
communicationAnswerMessageResource4100
communicationConversationMessageResource4200
coreFileResource1010
courseCourseAccessResource0100

Channels​

CHANNELS: Browsing, creating and moderating channels.

ModuleResourceActionsViewsAutomaticSystem
communicationChannelResource10400

Direct messages and group chats​

DIRECT_MESSAGES: Starting one-to-one and group conversations.

ModuleResourceActionsViewsAutomaticSystem
communicationGroupChatResource4000
communicationOneToOneChatResource1000
courseCourseAccessResource0200

Conversation list​

CONVERSATION_ORGANIZATION: Favorites, muting, unread messages and the code of conduct.

ModuleResourceActionsViewsAutomaticSystem
communicationChannelResource1000
communicationConversationResource5420
coreFileResource0100

Reactions, saved and forwarded messages​

MESSAGE_INTERACTIONS: Reacting to, saving and forwarding messages.

ModuleResourceActionsViewsAutomaticSystem
communicationForwardedMessageResource1100
communicationReactionResource2000
communicationSavedPostResource3100

LINK_PREVIEWS: Previews of links in messages.

ModuleResourceActionsViewsAutomaticSystem
communicationLinkPreviewResource0100

FAQs​

FAQ: Reading, proposing and managing the frequently asked questions of a course.

ModuleResourceActionsViewsAutomaticSystem
communicationFaqImportResource1100
communicationFaqResource3500

Notifications​

In-app notifications​

COURSE_NOTIFICATIONS: The notification bell with the notifications of each course.

ModuleResourceActionsViewsAutomaticSystem
courseCourseOverviewResource0010
notificationCourseNotificationResource0110
notificationUserCourseNotificationStatusResource2010

Notification delivery​

NOTIFICATION_DELIVERY: Delivering notifications in the app, by email and by push.

Also recorded outside REST by CourseNotificationService.

Notification settings​

NOTIFICATION_SETTINGS: Choosing which notifications to receive.

ModuleResourceActionsViewsAutomaticSystem
notificationGlobalNotificationSettingResource1100
notificationUserCourseNotificationSettingResource2100

System notifications​

SYSTEM_NOTIFICATIONS: Maintenance and information banners for all users.

ModuleResourceActionsViewsAutomaticSystem
notificationAdminSystemNotificationResource3100
notificationPublicSystemNotificationResource0010
notificationSystemNotificationResource0200

Tutorial groups​

My tutorial groups​

TUTORIAL_GROUPS: The tutorial groups of a course with their schedule and sessions.

ModuleResourceActionsViewsAutomaticSystem
lectureLectureResource0100
tutorialgroupTutorialGroupResource0210
tutorialgroupTutorialGroupsConfigurationResource0100

Tutorial group management​

TUTORIAL_GROUP_MANAGEMENT: Creating groups, registering students and configuring free days.

ModuleResourceActionsViewsAutomaticSystem
tutorialgroupTutorialGroupFreePeriodResource3400
tutorialgroupTutorialGroupResource7600
tutorialgroupTutorialGroupsConfigurationResource2000

Tutorial group sessions​

TUTORIAL_GROUP_SESSIONS: Creating, cancelling and activating sessions.

ModuleResourceActionsViewsAutomaticSystem
tutorialgroupTutorialGroupSessionResource5000

Competencies and learning paths​

Competency progress​

COMPETENCY_PROGRESS: Students' progress and mastery per competency.

ModuleResourceActionsViewsAutomaticSystem
atlasCompetencyResource0200
atlasCourseCompetencyResource0510
atlasPrerequisiteResource0200

Competency management​

COMPETENCY_MANAGEMENT: Creating, linking and importing competencies and prerequisites.

ModuleResourceActionsViewsAutomaticSystem
atlasCompetencyResource7000
atlasCourseCompetencyResource4500
atlasPrerequisiteResource7000

Standardized competency catalog​

STANDARDIZED_COMPETENCIES: The shared catalog of standardized competencies.

ModuleResourceActionsViewsAutomaticSystem
atlasAdminStandardizedCompetencyResource7100
atlasCompetencyResource1000
atlasPrerequisiteResource1000
atlasStandardizedCompetencyResource0300

Learning paths​

LEARNING_PATHS: A student's personalized sequence of learning objects.

ModuleResourceActionsViewsAutomaticSystem
atlasLearningPathResource2900
lectureLectureUnitResource0100

Learning path management​

LEARNING_PATH_MANAGEMENT: Enabling learning paths and monitoring their health.

ModuleResourceActionsViewsAutomaticSystem
atlasLearningPathResource2400

Learner profile​

LEARNER_PROFILE: A student's learning preferences.

ModuleResourceActionsViewsAutomaticSystem
atlasCourseLearnerProfileResource1100
atlasLearnerProfileResource1100

Research data collection​

SCIENCE: Collecting learning events for research, with an opt-out.

ModuleResourceActionsViewsAutomaticSystem
atlasScienceResource1000
atlasScienceSettingsResource1010

AI for learners​

Iris chat​

IRIS_CHAT: Chatting with Iris about a course, an exercise or a lecture.

ModuleResourceActionsViewsAutomaticSystem
irisIrisChatSessionResource4220
irisIrisMessageResource5100
irisIrisResource0010
irisPyrisInternalStatusUpdateResource0002

Iris memories​

IRIS_MEMORY: What Iris remembers about a student, and deleting it.

ModuleResourceActionsViewsAutomaticSystem
accountAccountResource1000
irisIrisMemoryResource2200

Iris struggle intervention​

IRIS_STRUGGLE_INTERVENTION: Iris offering help when a student is stuck.

ModuleResourceActionsViewsAutomaticSystem
irisIrisStruggleInterventionResource5000
irisPyrisInternalStatusUpdateResource0001

IRIS_SEARCH_ANSWER: An AI answer shown in the global search.

ModuleResourceActionsViewsAutomaticSystem
irisIrisGlobalSearchResource1000
irisPyrisInternalStatusUpdateResource0001

Iris course settings​

IRIS_SETTINGS: Configuring Iris for a course.

ModuleResourceActionsViewsAutomaticSystem
irisIrisSettingsResource1010

Iris content ingestion​

IRIS_CONTENT_INGESTION: Sending FAQs to Iris so that it can answer with them.

ModuleResourceActionsViewsAutomaticSystem
irisIrisResource0100
irisPyrisInternalStatusUpdateResource0001

AI feedback on request​

AI_FEEDBACK_REQUEST: Students requesting formative AI feedback on their work.

ModuleResourceActionsViewsAutomaticSystem
examStudentExamResource1100
exerciseParticipationResource1000

Also recorded outside REST by AthenaFeedbackSuggestionsService.

AI for instructors and tutors​

AI problem statement generation​

HYPERION_PROBLEM_STATEMENT: Generating, refining and rewriting a problem statement.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionProblemStatementResource4000

AI instructor checklist​

HYPERION_CHECKLIST: Analyzing a problem statement against a quality checklist.

ModuleResourceActionsViewsAutomaticSystem
atlasCompetencyResource1000
hyperionHyperionProblemStatementResource3000

AI consistency check​

HYPERION_CONSISTENCY_CHECK: Checking the problem statement against the code of an exercise.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionProblemStatementResource1000

AI code generation​

HYPERION_CODE_GENERATION: Generating the solution, template or test code of an exercise.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionCodeGenerationResource1010

AI exercise generation​

HYPERION_EXERCISE_GENERATION: Generating a whole programming exercise from a brief or selected review feedback.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionExerciseGenerationResource4400

AI generation monitoring​

HYPERION_GENERATION_MONITORING: Inspecting and stopping whole-exercise generation jobs.

ModuleResourceActionsViewsAutomaticSystem
hyperionAdminHyperionGenerationMonitoringResource1100

AI generation recovery​

HYPERION_GENERATION_RECOVERY: Inspecting and releasing blocked exercise mutation slots.

ModuleResourceActionsViewsAutomaticSystem
hyperionAdminHyperionGenerationResource1100

AI exercise variants​

HYPERION_VARIANT_GENERATION: Generating variants of an existing exercise.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionExerciseVariantResource2020

AI quiz questions​

HYPERION_QUIZ_GENERATION: Generating and refining quiz questions.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionQuizQuestionGenerationResource3000

AI grading criteria​

HYPERION_ASSESSMENT_CRITERIA: Generating structured grading criteria.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionAssessmentCriteriaGenerationResource1000

AI FAQ rewrite​

HYPERION_FAQ_REWRITE: Rewriting the text of an FAQ.

ModuleResourceActionsViewsAutomaticSystem
hyperionHyperionFaqResource1000

AI feedback suggestions​

ATHENA_FEEDBACK_SUGGESTIONS: Suggested feedback for tutors while they assess.

ModuleResourceActionsViewsAutomaticSystem
athenaAthenaInternalResource0004
athenaAthenaResource0300

Also recorded outside REST by AthenaFeedbackSuggestionsService.

AI answer suggestions for tutors​

IRIS_TUTOR_SUGGESTIONS: Suggested answers when tutors reply to a question.

ModuleResourceActionsViewsAutomaticSystem
irisIrisMessageResource1000
irisIrisTutorSuggestionSessionResource1010
irisPyrisInternalStatusUpdateResource0002

Atlas agent​

ATLAS_AGENT: A chat assistant for managing competencies.

ModuleResourceActionsViewsAutomaticSystem
atlasAtlasAgentResource1100

Automatic competency linking​

COMPETENCY_ORCHESTRATION: Linking exercises to competencies automatically.

ModuleResourceActionsViewsAutomaticSystem
atlasCompetencyOrchestrationResource2100

AI competency generation​

AI_COMPETENCY_GENERATION: Generating competencies and suggesting their relations.

ModuleResourceActionsViewsAutomaticSystem
atlasCompetencyResource3000
atlasCourseCompetencyResource1000
irisPyrisInternalStatusUpdateResource0001

Academic integrity​

Plagiarism checks​

PLAGIARISM_CHECKS: Running plagiarism checks and inspecting the matches.

ModuleResourceActionsViewsAutomaticSystem
plagiarismPlagiarismResource2200
programmingProgrammingExercisePlagiarismResource2100
programmingRepositoryProgrammingExerciseParticipationResource0200
textTextExercisePlagiarismResource1100

Continuous plagiarism control​

CONTINUOUS_PLAGIARISM_CONTROL: Plagiarism checks that run automatically.

Also recorded outside REST by ContinuousPlagiarismControlService.

Plagiarism cases​

PLAGIARISM_CASES: Verdicts on plagiarism cases and the discussion with students.

ModuleResourceActionsViewsAutomaticSystem
plagiarismPlagiarismAnswerPostResource3000
plagiarismPlagiarismCaseResource1700
plagiarismPlagiarismPostResource3100

Malicious participation analysis​

DEIMOS: Analyzing programming participations for malicious code.

ModuleResourceActionsViewsAutomaticSystem
deimosDeimosResource2000

Account and security​

Sign-in​

SIGN_IN: Signing in and out, including single sign-on.

ModuleResourceActionsViewsAutomaticSystem
corePublicAccountResource0200
corePublicUserJwtResource4000

Registration and password​

REGISTRATION_PASSWORD: Registering an account and changing or resetting the password.

ModuleResourceActionsViewsAutomaticSystem
accountAccountResource1000
corePublicAccountResource3100

Account settings​

ACCOUNT_SETTINGS: Profile, language, profile picture and AI preferences.

ModuleResourceActionsViewsAutomaticSystem
accountAccountResource4000
accountUserResource2000
coreFileResource0010
corePublicAccountResource1010

Passkeys​

PASSKEYS: Registering and managing passkeys.

ModuleResourceActionsViewsAutomaticSystem
accountPasskeyResource3200

SSH keys and access tokens​

GIT_CREDENTIALS: SSH keys and personal access tokens for Git.

ModuleResourceActionsViewsAutomaticSystem
accountAccountResource3100
localvcSshFingerprintsProviderResource0100
programmingRepositoryVcsAccessTokenResource1100
programmingSshPublicKeysResource2200
programmingVcsAccessTokenOverviewResource1100

Personal data export​

PERSONAL_DATA_EXPORT: Exporting one's own data.

ModuleResourceActionsViewsAutomaticSystem
coreDataExportResource1400

Integrations​

LTI​

LTI: Opening Artemis content from a learning management system.

ModuleResourceActionsViewsAutomaticSystem
ltiAdminLtiConfigurationResource4100
ltiLtiResource2200
ltiPublicLtiResource1000
ltiPublicOAuth2JWKSResource0001

Sharing platform​

SHARING_PLATFORM: Exchanging programming exercises with the sharing platform.

ModuleResourceActionsViewsAutomaticSystem
coreSharingSupportResource0002
programmingExerciseSharingResource2201

Mobile apps​

MOBILE_APPS: Deep links and push notifications of the iOS and Android apps.

ModuleResourceActionsViewsAutomaticSystem
communicationAndroidAppSiteAssociationResource0001
communicationAppleAppSiteAssociationResource0001
notificationPushNotificationResource2000

VS Code extension​

VS_CODE_EXTENSION: Signing in to Artemis from the VS Code extension.

ModuleResourceActionsViewsAutomaticSystem
accountTokenResource1000

Build system​

Build overview​

BUILD_OVERVIEW: The build jobs of a course with their logs.

ModuleResourceActionsViewsAutomaticSystem
localciBuildJobQueueResource3500
localciBuildLogResource0100

Build agents​

BUILD_AGENTS: All build jobs and the build agents of the server.

ModuleResourceActionsViewsAutomaticSystem
adminAdminBuildJobQueueResource9900
localvcPublicBuildAgentAddressResource0001

AI workers​

AI_WORKERS: Checking the status and capacity of AI workers.

ModuleResourceActionsViewsAutomaticSystem
aiworkerAdminAiWorkerResource0100

Administration and operations​

User management​

USER_MANAGEMENT: Creating, importing, editing and deleting users.

ModuleResourceActionsViewsAutomaticSystem
accountAdminUserResource8700
adminAdminCourseResource0100

Organizations​

ORGANIZATIONS: Organizations that group users and courses.

ModuleResourceActionsViewsAutomaticSystem
accountOrganizationResource0100
adminAdminOrganizationResource8610

Feature toggles​

FEATURE_TOGGLES: Switching features on and off at runtime.

ModuleResourceActionsViewsAutomaticSystem
adminAdminFeatureToggleResource1000

Monitoring​

MONITORING: Metrics, logs, audits, websocket and scheduled jobs.

ModuleResourceActionsViewsAutomaticSystem
adminAdminAuditResource0300
adminAdminLogResource1100
adminAdminMetricsResource0100
adminAdminScheduleResource0200
adminAdminWebsocketResource1010

Usage statistics​

USAGE_STATISTICS: Platform usage over time.

ModuleResourceActionsViewsAutomaticSystem
adminAdminStatisticsResource0100

Feature usage​

FEATURE_USAGE: This page.

ModuleResourceActionsViewsAutomaticSystem
adminAdminFeatureUsageResource1300

Cleanup service​

DATA_CLEANUP: Deleting orphaned and outdated data.

ModuleResourceActionsViewsAutomaticSystem
adminAdminCleanupResource121400

Data exports​

ADMIN_DATA_EXPORTS: Creating data exports for users.

ModuleResourceActionsViewsAutomaticSystem
adminAdminDataExportResource2200

Imprint and privacy statement​

LEGAL_PAGES: Viewing and editing the imprint and the privacy statement.

ModuleResourceActionsViewsAutomaticSystem
adminAdminImprintResource1100
adminAdminPrivacyStatementResource1100
corePublicImprintResource0100
corePublicPrivacyStatementResource0100

Dependencies and vulnerabilities​

DEPENDENCIES: The software bill of materials and known vulnerabilities.

ModuleResourceActionsViewsAutomaticSystem
adminAdminSbomResource2500

Iris dashboard​

IRIS_ADMIN_DASHBOARD: Usage, cost and alerts of Iris.

ModuleResourceActionsViewsAutomaticSystem
irisIrisAdminDashboardResource0400

Index dashboard​

INGESTION_DASHBOARD: Coverage of the global search index against what the database expects.

ModuleResourceActionsViewsAutomaticSystem
globalsearchIngestionBrowserResource0300
globalsearchIngestionCoverageResource1300

Upcoming exams and exercises​

UPCOMING_EXAMS_AND_EXERCISES: An overview of what is coming up across all courses.

ModuleResourceActionsViewsAutomaticSystem
examAdminExamResource0100
exerciseAdminExerciseResource0100

Interaction overrides​

The endpoints whose calls do not count the way their HTTP verb suggests, grouped by how they count instead.

Counted as actions​

  • GET api/admin/sbom/vulnerabilities/refresh (DEPENDENCIES)
  • GET api/atlas/courses/{courseId}/competencies/relations/suggest (AI_COMPETENCY_GENERATION)
  • GET api/exam/courses/{courseId}/exams/{examId}/student-exams/{studentExamId}/conduction (EXAM_TAKE)
  • GET api/exam/courses/{courseId}/exams/{examId}/test-runs/{testRunId}/conduction (EXAM_CONDUCTION_MANAGEMENT)
  • GET api/exercise/programming-exercises/{programmingExerciseId}/consistency-check (PROGRAMMING_CONSISTENCY_CHECK)
  • GET api/programming/programming-exercises/{exerciseId}/check-plagiarism (PLAGIARISM_CHECKS)
  • GET api/programming/programming-exercises/{exerciseId}/check-plagiarism-jplag-report (PLAGIARISM_CHECKS)
  • GET api/text/text-exercises/{exerciseId}/check-plagiarism (PLAGIARISM_CHECKS)

Counted as views​

  • POST api/account/admin/users/deletion-impact (USER_MANAGEMENT)
  • POST api/exercise/problem-statement/render (EXERCISE_DETAILS)
  • POST api/iris/lecture-search (GLOBAL_SEARCH)
  • POST api/localci/programming-exercises/timeline/automatic-after-due-date-preview (PROGRAMMING_AUTHORING)
  • POST api/modeling/apollon/convert-to-pdf (MODELING_EXERCISES)
  • POST api/programming/programming-exercises/{exerciseId}/files-content-commit-details/selected (PROGRAMMING_REPOSITORY_HISTORY)
  • POST api/programming/sharing/import/basket/exercise-details (SHARING_PLATFORM)
  • POST api/quiz/courses/{courseId}/training-questions (QUIZ_TRAINING)
  • POST api/quiz/exercises/{exerciseId}/submissions/preview (QUIZ_AUTHORING)

Counted as automatic calls​

  • GET api/admin/organizations/{organizationId}/title (ORGANIZATIONS)
  • GET api/admin/websocket/nodes (MONITORING)
  • GET api/atlas/course-competencies/{competencyId}/title (COMPETENCY_PROGRESS)
  • GET api/atlas/science-settings (SCIENCE)
  • GET api/communication/courses/{courseId}/unread-messages (CONVERSATION_ORGANIZATION)
  • GET api/core/files/courses/{courseId}/conversations/{conversationId}/{filename} (MESSAGING)
  • GET api/core/files/courses/{courseId}/icons/* (COURSE_DASHBOARD)
  • GET api/core/files/drag-and-drop/questions/{questionId}/backgrounds/* (QUIZ_LIVE)
  • GET api/core/files/drag-and-drop/questions/{questionId}/drag-items/{dragItemId}/* (QUIZ_LIVE)
  • GET api/core/files/markdown/{filename} (MARKDOWN_UPLOADS)
  • GET api/core/files/users/{userId}/profile-pictures/* (ACCOUNT_SETTINGS)
  • GET api/core/public/account (ACCOUNT_SETTINGS)
  • GET api/course/courses/for-notifications (COURSE_NOTIFICATIONS)
  • GET api/course/courses/{courseId}/title (COURSE_OVERVIEW)
  • GET api/exam/exams/{examId}/title (EXAM_AUTHORING)
  • GET api/exercise/exercises/{exerciseId}/title (EXERCISE_DETAILS)
  • GET api/hyperion/programming-exercises/{exerciseId}/code-generation/active-job (HYPERION_CODE_GENERATION)
  • GET api/hyperion/variant-jobs (HYPERION_VARIANT_GENERATION)
  • GET api/hyperion/variant-jobs/{jobId} (HYPERION_VARIANT_GENERATION)
  • GET api/iris/chat/courses/{courseId}/sessions/overview (IRIS_CHAT)
  • GET api/iris/courses/{courseId}/iris-settings (IRIS_SETTINGS)
  • GET api/iris/courses/{courseId}/status (IRIS_CHAT)
  • GET api/lecture/lectures/{lectureId}/title (LECTURE_PAGES)
  • GET api/localci/queued-jobs/queue-duration-estimation (PROGRAMMING_RESULTS)
  • GET api/modeling/apollon-diagrams/{diagramId}/title (QUIZ_AUTHORING)
  • GET api/notification/courses/info (COURSE_NOTIFICATIONS)
  • GET api/notification/public/system-notifications/active (SYSTEM_NOTIFICATIONS)
  • GET api/programming/plantuml/png (EXERCISE_DETAILS)
  • GET api/programming/plantuml/svg (EXERCISE_DETAILS)
  • GET api/programming/programming-exercise-participations/{participationId}/latest-pending-submission (PROGRAMMING_RESULTS)
  • GET api/programming/programming-exercises/{exerciseId}/latest-pending-submissions (PROGRAMMING_RESULTS)
  • GET api/tutorialgroup/tutorial-groups/{tutorialGroupId}/title (TUTORIAL_GROUPS)
  • PATCH api/communication/courses/{courseId}/conversations/{conversationId}/mark-as-read (CONVERSATION_ORGANIZATION)
  • POST api/iris/chat/sessions/current (IRIS_CHAT)
  • POST api/iris/tutor-suggestion/posts/{postId}/sessions/current (IRIS_TUTOR_SUGGESTIONS)
  • PUT api/notification/courses/{courseId}/seen (COURSE_NOTIFICATIONS)

Counted as system calls​

  • GET .well-known/apple-app-site-association (MOBILE_APPS)
  • GET .well-known/assetlinks.json (MOBILE_APPS)
  • GET .well-known/jwks.json (LTI)
  • GET api/core/sharing/config (SHARING_PLATFORM)
  • GET api/core/sharing/config/is-enabled (SHARING_PLATFORM)
  • GET api/localci/public/programming-exercises/{exerciseId}/build-plan (PROGRAMMING_BUILD_CONFIGURATION)
  • GET api/localvc/public/observed-client-address (BUILD_AGENTS)
  • GET api/programming/sharing/export/{token} (SHARING_PLATFORM)
  • POST api/programming/public/programming-exercises/new-result (PROGRAMMING_RESULTS)
Search documentation