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://cavatica-api.sbgenomics.com/v2/async/files/delete/{jobid}

Example request

GET /v2/async/files/delete/70721895322947584
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75
curl -X GET \
  https://cavatica-api.sbgenomics.com/v2/async/files/delete/70796015691698176 \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb4c0a465' \

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA 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 CAVATICA-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://cavatica-api.sbgenomics.com/v2/async/files/delete/70803031344615424",
    "id": "70803031344615424",
    "result": [
        {
            "resource": {
                "href": "https://cavatica-api.sbgenomics.com/v2/files/5c6e7e36e4b038560025d309",
                "id": "5c6e7e36e4b038560025d309"
            }
        },
        {
            "resource": {
                "href": "https://cavatica-api.sbgenomics.com/v2/files/5c6e7e36e4b038560025d30b",
                "id": "5c6e7e36e4b038560025d30b"
            }
        },
        {
            "resource": {
                "href": "https://cavatica-api.sbgenomics.com/v2/files/5c6e7e36e4b038560025d30b",
                "id": "5c6d3f30e4b0385632389331"
            }
        }
        }
    ],
    "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"
}