Lists Annotations belongs to a dataitem
HTTP request
GET https://{service-endpoint}/v1/{parent}/annotations
Where {service-endpoint}
is one of the supported service endpoints.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the DataItem to list Annotations from. Format: |
Query parameters
Parameters | |
---|---|
filter |
The standard list filter. |
pageSize |
The standard list page size. |
pageToken |
The standard list page token. |
readMask |
Mask specifying which fields to read. This is a comma-separated list of fully qualified names of fields. Example: |
orderBy |
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. |
Request body
The request body must be empty.
Response body
Response message for DatasetService.ListAnnotations
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"annotations": [
{
object ( |
Fields | |
---|---|
annotations[] |
A list of Annotations that matches the specified filter in the request. |
nextPageToken |
The standard List next-page token. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent
resource:
aiplatform.annotations.list
For more information, see the IAM documentation.