{"_id":"5c8a6bb880ddb900575224a7","project":"5773dcfc255e820e00e1cd4d","version":{"_id":"5773dcfc255e820e00e1cd50","__v":27,"project":"5773dcfc255e820e00e1cd4d","createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5c8a68278e883901341de571","project":"5773dcfc255e820e00e1cd4d","version":"5773dcfc255e820e00e1cd50","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2019-03-14T14:41:43.757Z","from_sync":false,"order":16,"slug":"async-bulk-actions","title":"ASYNC BULK ACTIONS"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-03-14T14:56:56.466Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"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.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/async/files/copy/{jobid}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/async/files/copy/70721895322947584\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl -X GET \\\\\\n  https://cavatica-api.sbgenomics.com/v2/async/files/copy/70796015691698176 \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb4c0a465' \\\\\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n*required*\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \"`Content-Type`\\n*required*\",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n### Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`ID`\\n_required_\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The ID of the copy job you are querying. This ID can be found within the API response for the call for copying files.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"items\\\": [\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b038563238932f\\\",\\n      \\\"parent\\\": \\\"\\\",\\n      \\\"project\\\": \\\"rfranklin/destination-project\\\",\\n      \\\"name\\\": \\\"my-new-file\\\"\\n    },\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b038563238932b\\\",\\n      \\\"parent\\\": \\\"\\\",\\n      \\\"project\\\": \\\"rfranklin/destination-project\\\",\\n      \\\"name\\\": \\\"\\\"\\n    },\\n    {\\n      \\\"file\\\": \\\"5c6d3f30e4b0385632389331\\\",\\n      \\\"parent\\\": \\\"\\\",\\n      \\\"project\\\": \\\"rfranklin/destination-project\\\",\\n      \\\"name\\\": \\\"\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example request body\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n[See a list of Cavatica-specific response codes that may be contained in the body of the response.](ref:api-status-codes)\n\n## Response body\n\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id`\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"string\",\n    \"0-2\": \"ID of this copy job\",\n    \"1-0\": \"`result`\",\n    \"2-0\": \"`type`\",\n    \"3-0\": \"`state`\",\n    \"4-0\": \"`failed_files`\",\n    \"5-0\": \"`completed_files`\",\n    \"6-0\": \"`total_files`\",\n    \"7-0\": \"`started_on`\",\n    \"8-0\": \"`finished_on`\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"7-1\": \"string\",\n    \"8-1\": \"string\",\n    \"1-2\": \"The result of the copy job.\",\n    \"2-2\": \"The type of job which is COPY.\",\n    \"3-2\": \"The following states are available:\\n\\nSUBMITTED\\nRESOLVING\\nRUNNING\\nFINISHED\",\n    \"4-2\": \"The number of files that failed to copy.\",\n    \"5-2\": \"The number of files that were successfully copied.\",\n    \"6-2\": \"The total number of files that were processed during the job.\",\n    \"7-2\": \"The time and date the copy job started.\",\n    \"8-2\": \"The time and date the copy job has finished.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\n{\\n    \\\"href\\\": \\\"https://cavatica-api-sbgenomics.com/v2/automation/automations/\\\",\\n    \\\"items\\\": [\\n        {\\n            \\\"id\\\": \\\"40a284d9-c0da-441c-8799-3de8d85bbd8d\\\",\\n            \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8c\\\",\\n            \\\"name\\\": \\\"My automation\\\",\\n            \\\"description\\\": \\\"This is my first automation.\\\",\\n            \\\"owner\\\": \\\"rfranklin\\\",\\n            \\\"created_by\\\": \\\"rfranklin\\\",\\n            \\\"created_on\\\": \\\"1970-01-18T18:29:46.333Z\\\",\\n            \\\"modified_on\\\": \\\"1970-01-18T18:29:46.333Z\\\",\\n            \\\"modified_by\\\": \\\"rfranklin\\\"\\n        }\\n    ],\\n    \\\"links\\\": []\\n}\\n\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"v2/async/files/copy/{jobid}","slug":"get-details-of-a-copy-job","type":"basic","title":"Get details of a copy job"}

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. [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/async/files/copy/{jobid}", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "GET /v2/async/files/copy/70721895322947584\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5336ea8f1253259740f75", "language": "http", "name": null }, { "code": "curl -X GET \\\n https://cavatica-api.sbgenomics.com/v2/async/files/copy/70796015691698176 \\\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: d32c2976ffc04d0eb90c6c4fb4c0a465' \\", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n*required*", "0-1": "Your Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-Type`\n*required*", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ### Query parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`ID`\n_required_", "0-1": "string", "0-2": "The ID of the copy job you are querying. This ID can be found within the API response for the call for copying files." }, "cols": 3, "rows": 1 } [/block] [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"file\": \"5c6d3f30e4b038563238932f\",\n \"parent\": \"\",\n \"project\": \"rfranklin/destination-project\",\n \"name\": \"my-new-file\"\n },\n {\n \"file\": \"5c6d3f30e4b038563238932b\",\n \"parent\": \"\",\n \"project\": \"rfranklin/destination-project\",\n \"name\": \"\"\n },\n {\n \"file\": \"5c6d3f30e4b0385632389331\",\n \"parent\": \"\",\n \"project\": \"rfranklin/destination-project\",\n \"name\": \"\"\n }\n ]\n}", "language": "json", "name": "Example request body" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of Cavatica-specific response codes that may be contained in the body of the response.](ref:api-status-codes) ## Response body [block:parameters] { "data": { "0-0": "`id`", "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-1": "string", "0-2": "ID of this copy job", "1-0": "`result`", "2-0": "`type`", "3-0": "`state`", "4-0": "`failed_files`", "5-0": "`completed_files`", "6-0": "`total_files`", "7-0": "`started_on`", "8-0": "`finished_on`", "1-1": "string", "2-1": "string", "3-1": "string", "4-1": "string", "5-1": "string", "6-1": "string", "7-1": "string", "8-1": "string", "1-2": "The result of the copy job.", "2-2": "The type of job which is COPY.", "3-2": "The following states are available:\n\nSUBMITTED\nRESOLVING\nRUNNING\nFINISHED", "4-2": "The number of files that failed to copy.", "5-2": "The number of files that were successfully copied.", "6-2": "The total number of files that were processed during the job.", "7-2": "The time and date the copy job started.", "8-2": "The time and date the copy job has finished." }, "cols": 3, "rows": 9 } [/block] [block:code] { "codes": [ { "code": "\n{\n \"href\": \"https://cavatica-api-sbgenomics.com/v2/automation/automations/\",\n \"items\": [\n {\n \"id\": \"40a284d9-c0da-441c-8799-3de8d85bbd8d\",\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/automation/automations/40a284d9-c0da-441c-8799-3de8d85bbd8c\",\n \"name\": \"My automation\",\n \"description\": \"This is my first automation.\",\n \"owner\": \"rfranklin\",\n \"created_by\": \"rfranklin\",\n \"created_on\": \"1970-01-18T18:29:46.333Z\",\n \"modified_on\": \"1970-01-18T18:29:46.333Z\",\n \"modified_by\": \"rfranklin\"\n }\n ],\n \"links\": []\n}\n", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]