Get details of a project

This call returns the details of a specified project.

Request

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

👍

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.

Example request

GET /v2/projects/rfranklin/my-project HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sbgenomics.com/v2/projects/rfranklin/my-project"
from sevenbridges import Api

api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74')

# send GET request to SB API
project = api.projects.get('rfranklin/my-project')

print(project.name)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

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.

Set this to _all to view all fields, including project settings.

Response

See a list of Seven Bridges Platform-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://api.sbgenomics.com/v2/projects/rfranklin/my-project",
  "id": "rfranklin/my-project",
  "name": "My 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": [
    "tag1",
    "tag2
  ],
  "settings": {
    "locked": false,
    "use_interruptible_instances": false,
    "use_memoization": true,
    "intermediate_files": {
      "retention":"LIMITED",
      "duration":24
     }
  },
  "permissions": {
    "write": true,
    "read": true,
    "copy": true,
    "execute": true,
    "admin": true
  },
  "root_folder": "595b8ca0e4b0a50d07cb58f9",
  "billing_group": "2791e8dc-4bb0-4314-9f3a-a8113e21e58c",
  "created_by": "rfranklin",
  "category": "PRIVATE",
  "created_on": "2017-07-04T12:40:00Z",
  "modified_on": "2019-05-20T12:49:34Z"
}
Interpreting the response body

  • The object type in the response should be ignored: all projects have type v2.
  • The dictionary settings contains one Boolean field, locked. This 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.