Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
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.
artifacts:read
artifacts:write_metrics
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.
artifacts:write
A shortcut for retrieving contents.
Functions the same as RetrieveContents, but requires the Artifact UUID and version slug for a faster lookup.
artifacts:read
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.
View, Modify, Create, and Delete Artifact metadata
Update metadata of an existing Artifact
UpdateArtifact requests use the JSON Patch syntax. All operations except test
are supported.
Both PATCH
and PUT
requests are supported, but PUT
requests require the partial
URL argument to be set.
artifacts:read
artifacts:write
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.
Trovi's permission model
Artifacts may have individual roles assigned to users which permit access control for those users. There are two types of role:
Administrator
Collaborator
Administrators have full control over the artifact, including assigning and unassigning roles. Administrators may upload, download, delete, and change content as they see fit.
Artifact owners are automatically assigned the Administrator role. This role cannot be unassigned from owners. In order to accomplish this, the owner must first be changed to someone else via UpdateArtifact.
Collaborators have permission to edit artifact metadata, upload new versions, and share private artifacts.
List roles available on an artifact
Roles are also visible on the models returned by GetArtifact and ListArtifacts.
artifacts:read
List all Artifacts visible to a user
This endpoint does not require authentication