Sign in

v1

latestOpenAPI 3.0.02026-07-17101229.1 KB
GA4GH

List one specific tool, acts as an anchor for self references

This endpoint returns one specific tool (which has ToolVersions nested inside it).

get/tools/{id}

Path parameters

idstring required

A unique identifier of the tool, scoped to this registry, for example 123456.

Response

A tool.

urlstring required

The URL for this tool in this registry.

idstring required

A unique identifier of the tool, scoped to this registry.

aliasesstring[]

Support for this parameter is optional for tool registries that support aliases. A list of strings that can be used to identify this tool which could be straight up URLs. This can be used to expose alternative ids (such as GUIDs) for a tool for registries. Can be used to match tools across registries.

organizationstring required

The organization that published the image.

namestring

The name of the tool.

descriptionstring

The description of the tool.

meta_versionstring

The version of this tool in the registry. Iterates when fields like the description, author, etc. are updated.

has_checkerboolean

Whether this tool has a checker tool associated with it.

checker_urlstring

Optional url to the checker tool that will exit successfully if this tool produced the expected result given test data.

Example response

{
  "url": "http://agora.broadinstitute.org/tools/123456",
  "versions": [
    {
      "url": "http://agora.broadinstitute.org/tools/123456/versions/1",
      "id": "v1",
      "images": [
        {
          "checksum": [
            {
              "checksum": "77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182",
              "type": "sha256"
            }
          ]
        }
      ],
      "included_apps": [
        "https://bio.tools/tool/mytum.de/SNAP2/1",
        "https://bio.tools/bioexcel_seqqc"
      ]
    }
  ]
}
All 10 operations