/
SO
sormas-foundation
/
SORMAS REST API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 8m ago · Updated 5h ago
latest
OpenAPI 3.0.1
GPL v3
raw.githubusercontent.com
2026-08-17
367
309
796.2 KB
1a431d1eaa93
Action Controller
6
get
/actions/all/{since}
post
/actions/indexActionList
post
/actions/indexEventActionList
post
Create or update one or multiple entities.
post
/actions/query
get
/actions/uuids
Additional Test Controller
6
get
/additionaltests/all/{since}
get
/additionaltests/all/{since}/{size}/{lastSynchronizedUuid}
post
/additionaltests/indexList
post
Create or update one or multiple entities.
post
/additionaltests/query
get
/additionaltests/uuids
Aggregate Report Controller
5
get
/aggregatereports/all/{since}
post
/aggregatereports/indexList
post
Create or update one or multiple entities.
post
/aggregatereports/query
get
/aggregatereports/uuids
Area Controller
3
get
/areas/all/{since}
post
/areas/query
get
/areas/uuids
B A G Export Controller
2
get
/bagexport/cases
get
/bagexport/contacts
Campaign Controller
3
get
/campaigns/all/{since}
post
/campaigns/query
get
/campaigns/uuids
Campaign Form Data Controller
4
get
/campaignFormData/all/{since}
post
Create or update one or multiple entities.
post
/campaignFormData/query
get
/campaignFormData/uuids
Campaign Form Meta Controller
3
get
/campaignFormMeta/all/{since}
post
/campaignFormMeta/query
get
/campaignFormMeta/uuids
Case Controller
21
get
/cases/all/{since}
get
/cases/all/{since}/{size}/{lastSynchronizedUuid}
get
/cases/archived/{since}
post
/cases/caseFollowUpIndexList
post
/cases/delete
get
/cases/deleted/{since}
post
/cases/detailedIndexList
post
/cases/externalData
post
/cases/getduplicates
post
/cases/getduplicates/{reportDateThreshold}
post
/cases/indexList
get
/cases/obsolete/{since}
post
/cases/postUpdate/{uuid}
post
Create or update one or multiple entities.
post
/cases/push-detailed
post
/cases/pushWithPerson
post
/cases/query
post
/cases/query/persons
post
/cases/specificCase/{searchTerm}
get
/cases/uuids
get
/cases/{uuid}
Classification Controller
1
get
/classification/all/{since}
Clinical Visit Controller
6
get
/clinicalvisits/all/{since}
get
/clinicalvisits/all/{since}/{size}/{lastSynchronizedUuid}
post
/clinicalvisits/indexList
post
Create or update one or multiple entities.
post
/clinicalvisits/query
get
/clinicalvisits/uuids
Community Controller
7
get
/communities/all/{since}
post
/communities/archive
post
/communities/dearchive
post
/communities/indexList
post
Create or update one or multiple entities.
post
/communities/query
get
/communities/uuids
Contact Controller
15
get
/contacts/all/{since}
get
/contacts/all/{since}/{size}/{lastSynchronizedUuid}
get
/contacts/archived/{since}
post
/contacts/delete
get
/contacts/deleted/{since}
post
/contacts/detailedIndexList
post
/contacts/externalData
post
/contacts/indexList
get
/contacts/obsolete/{since}
post
Create or update one or multiple entities.
post
/contacts/pushWithPerson
post
/contacts/query
post
/contacts/query/persons
get
/contacts/uuids
get
/contacts/{uuid}
Continent Controller
7
get
/continents/all/{since}
post
/continents/archive
post
/continents/dearchive
post
/continents/indexList
post
Create or update one or multiple entities.
post
/continents/query
get
/continents/uuids
Country Controller
7
get
/countries/all/{since}
post
/countries/archive
post
/countries/dearchive
post
/countries/indexList
post
Create or update one or multiple entities.
post
/countries/query
get
/countries/uuids
Customizable Enum Value Controller
3
get
/customizableenumvalues/all/{since}
post
/customizableenumvalues/query
get
/customizableenumvalues/uuids
Customizable Field Metadata Controller
12
get
/customizablefieldmetadata/all
get
/customizablefieldmetadata/byname
get
/customizablefieldmetadata/context/{contextClass}
post
/customizablefieldmetadata/save
get
/customizablefieldmetadata/uigroup/{uiGroup}
get
/customizablefieldmetadata/{uuid}
put
/customizablefieldmetadata/{uuid}
delete
/customizablefieldmetadata/{uuid}
post
/customizablefieldmetadata/{uuid}/activate
post
/customizablefieldmetadata/{uuid}/clone
post
/customizablefieldmetadata/{uuid}/deactivate
get
/customizablefieldmetadata/{uuid}/exists
Customizable Field Value Controller
8
get
/customizablefieldvalue/all
get
/customizablefieldvalue/entity/{entityUuid}
delete
/customizablefieldvalue/entity/{entityUuid}
post
/customizablefieldvalue/entity/{entityUuid}/save
post
/customizablefieldvalue/save
get
/customizablefieldvalue/{uuid}
put
/customizablefieldvalue/{uuid}
delete
/customizablefieldvalue/{uuid}
Dashboard Controller
14
post
/dashboard/caseMeasurePerDistrict
post
/dashboard/contacts
post
/dashboard/diseaseBurden
post
/dashboard/epiCurveDataPerCaseClassification
post
/dashboard/epiCurveDataPerPresentCondition
post
/dashboard/epiCurveElementsContactClassification
post
/dashboard/epiCurveElementsContactFollowUpStatus
post
/dashboard/epiCurveElementsContactFollowUpUntil
post
/dashboard/loadMapCaseData
post
/dashboard/loadMapContactData
post
/dashboard/loadMapEventData
post
/dashboard/newCases
post
/dashboard/newEvents
post
/dashboard/testResults
Disease Configuration Controller
5
get
/diseaseconfigurations/all/{since}
get
/diseaseconfigurations/diseaseNames
get
/diseaseconfigurations/diseaseVariants
post
/diseaseconfigurations/query
get
/diseaseconfigurations/uuids
District Controller
7
get
/districts/all/{since}
post
/districts/archive
post
/districts/dearchive
post
/districts/indexList
post
Create or update one or multiple entities.
post
/districts/query
get
/districts/uuids
Document Controller
2
post
/documents/entityDocuments
get
/documents/{uuid}
Entity Dto Controller
1
post
Create or update one or multiple entities.
Environment Controller
7
get
/environments/all/{since}
get
/environments/all/{since}/{size}/{lastSynchronizedUuid}
get
/environments/obsolete/{since}
post
Create or update one or multiple entities.
post
/environments/query
get
/environments/uuids
get
/environments/{uuid}
Environment Sample Controller
4
get
/environmentsamples/all/{since}/{size}/{lastSynchronizedUuid}
get
/environmentsamples/obsolete/{since}
post
/environmentsamples/query
get
/environmentsamples/uuids
Event Controller
14
get
/events/all/{since}
get
/events/all/{since}/{size}/{lastSynchronizedUuid}
get
/events/archived/{since}
post
/events/children
post
/events/delete
get
/events/deleted/{since}
post
/events/externalData
post
/events/indexList
get
/events/obsolete/{since}
post
Create or update one or multiple entities.
post
/events/query
get
/events/specificEvent/{searchTerm}
get
/events/uuids
get
/events/{uuid}
Event Group Controller
6
post
/eventGroups/indexList
post
Create or update one or multiple entities.
get
/eventGroups/{uuid}
delete
/eventGroups/{uuid}
post
/eventGroups/{uuid}/linkEvents
post
/eventGroups/{uuid}/unlinkEvent
Event Participant Controller
12
get
/eventparticipants/all/{since}
get
/eventparticipants/all/{since}/{size}/{lastSynchronizedUuid}
get
/eventparticipants/archived/{since}
get
/eventparticipants/deleted/{since}
post
/eventparticipants/indexList
get
/eventparticipants/obsolete/{since}
post
Create or update one or multiple entities.
post
/eventparticipants/query
post
/eventparticipants/query/events
post
/eventparticipants/query/persons
get
/eventparticipants/uuids
get
/eventparticipants/{uuid}
External Surveillance Tool Gateway Controller
2
post
/external-surveillance/share/cases
post
/external-surveillance/share/events
External Visits Controller
6
post
Save visits
get
Get follow up end dates
get
Get person information
get
Check person validity
post
Save symptom journal status
get
Get API version
Facility Controller
8
post
/facilities/archive
post
/facilities/dearchive
get
/facilities/general/{since}
post
/facilities/indexList
post
Create or update one or multiple entities.
post
/facilities/query
get
/facilities/region/{regionUuid}/{since}
get
/facilities/uuids
Feature Configuration Controller
4
get
/featureconfigurations/all/{since}
get
/featureconfigurations/deleted/{since}
post
/featureconfigurations/query
get
/featureconfigurations/uuids
Immunization Controller
17
get
/immunizations/all/{since}
get
/immunizations/all/{since}/{size}/{lastSynchronizedUuid}
get
/immunizations/archived/{since}
post
/immunizations/createVaccination
post
/immunizations/delete
get
/immunizations/deleted/{since}
post
/immunizations/indexList
get
/immunizations/obsolete/{since}
post
Create or update one or multiple entities.
post
/immunizations/query
post
/immunizations/query/persons
get
/immunizations/uuids
post
/immunizations/vaccination/postUpdate/{uuid}
post
/immunizations/vaccination/push
get
/immunizations/vaccination/{uuid}
post
/immunizations/vaccinations
get
/immunizations/{uuid}
Info Controller
5
get
/info/appurl
get
/info/checkcompatibility
get
/info/countryname
get
/info/locale
get
/info/version
Infrastructure Controller
1
post
/infrastructure/sync
Lab Message Controller
2
post
/labmessages/indexList
get
/labmessages/{uuid}
Line Listing Controller
4
post
/lineListing/delete
post
/lineListing/enabled
post
/lineListing/indexList
post
/lineListing/push
Outbreak Controller
5
get
/outbreaks/active/{since}
get
/outbreaks/inactive/{since}
post
/outbreaks/indexList
post
Create or update one or multiple entities.
get
/outbreaks/uuids
Pathogen Test Controller
8
get
/pathogentests/all/{since}
get
/pathogentests/all/{since}/{size}/{lastSynchronizedUuid}
get
/pathogentests/deleted/{since}
post
/pathogentests/indexList
post
Create or update one or multiple entities.
post
/pathogentests/query
post
/pathogentests/query/samples
get
/pathogentests/uuids
Person Controller
10
get
/persons/all/{since}
get
/persons/all/{since}/{size}/{lastSynchronizedUuid}
post
/persons/externalData
post
/persons/indexList
post
Create or update one or multiple entities.
post
/persons/query
post
/persons/query/byExternalIds
post
/persons/similarPersons
get
/persons/uuids
get
/persons/{uuid}
Point Of Entry Controller
7
get
/pointsofentry/all/{since}
post
/pointsofentry/archive
post
/pointsofentry/dearchive
post
/pointsofentry/indexList
post
Create or update one or multiple entities.
post
/pointsofentry/query
get
/pointsofentry/uuids
Prescription Controller
6
get
/prescriptions/all/{since}
get
/prescriptions/all/{since}/{size}/{lastSynchronizedUuid}
post
/prescriptions/indexList
post
Create or update one or multiple entities.
post
/prescriptions/query
get
/prescriptions/uuids
Region Controller
7
get
/regions/all/{since}
post
/regions/archive
post
/regions/dearchive
post
/regions/indexList
post
Create or update one or multiple entities.
post
/regions/query
get
/regions/uuids
Sample Controller
11
get
/samples/all/{since}
get
/samples/all/{since}/{size}/{lastSynchronizedUuid}
post
/samples/delete
get
/samples/deleted/{since}
post
/samples/indexList
get
/samples/obsolete/{since}
post
Create or update one or multiple entities.
post
/samples/query
post
/samples/query/cases
get
/samples/uuids
get
/samples/{uuid}
Share Request Controller
2
post
/sharerequests/indexList
get
/sharerequests/{uuid}
Sormas To Sormas Controller
20
post
/sormasToSormas/cases
post
/sormasToSormas/cases/request
post
/sormasToSormas/cases/request/data
post
/sormasToSormas/cases/shares
post
/sormasToSormas/cases/sync
get
/sormasToSormas/cert
post
/sormasToSormas/contacts
post
/sormasToSormas/contacts/request
post
/sormasToSormas/contacts/request/data
post
/sormasToSormas/contacts/shares
post
/sormasToSormas/contacts/sync
post
/sormasToSormas/events
post
/sormasToSormas/events/request
post
/sormasToSormas/events/request/data
post
/sormasToSormas/events/shares
post
/sormasToSormas/events/sync
post
/sormasToSormas/externalmessages
post
/sormasToSormas/reject-requests
post
/sormasToSormas/request/accepted
post
/sormasToSormas/revoke-requests
Subcontinent Controller
7
get
/subcontinents/all/{since}
post
/subcontinents/archive
post
/subcontinents/dearchive
post
/subcontinents/indexList
post
Create or update one or multiple entities.
post
/subcontinents/query
get
/subcontinents/uuids
Surveillance Report Controller
2
post
Create or update one or multiple entities.
post
/surveillancereports/query/cases
Task Controller
10
get
/tasks/all/{since}
get
/tasks/all/{since}/{size}/{lastSynchronizedUuid}
get
/tasks/archived/{since}
post
/tasks/delete
post
/tasks/indexList
get
/tasks/obsolete/{since}
post
Create or update one or multiple entities.
post
/tasks/query
get
/tasks/uuids
get
/tasks/{uuid}
Travel Entry Controller
4
post
/travelentries/indexList
post
Create or update one or multiple entities.
get
/travelentries/{uuid}
delete
/travelentries/{uuid}
Treatment Controller
6
get
/treatments/all/{since}
get
/treatments/all/{since}/{size}/{lastSynchronizedUuid}
post
/treatments/indexList
post
Create or update one or multiple entities.
post
/treatments/query
get
/treatments/uuids
User Controller
8
get
/users/all/{since}
post
/users/indexList
post
/users/query
get
/users/rights
get
/users/rights/{uuid}
post
/users/userReferenceWithNoOfTask
get
/users/uuids
get
/users/{uuid}
User Role Controller
3
get
/userroles/all/{since}
get
/userroles/deleted/{since}
get
/userroles/uuids
Visit Controller
6
get
/visits/all/{since}
get
/visits/all/{since}/{size}/{lastSynchronizedUuid}
post
/visits/indexList
post
Create or update one or multiple entities.
post
/visits/query
get
/visits/uuids
Weekly Report Controller
5
get
/weeklyreports/all/{since}
get
/weeklyreports/all/{since}/{size}/{lastSynchronizedUuid}
post
Create or update one or multiple entities.
post
/weeklyreports/query
get
/weeklyreports/uuids
Action Controller
get
/actions/all/{since}
Path parameters
since
integer
required
Response
default response