Metax API Documentation

Metax API Contents:

• 1. Metax API
• 2. Quick Start
  • 2.1. Fairdata Services
  • 2.2. End Users
• 3. General API Information
  • 3.1. Swagger
  • 3.2. Metax Data Model: A High Level View
  • 3.3. Relation of models in API to models in tietomallit.suomi.fi
  • 3.4. API versioning
  • 3.5. API Authentication
  • 3.6. Character encodings
  • 3.7. Behaviour of POST vs. PUT
  • 3.8. Return codes
  • 3.9. Last-Modified header in API responses
  • 3.10. Error Reporting
  • 3.11. Describing relations in objects
  • 3.12. Retrieving deleted objects
  • 3.13. Conditional Updates
• 4. End User Access
  • 4.1. Authentication
• 5. List operations
  • 5.1. Retrieve operations (GET)
    • 5.1.1. Pagination
    • 5.1.2. Streaming
  • 5.2. Create operations (POST)
  • 5.3. Bulk update (PUT and PATCH)
  • 5.4. Bulk delete
  • 5.5. Atomic Bulk Operations
• 6. Datasets API
  • 6.1. General
    • 6.1.1. Data model visualization
    • 6.1.2. Dataset schemas
      • 6.1.2.1. Common schema validation errors
    • 6.1.3. Terminology
    • 6.1.4. Data Catalogs
    • 6.1.5. Choosing the right Data Catalog
    • 6.1.6. Dataset lifecycle in Metax
    • 6.1.7. Read-only metadata fields
    • 6.1.8. End User API: Writable fields
  • 6.2. If-Modified-Since header in dataset API
  • 6.3. Dataset versioning
    • 6.3.1. General
    • 6.3.2. Restrictions in old versions
    • 6.3.3. Browsing a dataset’s versions
  • 6.4. Uniqueness of datasets
  • 6.5. Describing files vs. adding and removing files
  • 6.6. Using an existing dataset as a template
  • 6.7. Reference data guide
    • 6.7.1. About ResearchAgent, Organization, and Person
    • 6.7.2. Reference data table
  • 6.8. Examples
    • 6.8.1. Retrieve minimal valid dataset template
    • 6.8.2. Creating datasets
    • 6.8.3. Retrieving datasets
    • 6.8.4. Updating datasets
      • 6.8.4.1. Update metadata
      • 6.8.4.2. Update files
    • 6.8.5. Deleting datasets
    • 6.8.6. Browsing a dataset’s files
    • 6.8.7. Using reference data
      • 6.8.7.1. Add a directory
• 7. Files API
  • 7.1. General
  • 7.2. File Storages and Projects
  • 7.3. File hierarchy
  • 7.4. End User Editable File Fields
  • 7.5. Browsing files in Metax
  • 7.6. Reference data guide
  • 7.7. Examples
    • 7.7.1. Creating files
    • 7.7.2. Browsing files
• 8. Reference Data
  • 8.1. Reference Data Indexes
  • 8.2. How to use reference data when uploading data to Metax?
  • 8.3. Querying Reference Data
  • 8.4. Reference data validation errors
  • 8.5. How often is the reference data updated?

Indices and tables

• Index

• Module Index

• Search Page