Report uploaded parts

/upload/multipart/{upload_id}

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call allows you to report the upload multiple file parts at once.

https://cavatica-api.sbgenomics.com/v2/upload/multipart/{upload_id}

Request

Example request

POST /v2/upload/multipart/EXAMPLE_ID HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

{
  "parts": [
    {
      "part_number": 1,
      "response": {
        "headers": {
          "ETag": "98768e5c06b6cc1234567fc48b3fabcd"
        }
      }
    }
  ]
}
curl --data '@report_parts.json' -s -H "X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96" -H "content-type: application/json" -X POST "https://cavatica-api.sbgenomics.com/v2/upload/multipart/EXAMPLE_ID"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.
Content-Type
required
application_json

Path parameters

NameDescription
upload_idThe ID for the upload, returned by the call to initialize a multipart upload.

Request body

In the body of the request, you should enter key-value pairs describing the task. The keys, and their permitted values, are described below.

KeyDatatype of valueDescription of value
partsArray of ObjectsThis key should contain an array of objects describing the individual part upload reports. Each of these objects should be formatted exactly as the whole body of the Report an uploaded part call.

Example request body

{
  "parts": [
    {
      "part_number": 1,
      "response": {
        "headers": {
          "ETag": "1234e128411f2bace2sadfdabe610f30"
        }
      }
    },
    {
      "part_number": 2,
      "response": {
        "headers": {
          "ETag": "98768e5c06b6cc1234567fc48b3fabcd"
        }
      }
    }
  ]
}

Response

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


Language