Try it free

Reorder settings objects

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Reorder the objects of a multi-object, ordered Dynatrace settings schema with the Settings API by sending the new order of object IDs.

POSTSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/settings/v1/objects:reorder

Overview

You use this operation to set the order of settings objects for a schema that is multi-object and ordered. The request body sets the schemaId, the scope, and the new order of object IDs, and the required optimistic-locking-version query parameter detects whether any of the objects changed in the meantime.

Authentication

To execute this request, you need a platform token or OAuth access token with settings:objects:write scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
optimistic-locking-versionstring

The version of the objects 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). The reorder will be allowed only if there wasn't any change between the retrieval and the update.

queryRequired
bodyReorderRequest

The JSON body of the request. Contains the reorder operations to be executed.

bodyRequired

Request body objects

The ReorderRequest object

ElementTypeDescriptionRequired
schemaIdstring

The schema to which the objects belong.

Required
scopestring

The scope to which the objects belong.

Required
sectionsReorderSection[]

Defines the reorder operations. Each section defines a contiguous range of objects in the source list that should be reordered. The sections must not overlap. Moving an object from one section to another isn't possible.

Required

The ReorderSection object

ElementTypeDescriptionRequired
firstObjectIdstring

The objectId of the first object of the source list that should be included in this section.

Required
lastObjectIdstring

The objectId of the last object of the source list that should be included in this section.

Required
orderReorderObject[]

The new order of objects spanning all objects between firstObject and lastObject inclusive.

Required

The ReorderObject object

ElementTypeDescriptionRequired
objectIdstring

The objectId of the settings object.

Required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
"schemaId": "builtin:schema",
"scope": "environment",
"sections": [
{
"firstObjectId": "string",
"lastObjectId": "string",
"order": [
{
"objectId": "string"
}
]
}
]
}

Response

Response codes

CodeTypeDescription
200ReorderResponse

Success.

400--
403--
404--
409--
429--
503--
4XX--
5XX--

Response body objects

The ReorderResponse object

ElementTypeDescription
versionstring

The version of the settings objects list for optimistic locking.

itemsobject[]

A list of settings objects after reordering. Only contains the objects that were part of the request.

Response body JSON models

{
"version": "string",
"items": [
{
"objectId": "string",
"version": "string"
}
]
}
Related tags
Platform APIDynatrace Platform