Get details of a multipart upload

/upload/multipart/{upload_id}

This call will return the details of an active multipart upload.

The upload is referenced by its ID as returned by a call to initialize a multipart upload or list current multipart uploads.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/upload/multipart/{upload_id}

Request

Example request

HTTP

GET /v2/upload/multipart/Zrand0mrFtYj3rooeFcnawiVhoZp1sF0OK3RVvpWucTKGtNpvDvXFrj4JKOU1qyV HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/upload/multipart"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.
Content-Type required	application/json

Path parameters

Name	Description
upload_id	The ID of the upload. It can be obtained by initializing a new upload or by listing the ongoing multipart uploads.

Query parameters

Name	Datatype	Description
list_parts	Boolean: true or false	If true, also return a list of parts that have been reported as completed for this multipart upload.

Response

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

Example response body

JSON

{
  "upload_id": "Zrand0mrFtYj3rooeFcnawiVhoZp1sF0OK3RVvpWucTKGtNpvDvXFrj4JKOU1qyV",
  "project": "RFranklin/my-project",
  "name": "1000G_omni2.5.b37.vcf",
  "initiated": "2016-01-01T00:00:00Z",
  "parallel_uploads": true,
  "part_size": 1073741824,
  "uploaded_parts_count": 1,
  "parts": [
    {
      "part_number": 1,
      "response": {
        "headers": {
          "ETag": "1234e128411f2bace2sadfdabe610f30"
        }
      }
    }
  ]
}