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}

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

The RequestNaming object

The request naming rule.

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
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.

The attribute element can hold these values.
required
kind string

The type of extraction.

Defines either usage of regular expression (regex) or the position of request attribute value to be extracted. Does not need to be specified if attribute is SERVICE_REQUEST_ATTRIBUTE and aggregation is COUNT.

The kind element can hold these values.
optional
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.

The normalization element can hold these values.
optional
useFromChildCalls boolean

Only applicable for SERVICE_REQUEST_ATTRIBUTE. If true request attribute will be taken from a child service call.

Defaults to false

optional
aggregation string

Only applicable for SERVICE_REQUEST_ATTRIBUTE when useFromChildCalls is true. When the request attribute occurs across multiple child requests the value may differ. Specify which value should be taken. If COUNT is used, then no kind needs to be specified.

The aggregation element can hold these values.
optional

The Condition object

A condition of a rule usage.

Element Type Description Required
attribute string

The attribute to be matched.

The attribute element can hold these values.
required
comparisonInfo ComparisonInfo

How to match the attribute.

required

The ComparisonInfo object

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

Element Type Description Required
comparison Enum

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:

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 type element can hold these values.
required

The Enum object

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
clusterVersion string

Dynatrace server version.

optional
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional

Possible values

Possible values for the aggregation element in the Placeholder object:

  • COUNT
  • FIRST
  • LAST

Possible values for the normalization element in the Placeholder object:

  • ORIGINAL
  • TO_LOWER_CASE
  • TO_UPPER_CASE

Possible values for the kind element in the Placeholder object:

  • AFTER_DELIMITER
  • BEFORE_DELIMITER
  • BETWEEN_DELIMITER
  • REGEX_EXTRACTION

Possible values for the type element in the ComparisonInfo object:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • ESB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • FAILURE_REASON
  • HTTP_STATUS_CLASS
  • TAG
  • FAST_STRING
  • SERVICE_TYPE

Possible values for the attribute element in the Condition object:

  • ACTOR_SYSTEM
  • AKKA_ACTOR_CLASS_NAME
  • AKKA_ACTOR_MESSAGE_TYPE
  • AKKA_ACTOR_PATH
  • AZURE_FUNCTIONS_FUNCTION_NAME
  • AZURE_FUNCTIONS_SITE_NAME
  • CICS_PROGRAM_NAME
  • CICS_SYSTEM_ID
  • CICS_TASK_ID
  • CICS_TRANSACTION_ID
  • CPU_TIME
  • CTG_GATEWAY_URL
  • CTG_PROGRAM
  • CTG_SERVER_NAME
  • CTG_TRANSACTION_ID
  • CUSTOMSERVICE_CLASS
  • CUSTOMSERVICE_METHOD
  • DATABASE_CHILD_CALL_COUNT
  • DATABASE_CHILD_CALL_TIME
  • ERROR_COUNT
  • ESB_APPLICATION_NAME
  • ESB_INPUT_TYPE
  • ESB_LIBRARY_NAME
  • ESB_MESSAGE_FLOW_NAME
  • EXCEPTION_CLASS
  • EXCEPTION_MESSAGE
  • FAILED_STATE
  • FAILURE_REASON
  • FLAW_STATE
  • HTTP_REQUEST_METHOD
  • HTTP_STATUS
  • HTTP_STATUS_CLASS
  • IMS_PROGRAM_NAME
  • IMS_TRANSACTION_ID
  • IO_TIME
  • LOCK_TIME
  • MESSAGING_DESTINATION_TYPE
  • MESSAGING_IS_TEMPORARY_QUEUE
  • MESSAGING_QUEUE_NAME
  • MESSAGING_QUEUE_VENDOR
  • NON_DATABASE_CHILD_CALL_COUNT
  • NON_DATABASE_CHILD_CALL_TIME
  • PROCESS_GROUP_NAME
  • PROCESS_GROUP_TAG
  • REMOTE_ENDPOINT
  • REMOTE_METHOD
  • REMOTE_SERVICE_NAME
  • REQUEST_NAME
  • REQUEST_TYPE
  • RESPONSE_TIME
  • RESPONSE_TIME_CLIENT
  • RMI_CLASS
  • RMI_METHOD
  • SERVICE_DISPLAY_NAME
  • SERVICE_NAME
  • SERVICE_PORT
  • SERVICE_PUBLIC_DOMAIN_NAME
  • SERVICE_REQUEST_ATTRIBUTE
  • SERVICE_TAG
  • SERVICE_TYPE
  • SERVICE_WEB_APPLICATION_ID
  • SERVICE_WEB_CONTEXT_ROOT
  • SERVICE_WEB_SERVER_NAME
  • SERVICE_WEB_SERVICE_NAME
  • SERVICE_WEB_SERVICE_NAMESPACE
  • SUSPENSION_TIME
  • TOTAL_PROCESSING_TIME
  • WAIT_TIME
  • WEBREQUEST_QUERY
  • WEBREQUEST_URL
  • WEBREQUEST_URL_HOST
  • WEBREQUEST_URL_PATH
  • WEBREQUEST_URL_PORT
  • WEBSERVICE_ENDPOINT
  • WEBSERVICE_METHOD
  • ZOS_CALL_TYPE

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 format

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

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.

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

Response codes

Code Description
204 Validated. The submitted configuration is valid. Response does not have a body.
400 Failed. The input is invalid.