Chapter 28. The BASE API
Prev
Part IV. Developer documentation
Next
Chapter 28. The BASE API
Table of Contents
28.1. The Public API of BASE
28.1.1. What is backwards compatibility?
Binary compatibility
Contract compatibility
Source code compatibility
28.2. The Data Layer API
28.2.1. Basic classes and interfaces
Classes
Interfaces
28.2.2. User authentication and access control
Users and passwords
Groups, roles, projects and permission template
Keys
Permissions
28.2.3. Reporters
Reporters
Reporter lists
28.2.4. Quota and disk usage
Quota
Disk usage
28.2.5. Client, session and settings
Clients
Sessions
Settings
28.2.6. Files and directories
28.2.7. Experimental platforms and item subtypes
Platforms
Item subtypes
FileStoreEnabled items and data files
28.2.8. Parameters
28.2.9. Annotations
Annotations
Annotation types
Units
Categories
28.2.10. Protocols, hardware and software
Protocols
Parameters
Hardware and software
28.2.11. Plug-ins, jobs and job agents
Plug-ins
Jobs
Job agents
28.2.12. Biomaterial LIMS
Biomaterials
Bioplates and plate types
Biomaterial and plate events
28.2.13. Array LIMS - plates
Plates
Plate events
Plate mappings
28.2.14. Array LIMS - arrays
Array designs
Array slides
28.2.15. Bioassays and raw data
Physical bioassays
Raw data
Spot images
28.2.16. Experiments and analysis
Experiments
Bioassay sets, bioassays and transformations
Virtual databases, datacubes, etc.
The dynamic database
28.2.17. Other classes
28.3. The Core API
28.3.1. Authentication and sessions
28.3.2. Access permissions
28.3.3. Data validation
28.3.4. Transaction handling
28.3.5. Create/read/write/delete operations
28.3.6. Batch operations
28.3.7. Quota
28.3.8. Plugin execution / job queue
28.3.9. Using files to store data
Diagram of classes and methods
Use case: Asking the user for files for a given item
Use case: Link, validate and extract metadata from the selected files
Use case: Import data into the database
Use case: Using raw data from files in an experiment
28.3.10. Sending signals (to plug-ins)
Diagram of classes and methods
28.4. The Query API
28.5. The Dynamic API
28.6. The Extensions API
28.6.1. The core part
28.6.2. The web client part
28.7. Other useful classes and methods