Get details of a copy job

v2/async/files/copy/{jobid}

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

Example request

GET /v2/async/files/copy/71721895312347584
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

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

{
  "items": [
    {
      "file": "568e69abe9b0307bc0412345",
      "parent": "",
      "project": "rfranklin/destination-project",
      "name": "my-new-file"
    },
    {
      "file": "568e69abe9b0307bc0498765",
      "parent": "",
      "project": "rfranklin/destination-project",
      "name": ""
    },
    {
      "file": "568e69abe9b0307bc0414164",
      "parent": "",
      "project": "rfranklin/destination-project",
      "name": ""
    }
  ]
}

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 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://api.sbgenomics.com/v2/async/files/copy/71796015699888176",
    "id": "71796015699888176",
    "result": [
        {
            "resource": {
                "href": "https://api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345",
                "id": "568e69abe9b0307bc0412345"
            }
        },
        {
            "resource": {
                "href": "https://api.sbgenomics.com/v2/files/568e69abe9b0307bc0498765",
                "id": "568e69abe9b0307bc0498765"
            }
        },
        {
            "resource": {
                "href": "https://api.sbgenomics.com/v2/files/568e69abe9b0307bc0414164",
                "id": "568e69abe9b0307bc0414164"
            }
        }
    ],
    "type": "COPY",
    "state": "FINISHED",
    "failed_files": 0,
    "completed_files": 3,
    "total_files": 3,
    "started_on": "2019-02-21T10:32:21Z",
    "finished_on": "2019-02-21T10:32:22Z"
}

Updated less than a minute ago