1 of 9

Artifact Versions

Create and Delete artifact versions

Artifacts have ordered versions to distinguish between changes over time. The version endpoints are how you can create a new version, or delete an existing one.

CreateArtifactVersion

Create a new version of an existing artifact

Required token scope

artifacts:read
artifacts:write

DeleteArtifactVersion

Delete an existing Artifact Version

Artifacts associated with a DOI (i.e. contents stored on Zenodo) CANNOT be deleted.

Required token scope

artifacts:read
artifacts:write

RetrieveArtifactVersionContents

A shortcut for retrieving contents.

Functions the same as , but requires the Artifact UUID and version slug for a faster lookup.

Required token scope

artifacts:read

Version Metrics

Version metrics describe the history of user interaction with Artifact Versions. There is presently 1 type of action: access_count. This describes the number of times an experiment has been launched by a different user. Client applications are responsible for properly notifying Trovi when these events happen.

IncrArtifactVersionMetric

Metrics can only be incremented by registered service applications. To register your application for this privilege, please get in touch with the Trovi developers.

The metrics endpoint is unique, in that callers must authenticate as the client application itself, and pass the user's token via the origin URL parameter. The reason for this is because we don't want users to be able to freely increment metrics as they please, so we only allow registered clients to do so, but we still require the user token in order to ensure that the user has permission to interact with the Artifact in the way that would increase the relevant metric.

Required token scope (origin)

artifacts:read

Required token scope (access_token)

artifacts:write_metrics

Version Migration

Migrate the stored content of an Artifact version to a different storage platform

Sometimes, users may wish to move their stored contents to a different platform (backend). We offer endpoints to accomplish this. One way we use this endpoint is to allow users to upload contents to our object storage, and then later allow users to request a DOI. When this happens, we migrate their content from the object storage backend to Zenodo.

MigrateArtifactVersion

Queue an artifact version's contents to be transferred to a different storage backend.

Performing a migration submits a migration task onto a queue, and receiving a successful response only means that your migration has been submitted, not that it is finished. To check on the status of your migration, use GetArtifactVersionMigrationStatus

Only one migration can be in progress at a time.

Required token scope

artifacts:write

GetArtifactVersionMigrationStatus

Check on the status of your most-recently-queued Artifact Version migration.

Required token scope

artifacts:read

IncrArtifactVersionMetric

Metrics can only be incremented by registered service applications. To register your application for this privilege, please get in touch with the Trovi developers.

Required token scope (origin)

artifacts:read

Required token scope (access_token)

artifacts:write_metrics