Get details of a copy job

This call gets the details of an asynchronous bulk copy 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/copy/{jobid}

Example request

GET /v2/async/files/copy/70721895322947584
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75

curl -X GET \
  https://cavatica-api.sbgenomics.com/v2/async/files/copy/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 copy job you are querying. This ID can be found within the API response for the call for copying files.

{
  "items": [
    {
      "file": "5c6d3f30e4b038563238932f",
      "parent": "",
      "project": "rfranklin/destination-project",
      "name": "my-new-file"
    },
    {
      "file": "5c6d3f30e4b038563238932b",
      "parent": "",
      "project": "rfranklin/destination-project",
      "name": ""
    },
    {
      "file": "5c6d3f30e4b0385632389331",
      "parent": "",
      "project": "rfranklin/destination-project",
      "name": ""
    }
  ]
}

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 copy job
`result`	string	The result of the copy job.
`type`	string	The type of job which is COPY.
`state`	string	The following states are available: SUBMITTED RESOLVING RUNNING FINISHED
`failed_files`	string	The number of files that failed to copy.
`completed_files`	string	The number of files that were successfully copied.
`total_files`	string	The total number of files that were processed during the job.
`started_on`	string	The time and date the copy job started.
`finished_on`	string	The time and date the copy job has finished.

{
    "href": "https://cavatica-api-sbgenomics.com/v2/automation/automations/",
    "items": [
        {
            "id": "40a284d9-c0da-441c-8799-3de8d85bbd8d",
            "href": "https://cavatica-api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8c",
            "name": "My automation",
            "description": "This is my first automation.",
            "owner": "rfranklin",
            "created_by": "rfranklin",
            "created_on": "1970-01-18T18:29:46.333Z",
            "modified_on": "1970-01-18T18:29:46.333Z",
            "modified_by": "rfranklin"
        }
    ],
    "links": []
}