Settings API - GET an object

Gets the specified settings object.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/objects/{objectId}`
GET	Environment and Cluster ActiveGate (default port 9999)	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/settings/objects/{objectId}`

Authentication

To execute this request, you need an access token with settings.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
objectId	string	The ID of the required settings object.	path	required
adminAccess	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

Response

Response codes

Code	Type	Description
200	SettingsObjectByObjectIdResponse	Success
403	ErrorEnvelope	Failed. Forbidden.
404	ErrorEnvelope	No object available for the given objectId
4XX	ErrorEnvelope	Client side error.
5XX	ErrorEnvelope	Server side error.

Response body objects

The `SettingsObjectByObjectIdResponse` object

The response to a get by objectId request.

Element	Type	Description
author	string	The user (identified by a user ID or a public token ID) who performed that most recent modification.
created	integer	The timestamp of the creation.
createdBy	string	The unique identifier of the user who created the settings object.
externalId	string	The external identifier of the settings object.
modified	integer	The timestamp of the last modification.
modifiedBy	string	The unique identifier of the user who performed the most recent modification.
objectId	string	The ID of the settings object.
owner	Identity	An Identity describing either a user, a group, or the all-users group (applying to all users).
resourceContext	ResourceContext	The resource context, which contains additional permission information about the object.
schemaId	string	The schema on which the object is based.
schemaVersion	string	The version of the schema on which the object is based.
scope	string	The scope that the object targets. For more details, please see Dynatrace Documentation.
searchSummary	string	A searchable summary string of the setting value. Plain text without Markdown.
summary	string	A short summary of settings. This can contain Markdown and will be escaped accordingly.
updateToken	string	The update token of the object. You can use it to detect simultaneous modifications by different users. It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update. If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
value	string	The value of the setting. It defines the actual values of settings' parameters. The actual content depends on the object's schema.

The `Identity` object

An Identity describing either a user, a group, or the all-users group (applying to all users).

Element	Type	Description
id	string	The user id or user group id if type is 'user' or 'group', missing if type is 'all-users'.
type	string	The type of the identity. `all-users` `group` `user`

The `ResourceContext` object

The resource context, which contains additional permission information about the object.

Element	Type	Description
modifications	Modification	The additional modification details for this settings object.
operations	string[]	The allowed operations on this settings object. `delete` `read` `write`

The `Modification` object

The additional modification details for this settings object.

Element	Type	Description
first	boolean	If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list).
modifiablePaths	string[]	Property paths which are modifiable, regardless if the `write` operation is allowed.
movable	boolean	If settings object can be moved/reordered. Only applicable for ordered list schema.
nonModifiablePaths	string[]	Property paths which are not modifiable, even if the `write` operation is allowed.

The `AnyValue` object

A schema representing an arbitrary value type.

Response body JSON model

{
  "author": "john.doe@example.com",
  "created": 1,
  "createdBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30",
  "externalId": "string",
  "modified": 1,
  "modifiedBy": "fab17b7a-2eb2-4c95-b818-743d94be2c30",
  "objectId": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "owner": {
    "id": "string",
    "type": "user"
  },
  "resourceContext": {
    "modifications": {
      "first": true,
      "modifiablePaths": [
        "string"
      ],
      "movable": true,
      "nonModifiablePaths": [
        "string"
      ]
    },
    "operations": [
      "delete"
    ]
  },
  "schemaId": "builtin:container.built-in-monitoring-rule",
  "schemaVersion": "1.0.0",
  "scope": "HOST-D3A3C5A146830A79",
  "searchSummary": "string",
  "summary": "string",
  "updateToken": "Y2ktaGdyb3VwLTEyMythZjhjOThlOS0wN2I0LTMyMGEtOTQzNi02NTEyMmVlNWY4NGQ=",
  "value": "string"
}