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

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.

conditions Condition[]

The set of conditions for the request naming rule usage.

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 in the request rule naming pattern.

It enables you to extract a request attribute value or other request attribute and use it in the request 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

The set of conditions for the request naming 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 information 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 the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The Enum object

Element Type Description

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

clusterVersion string

Dynatrace server version.

The StringComparisonInfo object

Type-specific comparison information for attributes of type 'STRING'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required
caseSensitive boolean

Case sensitivity for string comparisons.

optional

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the comparison element:

  • BEGINS_WITH
  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • EXISTS
  • REGEX_MATCHES

The NumberComparisonInfo object

Type-specific comparison information for attributes of type 'NUMBER'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value Number

The value to compare to.

optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

The Number object

Element Type Description Required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the comparison element:

  • EQUALS
  • EXISTS
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN
  • LOWER_THAN_OR_EQUAL

The BooleanComparisonInfo object

Type-specific comparison information for attributes of type 'BOOLEAN'. This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value boolean

The value to compare to.

optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the comparison element:

  • EQUALS
  • EXISTS

The HttpMethodComparisonInfo object

Type-specific comparison information for attributes of type 'HTTP_METHOD'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

The value element can hold these values.
optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the value element:

  • DELETE
  • GET
  • HEAD
  • POST
  • PUT
  • TRACE

Possible values for the comparison element:

  • EQUALS
  • EXISTS

The NumberRequestAttributeComparisonInfo object

Type-specific comparison information for attributes of type 'NUMBER_REQUEST_ATTRIBUTE', specifically of generic type Number. This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value Number

The value to compare to.

optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required
requestAttribute string required

The Number object

Element Type Description Required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the comparison element:

  • EQUALS
  • EXISTS
  • GREATER_THAN
  • GREATER_THAN_OR_EQUAL
  • LOWER_THAN
  • LOWER_THAN_OR_EQUAL

The ZosComparisonInfo object

Type-specific comparison information for attributes of type 'ZOS_CALL_TYPE'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

The value element can hold these values.
optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the value element:

  • CTG
  • DPL
  • EXPLICIT_ADK
  • IMS_CONNECT
  • IMS_CONNECT_API
  • IMS_ITRA
  • IMS_MSC
  • IMS_PGM_SWITCH
  • IMS_SHARED_QUEUES
  • IMS_TRANS_EXEC
  • MQ
  • SOAP
  • START
  • TX
  • UNKNOWN

Possible values for the comparison element:

  • EQUALS
  • EXISTS

The IIBInputNodeTypeComparisonInfo object

Type-specific comparison information for attributes of type 'IIB_INPUT_NODE_TYPE'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

The value element can hold these values.
optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the value element:

  • CALLABLE_FLOW_ASYNC_RESPONSE_NODE
  • CALLABLE_FLOW_INPUT_NODE
  • DATABASE_INPUT_NODE
  • DOTNET_INPUT_NODE
  • EMAIL_INPUT_NODE
  • EVENT_INPUT
  • EVENT_INPUT_NODE
  • FILE_INPUT_NODE
  • FTE_INPUT_NODE
  • HTTP_ASYNC_RESPONSE
  • JD_EDWARDS_INPUT_NODE
  • JMS_CLIENT_INPUT_NODE
  • LABEL_NODE
  • MQ_INPUT_NODE
  • PEOPLE_SOFT_INPUT_NODE
  • REST_ASYNC_RESPONSE
  • REST_REQUEST
  • SAP_INPUT_NODE
  • SCA_ASYNC_RESPONSE_NODE
  • SCA_INPUT_NODE
  • SIEBEL_INPUT_NODE
  • SOAP_INPUT_NODE
  • TCPIP_CLIENT_INPUT_NODE
  • TCPIP_CLIENT_REQUEST_NODE
  • TCPIP_SERVER_INPUT_NODE
  • TCPIP_SERVER_REQUEST_NODE
  • TIMEOUT_NOTIFICATION_NODE
  • WS_INPUT_NODE

Possible values for the comparison element:

  • EQUALS
  • EXISTS

The FailedStateComparisonInfo object

Type-specific comparison information for attributes of type 'FAILED_STATE'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

The value element can hold these values.
optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the value element:

  • FAILED
  • SUCCESSFUL

Possible values for the comparison element:

  • EQUALS
  • EXISTS

The FlawStateComparisonInfo object

Type-specific comparison information for attributes of type 'FLAW_STATE'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

The value element can hold these values.
optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the value element:

  • FLAWED
  • NOT_FLAWED

Possible values for the comparison element:

  • EQUALS
  • EXISTS

The EntityIdComparisonInfo object

Type-specific comparison information for attributes of type 'ENTITY_ID'.This model also inherits fields from the parent model ComparisonInfo.

Element Type Description Required
comparison string

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

The comparison element can hold these values.
required
value string

The value to compare to.

optional
negate boolean

Reverse the comparison operator. For example it turns the begin with into does not begin with.

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 FAILED_STATE -> FailedStateComparisonInfo FLAW_STATE -> FlawStateComparisonInfo ENTITY_ID -> EntityIdComparisonInfo FAILURE_REASON -> FailureReasonComparisonInfo HTTP_STATUS_CLASS -> HttpStatusClassComparisonInfo

The type element can hold these values.
required

Possible values

Possible values for the type element:

  • STRING
  • NUMBER
  • BOOLEAN
  • HTTP_METHOD
  • STRING_REQUEST_ATTRIBUTE
  • NUMBER_REQUEST_ATTRIBUTE
  • ZOS_CALL_TYPE
  • IIB_INPUT_NODE_TYPE
  • FAILED_STATE
  • FLAW_STATE
  • ENTITY_ID
  • FAILURE_REASON
  • HTTP_STATUS_CLASS

Possible values for the comparison element:

  • EQUALS
  • EXISTS