Swagger UI

METAX API

v2

[ Base URL: metax.fairdata.fi ]

Schemes

File Storage API

GET/rest/v2/filestorages

List File Storages

POST/rest/v2/filestorages

Create File Storage metadata

GET/rest/v2/filestorages/{PID}

Get File Storage metadata

PUT/rest/v2/filestorages/{PID}

Replace File Storage metadata

PATCH/rest/v2/filestorages/{PID}

Partially replace File Storage metadata

DELETE/rest/v2/filestorages/{PID}

Delete File Storage metadata

File API

GET/rest/v2/files

Get list of files

POST/rest/v2/files

Create new file metadata

PUT/rest/v2/files

Bulk update

PATCH/rest/v2/files

Bulk update partial

DELETE/rest/v2/files

Bulk delete

GET/rest/v2/files/{PID}

Get file metadata

PUT/rest/v2/files/{PID}

Replace file metadata

PATCH/rest/v2/files/{PID}

Replace part of file metadata

DELETE/rest/v2/files/{PID}

Delete a file

GET/rest/v2/files/{PID}/XML

Get XML metadata from file

POST/rest/v2/files/{PID}/XML

Create new XML metadata

PUT/rest/v2/files/{PID}/XML

Update XML metadata

DELETE/rest/v2/files/{PID}/XML

Delete XML metadata

POST/rest/v2/files/datasets

Get datasets where files belong to

POST/rest/v2/files/restore

Restore removed files back to "not removed" state.

GET/rest/v2/directories/{PID}

Get details of a directory

GET/rest/v2/directories/{PID}/files

Get list of files and directories contained by a directory

GET/rest/v2/directories/files

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

GET/rest/v2/directories/root

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

POST/rest/v2/files/sync_from_v3

Synchronize files from Metax V3

Data Catalog API

GET/rest/v2/datacatalogs

List of data catalogs

POST/rest/v2/datacatalogs

Create new data catalog

GET/rest/v2/datacatalogs/{PID}

Get data catalog metadata

PUT/rest/v2/datacatalogs/{PID}

Replace data catalog metadata

PATCH/rest/v2/datacatalogs/{PID}

Replace part of catalog metadata

DELETE/rest/v2/datacatalogs/{PID}

Delete catalog metadata

Dataset API

GET/rest/v2/datasets

List datasets

POST/rest/v2/datasets

Create new dataset metadata

PUT/rest/v2/datasets

Bulk update

PATCH/rest/v2/datasets

Bulk update partial

DELETE/rest/v2/datasets

Bulk delete

GET/rest/v2/datasets/identifiers

List all dataset identifiers

GET/rest/v2/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/v2/datasets/{PID}

Get dataset metadata.

PUT/rest/v2/datasets/{PID}

Replace dataset metadata.

PATCH/rest/v2/datasets/{PID}

Replace part of dataset metadata.

DELETE/rest/v2/datasets/{PID}

Delete dataset.

GET/rest/v2/datasets/{PID}/files

Get list of all files in a dataset and their technical metadata.

POST/rest/v2/datasets/{PID}/files

Add files to a dataset or exclude files from a dataset.

GET/rest/v2/datasets/{PID}/files/{FILE_PID}

Get technical metadata of a single file in a dataset.

PUT/rest/v2/datasets/{PID}/files/user_metadata

Update or remove user metadata of files in dataset.

PATCH/rest/v2/datasets/{PID}/files/user_metadata

Partially update or remove user metadata of files in dataset.

GET/rest/v2/datasets/{PID}/files/{FILE_PID}/user_metadata

Retrieve user metadata of a single file or a directory in a dataset.

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

List old research_dataset entries of a record

GET/rest/v2/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

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

Editorpermission marked as removed

Contract API

GET/rest/v2/contracts

List contracts

POST/rest/v2/contracts

Create new contract metadata

GET/rest/v2/contracts/{PID}

Get contract metadata

PUT/rest/v2/contracts/{PID}

Replace contract metadata

PATCH/rest/v2/contracts/{PID}

Replace part of contract metadata

DELETE/rest/v2/contracts/{PID}

Delete contract metadata

POST/rest/v2/contracts/sync_from_v3

Synchronize contracts from Metax V3

ApiErrors API

GET/rest/v2/apierrors

List errors produced during api requests

GET/rest/v2/apierrors/{identifier}

Get details of a single error entry

DELETE/rest/v2/apierrors/{identifier}

Delete a single error entry

POST/rest/v2/apierrors/flush

Delete all error entries

Schema API

GET/rest/v2/schemas

List schemas

GET/rest/v2/schemas/{name}

Get schema content

Dataset RPC

GET/rpc/v2/datasets/get_minimal_dataset_template

Get minimal dataset template.

POST/rpc/v2/datasets/change_cumulative_state

Change cumulative state of a dataset.

POST/rpc/v2/datasets/create_draft

Create draft of a published dataset.

POST/rpc/v2/datasets/merge_draft

Merge changes of a draft dataset back to the published dataset.

POST/rpc/v2/datasets/create_new_version

Create a new dataset version.

POST/rpc/v2/datasets/publish_dataset

Initial publish of a new dataset in draft state.

POST/rpc/v2/datasets/flush_user_data

Flushes user's datasets

Statistics RPC

GET/rpc/v2/statistics/count_datasets

Get the total number of datasets and file sizes.

GET/rpc/v2/statistics/all_datasets_cumulative

Get cumulative list of dataset information in given interval.

GET/rpc/v2/statistics/organization_datasets_cumulative

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

GET/rpc/v2/statistics/projects_summary

Get summary statistics of all projects or a single project.

GET/rpc/v2/statistics/organizations_summary

Get summary statistics of all organizations or a single project.

File RPC

POST/rpc/v2/files/delete_project

Deletes given project from the database.

POST/rpc/v2/files/flush_project

Flushes given project from the database.

Models

AddOrDeleteUserMetadata

AddOrExcludeFiles

CatalogRecord

DataCatalog

File