Request naming API - PUT a request naming rule

Updates the specified request naming rule. If the rule with the specified ID doesn't exist—creates a new rule with this ID.

The request consumes and produces an application/json payload.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestNaming/{id}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestNaming/{id}

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Refer to JSON models to find all JSON models that depend on the type of the model.

Parameter Type Description In Required
id string

The ID of the request naming to be updated.

The ID of the request naming in the body of the request must match this ID.

path required
body RequestNaming

The JSON body of the request containing updated parameters of the request naming.

body optional

Body format

The RequestNaming object

The request naming rule.

Element Type Description Required
id string

The ID of the request naming rule.

optional
order string

The order string. Sorting request namings alphabetically by their order string determines their relative ordering.

Typically this is managed by Dynatrace internally and will not be present in GET responses nor used if present in PUT/POST requests, except where noted otherwise.

optional
enabled boolean

The rule is enabled (true) or disabled (false).

required
namingPattern string

The name to be assigned to matching requests.

required
managementZones string[]

Specifies the management zones for which this rule should be applied.

optional
conditions Condition[]

The set of conditions for the request naming rule usage.

You can specify several conditions. The request has to match all the specified conditions for the rule to trigger.

required
placeholders Placeholder[]

The list of custom placeholders to be used in the naming pattern.

It enables you to extract a request attribute value or other request attribute and use it in the request naming pattern.

optional

The Placeholder object

The custom placeholder to be used as a naming value pattern.

It enables you to extract a request attribute value or other request attribute and use it in the naming pattern.

Element Type Description Required
name string

The name of the placeholder. Use it in the naming pattern as {name}.

required
attribute string

The attribute to extract from. You can only use attributes of the string type.

required
kind string

The type of extraction.

Defines either usage of regular expression (regex) or the position of request attribute value to be extracted.

When the attribute is SERVICE_REQUEST_ATTRIBUTE attribute and aggregation is COUNT, needs to be set to ORIGINAL_TEXT

required
delimiterOrRegex string

Depending on the type value:

  • REGEX_EXTRACTION: The regular expression.
  • BETWEEN_DELIMITER: The opening delimiter string to look for.
  • All other values: The delimiter string to look for.
optional
endDelimiter string

The closing delimiter string to look for.

Required if the kind value is BETWEEN_DELIMITER. Not applicable otherwise.

optional
requestAttribute string

The request attribute to extract from.

Required if the kind value is SERVICE_REQUEST_ATTRIBUTE. Not applicable otherwise.

optional
normalization string

The format of the extracted string.

optional
useFromChildCalls boolean

If true request attribute will be taken from a child service call.

Only applicable for the SERVICE_REQUEST_ATTRIBUTE attribute. Defaults to false.

optional
aggregation string

Which value of the request attribute must be used when it occurs across multiple child requests.

Only applicable for the SERVICE_REQUEST_ATTRIBUTE attribute, when useFromChildCalls is true.

For the COUNT aggregation, the kind field is not applicable.

optional
source PropagationSource optional

The PropagationSource object

Defines valid sources of request attributes for conditions or placeholders.

Element Type Description Required
managementZone string

Use only request attributes from services that belong to this management zone.. Use either this or serviceTag

optional
serviceTag UniversalTag optional

The UniversalTag object

Use only request attributes from services that have this tag. Use either this or managementZone

Element Type Description Required
tagKey UniversalTagKey optional
value string

The value of the tag. Not applicable to custom tags.

If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used.

optional
key string

The key of the tag. For custom tags, put the tag value here.

The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags.

required
context string

The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the CONTEXTLESS value.

The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, CONTEXTLESS set.

optional

The UniversalTagKey object

Element Type Description Required
context string optional
key string optional

The Condition object

A condition of a rule usage.

Element Type Description Required
attribute string

The attribute to be matched.

Note that for a service property attribute you must use the comparison of the FAST_STRING type.

required
comparisonInfo ComparisonInfo required

The ComparisonInfo object

Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.

See the Service metrics API - JSON models help topic for example models of every notification type.

Element Type Description Required
comparison string

Operator of the comparision. You can reverse it by setting negate to true.

required
value object

The value to compare to.

optional
negate boolean

Reverse the comparison operator. For example, it turns equals into does not equal.

required
type string

Defines the actual set of fields depending on the value. See one of the following objects:

  • STRING -> StringComparisonInfo
  • NUMBER -> NumberComparisonInfo
  • BOOLEAN -> BooleanComparisonInfo
  • HTTP_METHOD -> HttpMethodComparisonInfo
  • STRING_REQUEST_ATTRIBUTE -> StringRequestAttributeComparisonInfo
  • NUMBER_REQUEST_ATTRIBUTE -> NumberRequestAttributeComparisonInfo
  • ZOS_CALL_TYPE -> ZosComparisonInfo
  • IIB_INPUT_NODE_TYPE -> IIBInputNodeTypeComparisonInfo
  • ESB_INPUT_NODE_TYPE -> ESBInputNodeTypeComparisonInfo
  • FAILED_STATE -> FailedStateComparisonInfo
  • FLAW_STATE -> FlawStateComparisonInfo
  • FAILURE_REASON -> FailureReasonComparisonInfo
  • HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo
  • TAG -> TagComparisonInfo
  • FAST_STRING -> FastStringComparisonInfo
  • SERVICE_TYPE -> ServiceTypeComparisonInfo
required

Response

The request returns the short representation of the updated or newly created rule.

Response codes

Code Description
201

Success. Request naming rule has been created. Response contains the new request naming rule's ID and name.

204

Success. Request naming rule has been updated. Response doesn't have a body.

400

Failed. The input is invalid.

Response body

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestNaming/{id}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestNaming/{id}/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

Code Description
204

Validated. The submitted configuration is valid. Response does not have a body.

400

Failed. The input is invalid.

Response body

A successful request doesn't return any content.