Get Share

Retrieve metadata for a specific share

This API returns detailed metadata for a specific share, including its name, identifier, display name, and custom properties.

Request

method · string · required

GET

url · string · required

{prefix}/shares/{share}

Headers

Authorization · string · required

Bearer token for authentication

Authorization: Bearer {token}

URL Parameters

share · string · required

The share name to query. This parameter is case-insensitive.

Response

share · object · required

The share metadata object.

Show Share Properties

name · string · required

Share name (case-insensitive). Must not exceed 255 characters.

id · string

Unique identifier for the share. Should be immutable through the share’s lifecycle. Format recommendation: UUID.

displayName · string

Human-readable share name to display to users. Must not exceed 255 characters.

comment · string

Description of the share. Should not exceed 65536 characters.

properties · Map<String, String>

Optional key-value metadata pairs.

• Keys must not exceed 255 characters
• Values must not exceed 1000 characters
• Maximum 50 key-value pairs

Example Request

cURL

curl -X GET \
  '{prefix}/shares/vaccine_share' \
  -H 'Authorization: Bearer {token}'

Example Response

{
  "share": {
    "name": "vaccine_share",
    "id": "edacc4a7-6600-4fbb-85f3-a62a5ce6761f",
    "displayName": "Vaccine Share",
    "comment": "A sample share containing vaccine-related datasets",
    "properties": {
      "owner": "vaccine-team",
      "region": "us-west-2",
      "created_date": "2024-01-15"
    }
  }
}

Error Responses

Show 400 - Bad Request

The request is malformed.

{
  "errorCode": "string",
  "message": "string"
}

Show 401 - Unauthorized

The bearer token is missing or incorrect.

{
  "errorCode": "string",
  "message": "string"
}

Show 403 - Forbidden

The request is forbidden from being fulfilled.

{
  "errorCode": "string",
  "message": "string"
}

Show 404 - Not Found

The requested share does not exist.

{
  "errorCode": "string",
  "message": "string"
}

Show 500 - Internal Server Error

The request is not handled correctly due to a server error.

{
  "errorCode": "string",
  "message": "string"
}

Share names are case-insensitive, so vaccine_share, Vaccine_Share, and VACCINE_SHARE all refer to the same share.