Method: ontologyRecords.list

Full name: projects.locations.instances.ontologyRecords.list

List all ontology records.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list OntologyRecords for. Format: projects/{project}/locations/{location}/instances/{instance}/ontologyRecords

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of OntologyRecords to return. The service may return fewer than this value. If unspecified, at most 50 OntologyRecords will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
skip

integer

Optional. Provide this to retrieve the subsequent page, by skipping the previous pages. When paginating, all other parameters provided to ontologyRecords.list must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of OntologyRecords. Supported filter fields: * displayName: Filter by the user-facing name. Example: filter="displayName='Triage'"
orderBy

string

Optional. Configures ordering of OntologyRecords in the response. If not specified, OntologyRecords are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. For example: "createTime desc, updateTime" Supported fields: * order * displayName

Request body

The request body must be empty.

Response body

Response message for ontologyRecords.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "ontologyRecords": [
    {
      object (OntologyRecord)
    }
  ],
  "totalSize": integer
}
Fields
ontologyRecords[]

object (OntologyRecord)

The list of OntologyRecords. Ordered by Id by default.
totalSize

integer

The total number of OntologyRecords includes filter without pagination.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.