List all apps available to you

/apps

This call lists all the apps available to you.

https://cgc-api.sbgenomics.com/v2/apps

👍

Public/private apps

Note that you can see all of the publicly available apps on the CGC by setting the query parameter visibility to public. If you omit this parameter, you will see all your private apps, i.e. those in projects that you can access.

Request

Example request

GET /v2/apps HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/apps"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CGC authentication token.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

project

string

Enter a project, in the form {project_owner}/{project_short_name} to restrict the results to apps from that project only.

project_owner

string

Enter a CGC username to restrict the results to apps from that user's projects only. Note that you can only see apps within projects that you are a member of.

visibility

string

Set this to public to see all public apps on the CGC.

q

string

Enter one or more search terms to query apps using the q parameter. Learn more about querying below.

id

string

Use this parameter to query apps based on their ID.

Query apps

Use one or more search terms via the q parameter to query all apps that are available to you. An "and" operator is implied when using multiple search terms separated by a space. Further refine your query by specifying either the project containing the app or the project's owner.
Search terms should relate to the following app details:

  • name
  • label
  • toolkit
  • toolkit version
  • category
  • tagline
  • description

For the query to return results, each term must match at least one of the fields that describe an app. For example, the first term can match the app's name while the second can match the app description. However, if any part of the search fails to match app details, the query is returned as null.

Example requests for querying apps

Query apps by any of the search terms

Use search terms to query apps by including them after the app parameter, as shown below.

GET /v2/apps?q=WGS SBG RNA

Query apps in a specific project

Use search terms to query apps in a specific project by entering the terms and then specifying the project name, as shown below.

GET /v2/apps?q=WGS SBG&project=username/project-name

Query apps for a specific project owner
Use search terms to query apps belonging to a specific project owner by entering the terms and then specifying the name of the project owner, as shown below.

GET /v2/apps?q=WGS SBG&project_owner=username

Response

See a list of CGC-specific response codes that may be contained in the body of the response.

Example response body

{
  "href": "https://cgc-api.sbgenomics.com/v2/apps/",
  "items": [
    {
      "href": "https://cgc-api.sbgenomics.com/v2/apps/RFranklin/my-project/workflow",
      "id": "RFranklin/my-project/workflow",
      "name": "workflow"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/apps/RFranklin/my-project/fusion-transcript-detection-chimerascan",
      "id": "RFranklin/my-project/fusion-transcript-detection-chimerascan",
      "name": "fusion-transcript-detection-chimerascan"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/apps/RFranklin/my-project/somaticsniper-filters",
      "id": "RFranklin/my-project/somaticsniper-filters",
      "name": "somaticsniper-filters"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/apps/RFranklin/my-project/command-line-tool",
      "id": "RFranklin/my-project/command-line-tool",
      "name": "command-line-tool"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/apps/RFranklin/my-project/delly2-workflow",
      "id": "RFranklin/my-project/delly2-workflow",
      "name": "delly2-workflow"
    },
  ]
}
Language