Metax API Documentation

Metax API:

• Metax API V1 Documentation
  • Metax API
  • Quick Start
    • Fairdata Services
    • End Users
  • General API Information
    • Swagger
    • Metax Data Model: A High Level View
    • Relation of models in API to models in tietomallit.suomi.fi
    • API versioning
    • API Authentication
    • Character encodings
    • Behaviour of POST vs. PUT
    • Return codes
    • Last-Modified header in API responses
    • Error Reporting
    • Describing relations in objects
    • Retrieving deleted objects
    • Conditional Updates
  • End User Access
    • Authentication
  • List operations
    • Retrieve operations (GET)
      • Pagination
      • Streaming
    • Create operations (POST)
    • Bulk update (PUT and PATCH)
    • Bulk delete
    • Atomic Bulk Operations
  • Datasets API
    • General
      • Data model visualization
      • Dataset schemas
        • Common schema validation errors
      • Terminology
      • Data Catalogs
      • Choosing the right Data Catalog
      • Dataset lifecycle in Metax
      • Read-only metadata fields
      • End User API: Writable fields
    • If-Modified-Since header in dataset API
    • Dataset versioning
      • General
      • Restrictions in old versions
      • Browsing a dataset’s versions
    • Uniqueness of datasets
    • Describing files vs. adding and removing files
    • Using an existing dataset as a template
    • Reference data guide
      • About ResearchAgent, Organization, and Person
      • Reference data table
    • Examples
      • Retrieve minimal valid dataset template
      • Creating datasets
      • Retrieving datasets
      • Updating datasets
        • Update metadata
        • Update files
      • Deleting datasets
      • Browsing a dataset’s files
      • Using reference data
        • Add a directory
  • Files API
    • General
    • File Storages and Projects
    • File hierarchy
    • End User Editable File Fields
    • Browsing files in Metax
    • Reference data guide
    • Examples
      • Creating files
      • Browsing files
  • Reference Data
    • Reference Data Indexes
    • How to use reference data when uploading data to Metax?
    • Querying Reference Data
    • Reference data validation errors
    • How often is the reference data updated?
  • Indices and tables
• Metax API V2 Documentation
  • Metax API
  • Quick Start
    • Fairdata Services
    • End Users
  • General API Information
    • Swagger
    • Metax Data Model: A High Level View
    • Relation of models in API to models in tietomallit.suomi.fi
    • API versioning
    • API Authentication
    • Character encodings
    • Behaviour of POST vs. PUT
    • Return codes
    • Last-Modified header in API responses
    • Error Reporting
    • Describing relations in objects
    • Retrieving deleted objects
    • Conditional Updates
  • End User Access
    • Authentication
  • List operations
    • Retrieve operations (GET)
      • Pagination
      • Streaming
    • Create operations (POST)
    • Bulk update (PUT and PATCH)
    • Bulk delete
    • Atomic Bulk Operations
  • Datasets API
    • General
      • Data model visualization
      • Dataset schemas
        • Common schema validation errors
      • Terminology
      • Data Catalogs
      • Choosing the right Data Catalog
      • Dataset lifecycle in Metax
      • Read-only metadata fields
      • End User API: Writable fields
    • If-Modified-Since header in dataset API
    • Dataset versioning
      • General
      • Browsing a dataset’s versions
    • Uniqueness of datasets
    • Using an existing dataset as a template
    • Reference data guide
      • About ResearchAgent, Organization, and Person
      • Reference data table
    • Examples
      • Retrieve minimal valid dataset template
      • Creating datasets
      • Retrieving datasets
      • Updating datasets
        • Update metadata
        • Working with files: Add and exclude files
        • Working with files: Updating user metadata
      • Deleting datasets
      • Publishing datasets
      • Creating a new version of a dataset
      • Browsing a dataset’s files
      • Using reference data
        • Add a directory
  • Files API
    • General
    • File Storages and Projects
    • File hierarchy
    • End User Editable File Fields
    • Browsing files in Metax
    • Reference data guide
    • Examples
      • Creating files
      • Browsing files
  • Reference Data
    • Reference Data Indexes
    • How to use reference data when uploading data to Metax?
    • Querying Reference Data
    • Reference data validation errors
    • How often is the reference data updated?
  • Indices and tables

Indices and tables

• Index

• Module Index

• Search Page