Retrieve a fieldset by UID in Dynatrace with the Grail Fieldsets API, returning the fieldset definition used for field-level access control.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/storage/fieldsets/v1/fieldsets/{fieldsetUid} |
You use the fieldsetUid path parameter to identify the fieldset you want to retrieve. The operation returns the fieldset successfully retrieved in the 200 response.
To execute this request, you need a platform token or OAuth access token with storage:fieldset-definitions:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| fieldsetUid | string | UID of the fieldset | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | Fieldset | fieldset successfully retrieved. |
| 404 | Error | Not found: the server cannot find the requested fieldset. |
| 5XX | Error | Server error. |
Fieldset object| Element | Type | Description |
|---|---|---|
| buckets | string[] | List of the buckets on which fieldset is applicable. |
| created | string | Timestamp in ISO-8601 indicating when the field record was created. |
| createdBy | string | Creator of the fieldset. |
| description | string | Description of the fieldset. |
| enabled | boolean | Indicates if the fieldset is enabled. |
| fields | string[] | List of the fields. |
| lastModified | string | Timestamp in ISO-8601 indicating when the field record was updated. |
| lastModifiedBy | string | Last user who modified the fieldset. |
| name | string | Name of the fieldset. |
| readOnly | boolean | Indicates if the fieldset is read only and can not be updated. |
| scope | string | Scope of the fieldset. |
| tables | string[] | List of the tables on which fieldset is applicable. |
| uid | string | Unique identifier of the fieldset. |
| version | integer | Used for optimistic locking. Update requests define with this on which version the data updated is based on. This must match with the version stored, otherwise the update will fail due to concurrent modification. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | The response for error state |
ErrorResponse objectThe response for error state
| Element | Type | Description |
|---|---|---|
| code | integer | Error code, which normally matches the HTTP error code. |
| details | Error | Detailed information about the error. |
| message | string | A short, clear error message without details |
ErrorResponseDetails objectDetailed information about the error.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Error | Information about an input parameter that violated some validation rule of the service API. |
| errorMessage | string | Complete error message. |
| missingPermissions | string[] | List of missing IAM permissions necessary to successfully execute the request. |
| missingScopes | string[] | List of missing IAM scopes necessary to successfully execute the request. |
ErrorResponseDetailsConstraintViolations objectInformation about an input parameter that violated some validation rule of the service API.
| Element | Type | Description |
|---|---|---|
| message | string | Message describing the error. |
| parameterDescriptor | string | Describes the violating parameter. |
{"uid": "12132","name": "sensitive-fields","description": "","createdBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45","enabled": true,"readOnly": false,"scope": "TABLE","fields": ["email","userid"],"tables": ["spans","logs"],"version": 1,"lastModifiedBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45","created": "2024-01-01T15:04:20.698Z","lastModified": "2024-12-31T18:06:09.647Z"}
{"error": {"message": "Fieldset not found","code": 404}}