API Reference
API Reference
API Methods
API Reference
This folder contains detailed documentation for various API endpoints available in the mDIS app. Below is an overview of all the available API documentation files:
API Endpoints
Logging in and out
- Auth Refresh: Refreshes user information and permissions.
Global Controller Methods
Works on object types that are not forms. (Data Models in particular)
- Global Index: Used to get a filtered list of a data model.
- Global Create: Used to create a new record of a data model.
- Global Update: Used to update an existing record of a data model.
- Global Delete: Used to delete a record of a data model.
- Global Duplicate: Used to duplicate a record while excluding certain fields.
- Global Defaults: Used to get the default values of a data model.
- Global Filter Lists: Retrieves the main filter components' lists.
- Global Reports: Retrieves available reports for a data model.
Form Controller Methods
- App Forms: Retrieves information about available forms.
- Form Index: Used to get a filtered list of a form data model.
- Form Create: Used to create a new record of a form data model.
- Form Update: Used to update an existing record of a form data model.
- Form Delete: Used to delete a record of a form data model.
- Form Duplicate: Used to duplicate a record of a form data model.
- Form Defaults: Used to get the default values of a form data model.
- Form Filter Lists: Retrieves the main filter components' lists for a form.
- Form Reports: Retrieves available reports for a form.
File Management
- File Index: Lists the files in the upload directory.
- File Assign: Assigns files to an expedition, site, hole, core, or section.
- File Upload: Uploads a file to the upload directory.
- File Meta Data: Retrieves metadata of a file in the upload directory.
- File Unassign: Unassigns a file from an entity.
Value Lists
- List Names: Provides the names of select lists.
- List Values: Lists the values for each select list.
High-level overview of the API - Back to the main API documentation page.