Report an uploaded part

/upload/multipart/{upload_id}/part

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

This call allows you to report the upload of a file part.

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

Request

Example request

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

{
  "part_number": 1,
  "response": {
    "headers": {
      "ETag": "98768e5c06b6cc1234567fc48b3fabcd"
    }
  }
}
curl --data '{"part_number": 1, "response": {"headers": {"ETag": "98768e5c06b6cc1234567fc48b3fabcd"}}}' -s -H "X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74" -H "content-type: application/json" -X POST "https://cavatica-api.sbgenomics.com/v2/upload/multipart/srand0mB1h7n3UcjUEqcHKahAl1cizencbI1OQvIkGv8qQRDiP2VAtUpO8NnLKFN/part"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Content-Type
required

application/json

Path parameters

Name

Description

upload_id

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

Request body

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

Key

Datatype of value

Description of value

part_number

Integer

The number of the file part you are reporting. Part numbers start from 1.

response

Object

This object should contain the information collected from a successful HTTP part upload request.
See the Formatting the response object section below for an explanation of its structure.

Formatting the response object

When reporting a part, the structure of the response object is different from that of the report object received when getting a part upload URL. Assuming that you have collected the information from the HTTP part upload request, you should format the response object in this call as a set of key-value mappings. The keys in these mappings should be headers and other response elements described in Get upload URL for a file part, and their values should be strings that you have collected from the HTTP part upload request.

Key

Datatype of value

Description of value

headers

Object of String keys to String values

A map of header keys from the Get upload URL for a file part to their values returned by the successful HTTP part upload request you've made.

body

Object

Reserved for future use

Example request body

{
  "part_number": 1,
  "response": {
    "headers": {
      "ETag": "98768e5c06b6cc1234567fc48b3fabcd"
    }
  }
}

Response

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


Language
Click Try It! to start a request and see the response here!