GuidesAPIDatasets HubRelease Notes
API Reference
CGC

List tasks in a project (secondary method)

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

/projects/{project_owner}/{project}/tasks

This call lists the tasks in the specified project. It is an alias for the call GET tasks and redirects to that path. 

https://cgc-api.sbgenomics.com/v2/projects/{project_owner}/{project}/tasks

❗️

Alias call

Note that since this is an alias for another call, the call cannot be made straightforwardly from all applications. In particular, to send the call using cURL, use the cURL option -L to redirect the path of this call to https://cgc-api.sbgenomics.com/v2/files?project={project_owner}/{project.

Alternatively, to list all files, you can simply use the call GET tasks.

Request

Example request

👍

Referring to your project

Note that project_owner is always case-sensitive, and that project is not the project's name but its ID, or short name. For full details of identifying objects using the API, please see the API overview.

GET /v2/projects/RFranklin/my-project/tasks HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl -L "https://cgc-api.sbgenomics.com/v2/tasks?project=RFranklin/my-project"  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/projects/RFranklin/my-project/tasks"

Header Fields

NameDescription
X-SBG-Auth-Token
required		Your CGC authentication token.

Path parameters

NameDescription
projectThe short name of the project you are querying.
project_ownerThe owner of the project you are querying.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

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/tasks?offset=0&limit=25&project=RFranklin/my-project",
  "items": [
    {
      "href": "https://cgc-api.sbgenomics.com/v2/tasks/39bc3d6a-6cf6-4f8f-b550-21e9633c1f4b",
      "id": "39bc3d6a-6cf6-4f8f-b550-21e9633c1f4b",
      "name": "test run - 12-11-15 11:02:03",
      "project": "RFranklin/my-project"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/tasks/db72b963-be8c-4e9c-9d71-6eb71ed22226",
      "id": "db72b963-be8c-4e9c-9d71-6eb71ed22226",
      "name": "test run - 12-11-15 11:52:45",
      "project": "RFranklin/my-project"
    }
  ],
  "links": []
}
{
  "href": "https://cgc-api.sbgenomics.com/v2/tasks/?offset=0&limit=25&project=RFranklin/my-project",
  "items": [
    {
      "href": "https://cgc-api.sbgenomics.com/v2/tasks/39bc3d6a-6cf6-4f8f-b550-21e9633c1f4b",
      "id": "39bc3d6a-6cf6-4f8f-b550-21e9633c1f4b",
      "name": "test run - 12-11-15 11:02:03",
      "project": "RFranklin/my-project"
    },
    {
      "href": "https://cgc-api.sbgenomics.com/v2/tasks/db72b963-be8c-4e9c-9d71-6eb71ed22226",
      "id": "db72b963-be8c-4e9c-9d71-6eb71ed22226",
      "name": "test run - 12-11-15 11:52:45",
      "project": "RFranklin/my-project"
    }
  ],
  "links": []
}
Language