arrow-left

All pages
gitbookPowered by GitBook
1 of 18

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

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.

ListArtifacts

List all Artifacts visible to a user

circle-info

This endpoint does not require authentication

RetrieveArtifactVersionContents

A shortcut for retrieving contents.

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

hashtag
Required token scope

  • artifacts:read

CreateArtifactVersion

Create a new version of an existing artifact

hashtag
Required token scope

  • artifacts:read

  • artifacts:write

GetArtifact

Get metadata for a single Artifact

hashtag
Required token scope

  • artifacts:read

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.

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.

DeleteArtifactVersion

Delete an existing Artifact Version

circle-info

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

hashtag
Required token scope

  • artifacts:read

  • artifacts:write

GetArtifactVersionMigrationStatus

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

hashtag
Required token scope

  • artifacts:read

ListArtifactRoles

List roles available on an artifact

circle-info

Roles are also visible on the models returned by GetArtifact and ListArtifacts.

hashtag
Required token scope

  • artifacts:read

Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples

MigrateArtifactVersion

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

circle-info

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

circle-info

Only one migration can be in progress at a time.

hashtag
Required token scope

  • artifacts:write

Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples

IncrArtifactVersionMetric

circle-info

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

circle-info

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.

hashtag
Required token scope (origin)

  • artifacts:read

hashtag
Required token scope (access_token)

  • artifacts:write_metrics

CreateArtifact

Create a brand new Artifact

hashtag
Required token scope

  • artifacts:read

  • artifacts:write

Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples

Artifacts

View, Modify, Create, and Delete Artifact metadata

Logo
Logo
Logo
Logo
Logo

Artifact Roles

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

hashtag
Administrator

Administrators have full control over the artifact, including assigning and unassigning roles. Administrators may upload, download, delete, and change content as they see fit.

circle-info

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 .

hashtag
Collaborator

Collaborators have permission to edit artifact metadata, upload new versions, and share private artifacts.

UpdateArtifact
Logo
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Logo
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Logo
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Logo

UpdateArtifact

Update metadata of an existing Artifact

circle-info

UpdateArtifact requests use the JSON Patcharrow-up-right syntax. All operations except test are supported.

circle-info

Both PATCH and PUT requests are supported, but PUT requests require the partial URL argument to be set.

hashtag
Required token scope

  • artifacts:read

  • artifacts:write

AssignArtifactRole

Assign a new artifact role to a user

hashtag
Required token scope

  • artifacts:write

UnassignArtifactRole

Unassign a role from a user on an artifact

hashtag
Required token scope

  • artifacts:write

Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Logo
Trovi APItrovi.chameleoncloud.orgchevron-right
Write schema and examples
Logo
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Logo
Trovi APItrovi.chameleoncloud.orgchevron-right
View schema and examples
Logo