GuidesAPIDatasets HubRelease Notes
API Reference
CGC

Get details of a project

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

/projects/{project_owner}/{project}

This call returns the details of a specified project.

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

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 short name. For full details of identifying objects using the API, please see the API overview.

GET /v2/projects/rfranklin/rfranklin-s-demo-project 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 "http://cgc-api.sbgenomics.com/v2/projects/rfranklin/rfranklin-s-demo-project"

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

This example response body displays the JSON returned when the fields parameter in the request is set to _all.

{
  "href": "http://cgc-api.sbgenomics.com/v2/projects/rfranklin/rfranklin-s-demo-project",
  "id": "rfranklin/rfranklin-s-demo-project",
  "name": "rfranklin's Demo Project",
  "type": "v2",
  "description": "This project contains data, completed analyses, and results.\n\Contains WGS, WES, and two different RNA-Seq read alignments - STAR and TopHat, fusion transcript detection analysis using ChimeraScan, FASTQ quality control and more.\n\n Open it up and  take a look.",
  "tags": [],
  "settings": {
    "locked": false,
    "controlled": true,
    "use_interruptible_instances": false,
    "use_memoization": true,
    "allow_network_access": true,
    "intermediate_files": {
      "retention":"LIMITED",
      "duration":24
     }
  },
  "permissions": {
    "write": true,
    "read": true,
    "copy": true,
    "execute": true,
    "admin": true
  },
  "billing_group": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7"
}

Interpreting the response body

  • The object type in the response should be ignored: all projects have type v2.
  • The object tags is an array that either contains the string "tcga" or is empty. If it contains "tcga" this indicates that the project is a Controlled Data project. Otherwise, the project is Open Data.
  • The dictionary settings contains two Boolean field, locked and controlled. The locked field shows whether or not your project is locked. You can lock down a project to prevent any Seven Bridges team member from viewing information about your project. Learn more about creating a locked project. The controlled field indicates whether or not the project is a controlled data project.
Language