Get details of an automation run

This call returns the details of a specified automation run.

Request

https://api.sbgenomics.com/v2/automation/runs/{run-id}
https://eu-api.sbgenomics.com/v2/automation/runs/{run-id}

Example request

GET /v2/automation/runs/e5ed2ee7-8f3c-44e9-bc78-4cabd2ee441d HTTP/1.1
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74" -H "content-type: application/json" -X GET "https://api.sbgenomics.com/v2/automation/runs/e5ed2ee7-8f3c-44e9-bc78-4cabd2ee441f"
from sevenbridges import Api

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

# send GET request to SB API
run = api.automation_runs.get(id='e5ed2ee7-8f3c-44e9-bc78-4cabd2ee441d')

print(run.name, run.status, run.automation.name, run.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

run_id

The ID of the automation you are querying.

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":"95acfaab-8ab4-4682-b8ba-221c7b4fb1d3",
   "name":"test_params458 - 0.0.1 - 05-07-20 12:24:02",
   "href":"https://api.sbgenomics.com/v2/automation/runs/95acfaab-8ab4-4682-b8ba-221c7b4fb1d3",
   "memory_limit":1000
   "automation":{
      "id":"20dff6e5-2fa4-4b03-9af0-3c0a69c9c815",
      "href":"https://api.sbgenomics.com/v2/automation/automations/20dff6e5-2fa4-4b03-9af0-3c0a69c9c815",
      "name":"test_params458",
      "description":"TEST",
      "owner":"test_20200507_140832_vsy",
      "archived":False,
      "created_by":"test_20200507_140832_vsy",
      "created_on":"2020-05-07T12:23:15.000Z",
      "modified_on":"2020-05-07T12:23:15.305802",
      "modified_by":"test_20200507_140832_vsy"
   },
   "inputs":{
      "add_1":1,
      "add_2":2,
      "project_name":"Kind speak factor eight deep this."
   },
   "outputs":{
      "sum":3,
      "token_out":"6868107b286844958097a9be1ea7ed43",
      "random_out":1,
      "project_out":{
         "id":"test_20200507_140832_vsy/kind-speak-factor-eight-deep-this",
         "href":"https://api.sbgenomics.com/v2/projects/test_20200507_140832_vsy/kind-speak-factor-eight-deep-this",
         "resource":"Project"
      }
   },
   "settings":{
      "bg_name":"Pilot Funds (test_20200507_140832_vsy)"
   },
   "status":"FINISHED",
   "message":"",
   "package":{
      "id":"27982c8b-df2e-4f5f-ab40-1884ec4c91ce",
      "automation":"20dff6e5-2fa4-4b03-9af0-3c0a69c9c815",
      "version":"0.0.1",
      "location":"5eb3fdb8e4b0d73f04929619",
      "archived":False,
      "schema":{
         "inputs":{
            "add_1":{
               "type":"Int",
               "meta":{
                  "ui_type":"number"
               },
               "required":true,
               "default":null,
               "description":null
            },
            "add_2":{
               "type":"Int",
               "meta":{
                  "ui_type":"number"
               },
               "required":true,
               "default":null,
               "description":null
            },
            "project_name":{
               "type":"String",
               "meta":{
                  "ui_type":"text"
               },
               "required":true,
               "default":null,
               "description":null
            }
         },
         "outputs":{
            "sum":{
               "type":"Int",
               "meta":{
                  "ui_type":"number"
               },
               "description":null
            },
            "token_out":{
               "type":"String",
               "meta":{
                  "ui_type":"text"
               },
               "description":null
            },
            "random_out":{
               "type":"Int",
               "meta":{
                  "ui_type":"number"
               },
               "description":null
            },
            "project_out":{
               "type":"Project",
               "meta":{
                  "ui_type":"text"
               },
               "description":null
            }
         },
         "settings":{
         },
         "secrets":{
         }
      },
      "created_by":"test_20200507_140832_vsy",
      "created_on":"2020-05-07T12:23:23.358Z"
   },
   "created_on":"2020-05-07T12:24:02.760Z",
   "start_time":"2020-05-07T12:24:07.009Z",
   "end_time":"2020-05-07T12:25:02.160Z",
   "resumed_from":"None",
   "created_by":"test_20200507_140832_vsy",
   "execution_details":{
      "log_file":{
         "href":"https://api.sbgenomics.com/v2/files/5eb3fdf8e4b0d73f0492962c",
         "id":"5eb3fdf8e4b0d73f0492962c",
         "name":"automation.log",
         "size":3286
      },
      "state_file":{
         "href":"https://api.sbgenomics.com/v2/files/5eb3fdf8e4b0d73f0492962f",
         "id":"5eb3fdf8e4b0d73f0492962f",
         "name":"state.json",
         "size":2600
      }
   }
}