Request naming API - GET a request naming rule

Gets parameters of the specified request naming rule.

The request produces an application/json payload.

GET
  • 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}

Parameters

Parameter Type Description In Required
id string

The ID of the request naming rule you're inquiring.

path required

Response format

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

The RequestNaming object

The request naming rule.

Element Type Description
metadata ConfigurationMetadata

Metadata useful for debugging.

id string

The ID of the request naming rule.

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.

enabled boolean

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

namingPattern string

The name to be assigned to matching requests.

managementZones string[]

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

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.

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.

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
name string

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

attribute string

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

kind string

The type of extraction.

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

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.
endDelimiter string

The closing delimiter string to look for.

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

requestAttribute string

The request attribute to extract from.

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

normalization string

The format of the extracted string.

The Condition object

A condition of a rule usage.

Element Type Description
attribute string

The attribute to be matched.

comparisonInfo ComparisonInfo

How to match the attribute.

The ComparisonInfo object

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

Element Type Description
comparison Enum

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

value object

The value to compare to.

negate boolean

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

type string

Defines the actual set of fields depending on the value:

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

The Enum object

Element Type Description

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
clusterVersion string

Dynatrace server version.

configurationVersions integer[]

A Sorted list of the version numbers of the configuration.