Get details of a project

/projects/{project_owner}/{project}

This call returns the details of a specified project.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/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.

HTTP

GET /v2/projects/rfranklin/my-project HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklinate/my-project"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your Platform authentication token.
X-sbg-advance-access optional	advance Use this field to return the ID of the project root folder. This field is a part of the advance access functionality for managing folders on the Seven Bridges Platform.

Path parameters

Name	Description
project	The short name of the project you are querying.
project_owner	The owner of the project you are querying.

Query parameters

Name	Data type	Description
fields	string	Selector specifying a subset of fields to include in the response.

Response

See a list of 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.

JSON

{
  "href": "http://api.sb.biodatacatalyst.nhlbi.nih.gov/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": true,
    "allow_network_access": true
  },
  "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.