List the effective Dynatrace settings values for a schema and scope with the Settings API, including the schema default when no object is persisted.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/effective-values |
You use the schema-id and scope query parameters to list the effective settings values of a schema, and add-fields to include additional fields. For a schema with multiObject set to false and no persisted object, the response contains the default value defined in the schema.
To execute this request, you need a platform token or OAuth access token with settings:objects:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| schema-id | string | Schema ID to which the requested objects belong. Only considered on load of the first page, when the page-key isn't set. | query | Optional |
| scope | string | Scope to which the requested objects belong. Only considered on load of the first page, when the page-key isn't set. | query | Optional |
| add-fields | string | A list of fields to be included in the response. The provided set of fields extends the default set. Specify the required top-level fields, separated by commas (for example, summary,origin). Supported fields: summary, searchSummary, schemaId, schemaVersion, origin, modificationInfo, value. Default fields: value. | query | Optional |
| page-key | string | The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters except the optimistic-locking-version parameter. | query | Optional |
| page-size | integer | The amount of settings objects in a single response payload. The maximal allowed page size is 500. If not set, the response won't be paged. | query | Optional |
| admin-access | boolean | If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects | query | Optional |
| optimistic-locking-version | string | The version of the objects list for optimistic locking. You can use it to detect simultaneous modifications by different users. It's generated upon retrieval of the list of objects (GET requests). If specified and modifications were made between retrieval and the request, the request will fail. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Effective | Success. Uses chunked encoding. Even if a response returns a successful response code it's possible that the result is incomplete due to an internal error. In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation. |
| 400 | - | - |
| 404 | - | - |
| 409 | - | - |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
EffectiveSettingsValuesList objectA list of effective settings values.
| Element | Type | Description |
|---|---|---|
| totalCount | integer | The total number of entries in the result. |
| pageSize | integer | The number of entries per page. |
| nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the page-key query parameter to obtain subsequent pages of the result. |
| items | Effective | A list of effective settings values. |
| error | Error | Error object for an incomplete response |
| version | string | The version of the settings objects list for optimistic locking." You can use it to detect simultaneous modifications by different users. It's generated upon retrieval (GET requests). If set on a followup GET request, it fails if there was a change between these two requests. |
EffectiveSettingsValue objectAn effective settings value.
| Element | Type | Description |
|---|---|---|
| summary | string | A short summary of settings. This can contain Markdown and will be escaped accordingly. |
| searchSummary | string | A searchable summary string of the setting value. Plain text without Markdown. |
| schemaId | string | The schema on which the object is based. |
| schemaVersion | string | The version of the schema on which the object is based. |
| origin | string | The origin of the settings value. Either a scope or default. |
| classicOrigin | string | The origin of the settings value in a classic format. Either a scope or default. |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. |
| modificationInfo | Modification | Modification information about the setting. |
SettingsValue objectThe value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
ModificationInfo objectModification information about the setting.
| Element | Type | Description |
|---|---|---|
| createdBy | string | The unique identifier of the user who created the setting. |
| createdTime | string | Timestamp when the setting was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| lastModifiedBy | string | The unique identifier of the user who performed the most recent modification. |
| lastModifiedTime | string | Timestamp when the setting was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
| lastModifiedReason | string | The reason for the most recent modification, if available. |
ErrorIncomplete objectError object for an incomplete response
| Element | Type | Description |
|---|---|---|
| code | integer | The error code (HTTP response) |
| message | string | The error message |
| retryAfterSeconds | integer | Number of seconds a request can be retried after a 'too many requests' error response. |
| details | Error | Optional details of the error |
ErrorDetails objectOptional details of the error
| Element | Type | Description |
|---|---|---|
| errorRef | string | reference to the error occurrence in the internal self-monitoring, logging, etc. |
| constraintViolations | Constraint | A list of constraint violations of input parameters (path, query, request body) |
| missingScopes | string[] | In case of a 403 - Forbidden response, a list of missing scopes necessary to successfully execute the request |
ConstraintViolation objectContains information about a constraint violation caused by invalid input.
| Element | Type | Description |
|---|---|---|
| path | string | The path of the parameter that caused the constraint violation |
| message | string | The constraint violation description message |
| parameterLocation | string | Describes the general location of the violating parameter The element can hold these values
|
{"totalCount": 1,"pageSize": 1,"nextPageKey": "AQAAABQBAAAABQ==","items": [{"summary": "string","searchSummary": "string","schemaId": "jira-connection","schemaVersion": "1.0.0","origin": "environment","classicOrigin": "environment","value": {"autoMonitoring": true},"modificationInfo": {"createdBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30","createdTime": "string","lastModifiedBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30","lastModifiedTime": "string","lastModifiedReason": "string"}}],"error": {"code": 1,"message": "string","retryAfterSeconds": 1,"details": {"errorRef": "string","constraintViolations": [{"path": "string","message": "string","parameterLocation": "PATH"}],"missingScopes": ["string"]}},"version": "string"}