List effective settings values in Dynatrace with the App Settings API, including schema defaults when no object is persisted for a non-multiObject schema.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v2/effective-values |
Lists effective settings values for selected schemas. If no object is persisted for a schema with "multiObject": false, the default value as defined in the schema will be returned.
Properties of type secret will be included in plain text if the call originates from a serverless function of your app; they will have irreversibly masked values otherwise. This protects these secrets from leaking to users of your app or other third parties.
To execute this request, you need a platform token or OAuth access token with app-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 nextPageKey is not 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,schemaId). Supported fields: summary, searchSummary, schemaId, schemaVersion, 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. | query | Optional |
| page-size | integer | The amount of settings objects in a single response payload. If set to 0, all available settings objects will be included in the response. The maximal allowed page size is 500. If not set, 100 is used. | query | Optional |
| admin-access | boolean | If set to true and user has app-settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Effective | Success. Uses chunked encoding. Even if a response returns a successful response code it is 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 | Error | Failed. The input is invalid. |
| 404 | Error | Failed. The specified schema is not found. |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
EffectiveAppSettingsValuesList 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 nextPageKey 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 |
EffectiveAppSettingsValue 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. |
| value | App | 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. |
AppSettingsValueRaw 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
|
ErrorResponse object| Element | Type | Description |
|---|---|---|
| error | Error | Standard error response |
Error objectStandard error response
| Element | Type | Description |
|---|---|---|
| code | number | The error code (HTTP response) |
| message | string | The error message |
| retryAfterSeconds | number | 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","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"]}}}
{"error": {"code": 1,"message": "string","retryAfterSeconds": 1,"details": {"errorRef": "string","constraintViolations": [{"path": "string","message": "string","parameterLocation": "PATH"}],"missingScopes": ["string"]}}}