Generate a readable summary of a Dynatrace settings value with the Settings API, for example to preview how the value appears in a list view.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/values/{schema-id}:summarize |
You use the schema-id path parameter to choose the schema and send the schemaVersion and the value to summarize in the request body. A 200 response returns a human-readable summary of the value. Typical usage is previewing how a settings object will appear in list views of your app.
To execute this request, you need a platform token or OAuth access token with settings:schemas:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| schema-id | string | The ID of the required schema. | path | Required |
| body | Settings | The JSON body of the request. Contains the settings value to summarize. Must conform to the specified schema. | body | Required |
SettingsObjectSummarize objectThe settings object to summarize.
| Element | Type | Description | Required |
|---|---|---|---|
| schemaVersion | string | The version of the schema on which the object is based. | Optional |
| value | Settings | The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema. | Required |
SettingsValue objectThe value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"schemaVersion": "1.0","value": {"autoMonitoring": true}}
| Code | Type | Description |
|---|---|---|
| 200 | Settings | Success. |
| 400 | - | - |
| 403 | - | - |
| 404 | - | - |
| 429 | - | - |
| 503 | - | - |
| 4XX | - | - |
| 5XX | - | - |
SettingsObjectSummary objectThe summary of the provided settings object according to the schema.
| Element | Type | Description |
|---|---|---|
| summary | string | A short summary of the settings object. This can contain Markdown and will be escaped accordingly. |
| searchSummary | string | A searchable summary string of the setting value. Plain text without Markdown. |
| properties | object | The summaries of the child properties by their name. |
| items | Settings | The summaries of the items in this property (if this property is a collection). |
SettingsObjectSummary objectThe summary of the provided settings object according to the schema.
| Element | Type | Description |
|---|---|---|
| summary | string | A short summary of the settings object. This can contain Markdown and will be escaped accordingly. |
| searchSummary | string | A searchable summary string of the setting value. Plain text without Markdown. |
| properties | object | The summaries of the child properties by their name. |
| items | Settings | The summaries of the items in this property (if this property is a collection). |
{"summary": "string","searchSummary": "string","properties": {},"items": [{}]}