Modify a single marker

❗️

Heads Up!

This page documents the Advance Access version (think "beta" but with fewer bugs) of the folders functionality.

Request

This call modifies a single genetic marker.

https://api.sbgenomics.com/genome/markers/{marker_id}
https://eu-api.sbgenomics.com/genome/markers/{marker_id}

Example request

PATCH /genome/markers/59254a7b92bd172e013a1a91 HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
X-SBG-Advance-Access: advance
from sevenbridges import Api
api = Api(url='https://api.sbgenomics.com/v2',
          token='3259c50e1ac5426ea8f1273259740f74',
          advance_access=True)

marker = api.markers.get(id='59254a7b92bd172e013a1a91')

# modify marker information
marker.position.start = 1233
marker.position.end = 1244
marker.name = 'Some cancer marker'

# send PATCH request to SB API
marker.save()

print(marker.name)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-Type
required

application/json

X-SBG-Advance-Access
required

advance

Path parameters

Name

Description

marker_id

This is the marker ID for the specific genetic marker you wish to modify. Obtain the marker_id for a genetic marker on a BAM file by making the API call to List markers available on a file.

Example request body

{
  "position": {
        "start": 1233,
    "end": 1244
    },
   "name": "Some cancer marker"
}

Response

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

Example response body

{
  "href": "http://api.sbgenomics.com/v2/genome/markers/59254a7b92bd172e013a1a91",
  "id": "59254a7b92bd172e013a1a91",
  "name": "Some cancer marker",
  "file": "592444771c94679800e99c23",
  "chromosome": "chr1",
  "position": {
    "start": 1233,
    "end": 1244
  },
  "created_time": "2017-05-24T08:55:00Z",
  "created_by": "rfranklin"
}