Service detection API - PUT reorder opaque web service rules

Reference
Published Sep 06, 2019

Reorders the service detection rules for external and opaque web services to the order of the IDs in the body of the request.

Rules that are omitted from the body of the request retain their relative order but are placed after all those present in the request.

The request consumes and produces an application/json payload.

PUT	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/order`
PUT	Environment ActiveGate	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/order`

Authentication

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

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

Parameters

Parameter	Type	Description	In	Required
body	StubList	The JSON body of the request containing the service detection rules in the required order.	body	Optional

Request body objects

The `StubList` object

An ordered list of short representations of Dynatrace entities.

Element	Type	Description	Required
values	EntityShortRepresentation[]	An ordered list of short representations of Dynatrace entities.	Required

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description	Required
description	string	A short description of the Dynatrace entity.	Optional
id	string	The ID of the Dynatrace entity.	Required
name	string	The name of the Dynatrace entity.	Optional

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.

{
  "values": [
    {
      "description": "Dynatrace entity 1 for the REST API example",
      "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
      "name": "Dynatrace entity 1"
    },
    {
      "id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
      "name": "Dynatrace entity 2"
    },
    {
      "id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
    }
  ]
}

Response

Response codes

Code	Type	Description
204	-	Success. Service detection rules have been reordered. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `ErrorEnvelope` object

Element	Type	Description
error	Error	-

The `Error` object

Element	Type	Description
code	integer	The HTTP status code
constraintViolations	ConstraintViolation[]	A list of constraint violations
message	string	The error message

The `ConstraintViolation` object

A list of constraint violations

Element	Type	Description
location	string	-
message	string	-
parameterLocation	string	- The element can hold these values `HEADER` `PATH` `PAYLOAD_BODY` `QUERY`
path	string	-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}