Get details of a deletion job

v2/async/files/delete/{jobid}

This call gets the details of an asynchronous bulk deletion job. This information will be available for up to a month after the job has been completed.

Request

https://cgc-api.sbgenomics.com/v2/async/files/delete/{jobid}

Example request

GET /v2/async/files/delete/71721895316959284
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl -X GET \
  https://cgc-api.sbgenomics.com/v2/async/files/delete/71721895316959284 \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CGC authentication token.

Content-Type
required

application/json

Query parameters

Key

Data type

Description

ID
required

string

The ID of the deletion job you are querying. This ID can be found within the API response for the call for deleting files.

Response

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

Response body

Key

Data type

Description

id

string

ID of this delete job.

result

string

The result of the delete job.

type

string

The type of job which is DELETE.

state

string

The following states are available:

SUBMITTED
RESOLVING
RUNNING
FINISHED

failed_files

string

The number of files that failed to delete.

completed_files

string

The number of files that were successfully deleted.

total_files

string

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

started_on

string

The time and date the deletion job started.

finished_on

string

The time and date the deletion job has finished.

Example response body

{
    "href": "https://cgc-api.sbgenomics.com/v2/async/files/delete/71721895316959284",
    "id": "71721895316959284",
    "result": [
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345",
                "id": "5c6e7e36e4b038560025d309"
            }
        },
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0498765",
                "id": "5c6e7e36e4b038560025d30b"
            }
        },
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0414164",
                "id": "568e69abe9b0307bc0414164"
            }
        }
        }
    ],
    "type": "DELETE",
    "state": "FINISHED",
    "failed_files": 0,
    "completed_files": 3,
    "total_files": 3,
    "started_on": "2019-02-21T12:23:52Z",
    "finished_on": "2019-02-21T12:23:52Z"
}

Did this page help you?