/api/v1/datasets/{datasetUuid}/schema-fields
Requires the GV.APIReader application role, or a higher role (Owner > Contributor > Reader).
Operation ID · list_dataset_schema_fields
Request example
Authentication and access
- Required role: GV.APIReader
- Data classification: metadata
- Side effects: none
- Microsoft Entra delegated user token
- Microsoft Entra application token
Parameters
datasetUuid
path Required Opaque Dataset UUID.string (uuid)
Opaque Dataset UUID.
limit
queryinteger
- Default:
50
cursor
querystring | null
Any of
Option 1: string
string
maximum length: 2048
Option 2: null
null
search
query Case-insensitive literal search; wildcards are not operators.string | null
Case-insensitive literal search; wildcards are not operators.
Any of
Option 1: string
string
minimum length: 1 · maximum length: 200
Option 2: null
null
Responses
This guide summarizes response status codes and headers. Retrieve the deployed, authenticated OpenAPI document for the exact response body schemas and examples. The API also provides an authenticated Swagger UI; opening it in a browser does not automatically attach a bearer token. Error responses useapplication/problem+json. The response’s stable code and type map to the error-code reference.
200
Successful Response401
A valid Microsoft Entra bearer token is required.403
The authenticated principal does not have the required role.404
The resource does not exist in this tenant.422
The request is syntactically valid but semantically invalid.429
The bounded application request rate was exceeded.Headers
- Retry-After: Seconds to wait before retrying.
integerminimum: 1
503
A required dependency is temporarily unavailable.Headers
- Retry-After: Seconds to wait before retrying.
integerminimum: 1