Swagger UI

METAX REST API

v1

[ Base URL: metax.demo.fairdata.fi ]

Schemes

File Storage API

GET/rest/filestorages

List File Storages

POST/rest/filestorages

Create File Storage metadata

GET/rest/filestorages/{PID}

Get File Storage metadata

PUT/rest/filestorages/{PID}

Replace File Storage metadata

PATCH/rest/filestorages/{PID}

Partially replace File Storage metadata

DELETE/rest/filestorages/{PID}

Delete File Storage metadata

File API

GET/rest/files

Get list of files

POST/rest/files

Create new file metadata

PUT/rest/files

Bulk update

PATCH/rest/files

Bulk update partial

DELETE/rest/files

Bulk delete

GET/rest/files/{PID}

Get file metadata

PUT/rest/files/{PID}

Replace file metadata

PATCH/rest/files/{PID}

Replace part of file metadata

DELETE/rest/files/{PID}

Delete a file

GET/rest/files/{PID}/XML

Get XML metadata from file

POST/rest/files/{PID}/XML

Create new XML metadata

PUT/rest/files/{PID}/XML

Update XML metadata

DELETE/rest/files/{PID}/XML

Delete XML metadata

POST/rest/files/datasets

Get datasets where files belong to

POST/rest/files/restore

Restore removed files back to "not removed" state.

GET/rest/directories/{PID}

Get details of a directory

GET/rest/directories/{PID}/files

Get list of files and directories contained by a directory

GET/rest/directories/files

Get list of files and directories contained by a directory, queried by dir path and project

GET/rest/directories/root

Return root directory for a project, and its files and directories

POST/rest/files/sync_from_v3

Synchronize files from Metax V3

Data Catalog API

GET/rest/datacatalogs

List of data catalogs

POST/rest/datacatalogs

Create new data catalog

GET/rest/datacatalogs/{PID}

Get data catalog metadata

PUT/rest/datacatalogs/{PID}

Replace data catalog metadata

PATCH/rest/datacatalogs/{PID}

Replace part of catalog metadata

DELETE/rest/datacatalogs/{PID}

Delete catalog metadata

Dataset API

GET/rest/datasets

List datasets

POST/rest/datasets

Create new dataset metadata

PUT/rest/datasets

Bulk update

PATCH/rest/datasets

Bulk update partial

DELETE/rest/datasets

Bulk delete

GET/rest/datasets/identifiers

List all dataset identifiers

GET/rest/datasets/unique_preferred_identifiers

List all unique dataset preferred identifiers

POST/rest/datasets/list

List datasets corresponding IDs or identifiers given in body

GET/rest/datasets/{PID}

Get dataset metadata

PUT/rest/datasets/{PID}

Replace dataset metadata

PATCH/rest/datasets/{PID}

Replace part of dataset metadata

DELETE/rest/datasets/{PID}

Delete dataset metadata

GET/rest/datasets/{PID}/files

Get list of files in a dataset

GET/rest/datasets/{PID}/metadata_versions

List old research_dataset entries of a record

GET/rest/datasets/{PID}/metadata_versions/{MVI}

Get contents of a specific old research_dataset of a record.

GET/rest/datasets/{CRID}/editor_permissions/users

List all editor permissions of a record

POST/rest/datasets/{CRID}/editor_permissions/users

Create a new editor permission of a record

GET/rest/datasets/{CRID}/editor_permissions/users/{USER_ID}

List all editor permissions of a record

PATCH/rest/datasets/{CRID}/editor_permissions/users/{USER_ID}

Update role or enable verified

DELETE/rest/datasets/{CRID}/editor_permissions/users/{USER_ID}

Editorpermission marked as removed

Contract API

GET/rest/contracts

List contracts

POST/rest/contracts

Create new contract metadata

GET/rest/contracts/{PID}

Get contract metadata

PUT/rest/contracts/{PID}

Replace contract metadata

PATCH/rest/contracts/{PID}

Replace part of contract metadata

DELETE/rest/contracts/{PID}

Delete contract metadata

POST/rest/contracts/sync_from_v3

Synchronize contracts from Metax V3

ApiErrors API

GET/rest/apierrors

List errors produced during api requests

GET/rest/apierrors/{identifier}

Get details of a single error entry

DELETE/rest/apierrors/{identifier}

Delete a single error entry

POST/rest/apierrors/flush

Delete all error entries

Schema API

GET/rest/schemas

List schemas

GET/rest/schemas/{name}

Get schema content

Dataset RPC

GET/rpc/datasets/get_minimal_dataset_template

Get minimal dataset template.

POST/rpc/datasets/set_preservation_identifier

Assign a preservation identifier value for a catalog record and return it

POST/rpc/datasets/refresh_directory_content

Search for new frozen files from directory and add them to dataset

POST/rpc/datasets/fix_deprecated

Fixes deprecated dataset

POST/rpc/datasets/flush_user_data

Flushes user's datasets

Statistics RPC

GET/rpc/statistics/count_datasets

Get the total number of datasets and file sizes.

GET/rpc/statistics/all_datasets_cumulative

Get cumulative list of dataset information in given interval.

GET/rpc/statistics/organization_datasets_cumulative

Get cumulative list of dataset information in given interval added by organizations.

GET/rpc/statistics/projects_summary

Get summary statistics of all projects or a single project.

GET/rpc/statistics/organizations_summary

Get summary statistics of all organizations or a single project.

File RPC

POST/rpc/files/delete_project

Deletes given project from the database.

POST/rpc/files/flush_project

Flushes given project from the database.

Models

CatalogRecord

DataCatalog

File