This API returns a paginated list of schemas contained within a specific share. A schema is a logical grouping of tables within a share.
Request
{prefix}/shares/{share}/schemas
Bearer token for authenticationAuthorization: Bearer {token}
URL Parameters
The share name to query. This parameter is case-insensitive.
Query Parameters
The maximum number of results per page that should be returned.
- Must be non-negative
- 0 will return no results but
nextPageToken may be populated
- Server may return fewer items even if more are available
Specifies a page token to use. Set to the nextPageToken returned by a previous list request to get the next page of results.
Response
Array of schema objects. May be an empty array or missing when no results are found.
Schema name (case-insensitive). Must not exceed 255 characters.
The parent share name. Must not exceed 255 characters.
Token for retrieving the next page of results. May be an empty string or missing when there are no additional results.
Example Request
curl -X GET \
'{prefix}/shares/vaccine_share/schemas?maxResults=10&pageToken=...' \
-H 'Authorization: Bearer {token}'
Example Response
{
"items": [
{
"name": "acme_vaccine_data",
"share": "vaccine_share"
}
],
"nextPageToken": "..."
}
Error Responses
The request is malformed.{
"errorCode": "string",
"message": "string"
}
The bearer token is missing or incorrect.{
"errorCode": "string",
"message": "string"
}
The request is forbidden from being fulfilled.{
"errorCode": "string",
"message": "string"
}
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"
}
Schema names and share names are case-insensitive. The client must handle both empty arrays and missing items fields when no results are found.
