Get details of an automation code package

This call retrieves information about the specified automation code package.

Request

https://api.sbgenomics.com/v2/automation/packages/{package-id}
https://eu-api.sbgenomics.com/v2/automation/packages/{package-id}

Example request

GET v2/automation/packages/40a284d9-c0da-441c-8799-3de8d85bbd8d
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75
curl -X POST \
  https://api.sbgenomics.com/v2/automation/packages/40a284d9-c0da-441c-8799-3de8d85bbd8d/packages \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75' \"
    ]
}
'
from sevenbridges import Api

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

# send GET request to SB API
package = api.automation_packages.get(
    id='8b595828-813c-4172-bd65-582a7a7a051e'
)

print(package.location, package.version)

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

package_id
required

The ID of the code package you are retrieving the information about.

Response

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

Example response body

{
   "id":"8b595828-813c-4172-bd65-582a7a7a051e",
   "automation":"f4bab0e2-0fc8-460d-8445-f1d9d1663dab",
   "version":"0.0.1",
   "location":"5eb287afe4b0d73fb6c3b936",
   "archived":False,
   "schema":{
      "inputs":{
         "input1":{
            "meta":{
               "ui_type":"text"
            },
            "type":"String",
            "default":"None",
            "required":True,
            "description":"None"
         }
      },
      "outputs":{
         "output1":{
            "meta":{
               "ui_type":"number"
            },
            "type":"Int",
            "description":"None"
         }
      },
      "secrets":{
      },
      "settings":{
      }
   },
   "created_by":"20200505_115305_tod",
   "created_on":"2020-05-06T09:47:30.794Z"
   "memory_limit"1000
}