GetReference - HealthOmics API Reference

GetReference

Gets a reference file.

Request Syntax

GET /referencestore/referenceStoreId/reference/id?file=file&partNumber=partNumber HTTP/1.1 Range: range

URI Request Parameters

The request uses the following URI parameters.

file

The file to retrieve.

Valid Values: SOURCE | INDEX

id

The reference's ID.

Length Constraints: Minimum length of 10. Maximum length of 36.

Pattern: [0-9]+

Required: Yes

partNumber

The part number to retrieve.

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: Yes

range

The range to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 127.

Pattern: [\p{N}||\p{P}]+

referenceStoreId

The reference's store ID.

Length Constraints: Minimum length of 10. Maximum length of 36.

Pattern: [0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 payload

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following as the HTTP body.

payload

The reference file payload.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

RangeNotSatisfiableException

The ranges specified in the request are not valid.

HTTP Status Code: 416

RequestTimeoutException

The request timed out.

HTTP Status Code: 408

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: