SeqsLab TRS API

11/23/2021

API version v3

The Seqslab platform provides an efficient workflow tools management service based on the GA4GH Tool Registry Service (TRS) (external link) API Guidelines. Using workflow tools on SeqsLab ensures that the workflow tools can be executed in an accurate environment every time. SeqsLab also provides the corresponding sharing permissions according to the role assignment of different users.

TRS on SeqsLab

The SeqsLab TRS API implementation enables you to perform the following tasks:

  1. Assign role permissions for accessing the SeqsLab Tool Registry Service.

  2. Create, update, or delete APIs on your SeqsLab TRS instance.

  3. Upload or download tool files to or from your SeqsLab TRS instance.

TRS roles

The Seqslab platform provides different usage rights to create a standard and interoperable way to build and exchange workflows between users so that developers that build and contribute workflows to the community can be confident that other users working in very different environments can still run their own workflows.

To view the list of available roles, see Tool registry service (TRS) roles.

Note

SeqsLab does not automatically assign a TRS role to any user. A SeqsLab global administrator must specify the role assignments after adding users to the platform.

Use cases for the TRS API

There are 2 use cases for the TRS API on SeqsLab:

1. Register a new tool

To register a new tool on SeqsLab, you need to complete three steps:

  1. Determine the name and type of the tool.

  2. Identify the version ID of the tool and provide information about the images that will be used.

  3. Provide the tool files in a ZIP file and specify the corresponding relationships between each workflow and image.

2. Extend a new tool version

To extend a new tool version on SeqsLab, you need to get the corresponding tool ID of the tool that you want to extend, and then follow steps 2 and 3 of the tool registration process.