Get details of all async jobs

v2/async/files

This call gets the details for all asynchronous bulk jobs you have started. This information will be available for up to a month after the job has been completed.

Request

https://api.sbgenomics.com/v2/async/files
https://eu-api.sbgenomics.com/v2/async/files

Example request

GET /v2/async/files
Host: api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75
curl -X GET \
  https://api.sbgenomics.com/v2/async/files
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb4c0a465' \
from sevenbridges import Api

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

# send GET request to SB API
async_jobs = api.async_jobs.list_file_jobs()

for async_job in async_jobs:
    print(async_job.id, async_job.type, async_job.state)

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your Seven Bridges Platform authentication token.

Content-Type
required

application/json

Query parameters

Key

Data type

Description

offset

integer

The zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a pagination-specific attribute.

limit

integer

The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 25. This is a pagination-specific attribute.

Response

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

Response body

The response body will contain information for each of the jobs.

Key

Data type

Description

id

string

ID of the job.

result

string

The result of the job.

type

string

The type of job.

state

string

The following states are available:

SUBMITTED
RESOLVING
RUNNING
FINISHED

failed_files

string

The number of files that failed.

completed_files

string

The number of files that were successfully completed.

total_files

string

The total number of files that were processed for the job.

Example response body

{
    "href": "https://api.sbgenomics.com/v2/async/files?offset=0&limit=13",
    "items": [
        {
            "href": "https://api.sbgenomics.com/v2/async/files/copy/70711174378885120",
            "id": "70711174378885120",
            "result": [
                {
                    "resource": {
                        "href": "https://api.sbgenomics.com/v2/files/5c6d4227e4b0385632389346",
                        "id": "5c6d4227e4b0385632389346"
                    }
                }
            ],
            "type": "COPY",
            "state": "FINISHED",
            "failed_files": 0,
            "completed_files": 1,
            "total_files": 1,
            "started_on": "2019-02-20T12:03:50Z",
            "finished_on": "2019-02-20T12:03:51Z"
        },
        {
            "href": "https://api.sbgenomics.com/v2/async/files/copy/70714896400060416",
            "id": "70714896400060416",
            "result": [
                {
                    "resource": {
                        "href": "https://api.sbgenomics.com/v2/files/5c6d5004e4b03856323893bb",
                        "id": "5c6d5004e4b03856323893bb"
                    }
                },
                {
                    "resource": {
                        "href": "https://api.sbgenomics.com/v2/files/5c6d5004e4b03856323893bc",
                        "id": "5c6d5004e4b03856323893bc"
                    }
                },
                {
                    "resource": {
                        "href": "https://api.sbgenomics.com/v2/files/5c6d5004e4b03856323893ba",
                        "id": "5c6d5004e4b03856323893ba"
                    }
                }
            ],
            "type": "COPY",
            "state": "FINISHED",
            "failed_files": 0,
            "completed_files": 3,
            "total_files": 3,
            "started_on": "2019-02-20T13:03:00Z",
            "finished_on": "2019-02-20T13:03:00Z"
        },
        {
            "href": "https://api.sbgenomics.com/v2/async/files/copy/70714077692891136",
            "id": "70714077692891136",
            "result": [
                {
                    "resource": {
                        "href": "https://api.sbgenomics.com/v2/files/5c6d4cf7e4b0385632389392",
                        "id": "5c6d4cf7e4b0385632389392"
                    }
                },
                {
                    "resource": {
                        "href": "https://api.sbgenomics.com/v2/files/5c6d4cf7e4b0385632389391",
                        "id": "5c6d4cf7e4b0385632389391"
                    }
                }
            ],
            "type": "COPY",
            "state": "FINISHED",
            "failed_files": 0,
            "completed_files": 3,
            "total_files": 3,
            "started_on": "2019-02-20T12:49:59Z",
            "finished_on": "2019-02-20T12:49:59Z"
       }
    ],
    "links": []
}