• Home
  • Dynatrace API
  • Configuration
  • Services
  • Request attributes
  • PUT a request attribute

Request attributes API - PUT a request attribute

Updates the specified request attribute.

The request consumes and produces an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestAttributes/{id}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestAttributes/{id}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/requestAttributes/{id}

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
idstring

The ID of the request attribute to be updated.

If you set the ID in the body as well, it must match this ID.

pathrequired
bodyRequestAttribute-bodyrequired

Request body objects

The RequestAttribute object

ElementTypeDescriptionRequired
metadataConfigurationMetadata

Metadata useful for debugging

optional
idstring

The ID of the request attribute.

optional
namestring

The name of the request attribute.

required
enabledboolean

The request attribute is enabled (true) or disabled (false).

required
dataTypestring

The data type of the request attribute.

The element can hold these values
  • DOUBLE
  • INTEGER
  • STRING
required
dataSourcesDataSource[]

The list of data sources.

required
normalizationstring

String values transformation.

If the dataType is not string, set the Original here.

The element can hold these values
  • ORIGINAL
  • TO_LOWER_CASE
  • TO_UPPER_CASE
required
aggregationstring

Aggregation type for the request values.

The element can hold these values
  • ALL_DISTINCT_VALUES
  • AVERAGE
  • COUNT_DISTINCT_VALUES
  • COUNT_VALUES
  • FIRST
  • LAST
  • MAXIMUM
  • MINIMUM
  • SUM
required
confidentialboolean

Confidential data flag. Set true to treat the captured data as confidential.

required
skipPersonalDataMaskingboolean

Personal data masking flag. Set true to skip masking.

Warning: This will potentially access personalized data.

required

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional
clusterVersionstring

Dynatrace version.

optional

The DataSource object

ElementTypeDescriptionRequired
enabledboolean

The data source is enabled (true) or disabled (false).

required
sourcestring

The source of the attribute to capture. Works in conjunction with parameterName or methods and technology.

The element can hold these values
  • CICS_SDK
  • CICS_SYSTEM_ID
  • CICS_TASK_ID
  • CICS_TRANSACTION_CALL_TYPE
  • CLIENT_IP
  • CUSTOM_ATTRIBUTE
  • DLI_DB_OR_LTERM_NAME
  • DLI_SEGMENT_NAME
  • IIB_LABEL
  • IIB_NODE
  • IMS_TRANSACTION_CALL_TYPE
  • METHOD_PARAM
  • MQ_CORRELATION_ID
  • MQ_MESSAGE_ID
  • MQ_MESSAGE_SIZE
  • POST_PARAMETER
  • QUERY_PARAMETER
  • REQUEST_HEADER
  • RESPONSE_HEADER
  • SERVER_VARIABLE
  • SESSION_ATTRIBUTE
  • SPAN_ATTRIBUTE
  • URI
  • URI_PATH
  • WEBSERVICE_METHOD
  • WEBSERVICE_NAME
required
valueProcessingValueProcessing

Process values as specified.

optional
technologystring

The technology of the method to capture if the source value is METHOD_PARAM. \n\n Not applicable in other cases.

The element can hold these values
  • DOTNET
  • JAVA
  • PHP
optional
sessionAttributeTechnologystring

The technology of the session attribute to capture if the source value is SESSION_ATTRIBUTE. \n\n Not applicable in other cases.

The element can hold these values
  • ASP_NET
  • ASP_NET_CORE
  • JAVA
  • PHP
optional
serverVariableTechnologystring

The technology of the server variable to capture if the source value is SERVER_VARIABLE. \n\n Not applicable in other cases.

The element can hold these values
  • ASP_NET
optional
methodsCapturedMethod[]

The method specification if the source value is METHOD_PARAM.

Not applicable in other cases.

optional
parameterNamestring

The name of the web request parameter to capture.

Required if the source is one of the following: POST_PARAMETER, GET_PARAMETER, REQUEST_HEADER, RESPONSE_HEADER, CUSTOM_ATTRIBUTE.

Not applicable in other cases.

optional
scopeScopeConditions

Conditions for data capturing.

optional
capturingAndStorageLocationstring

Specifies the location where the values are captured and stored.

Required if the source is one of the following: GET_PARAMETER, URI, REQUEST_HEADER, RESPONSE_HEADER.

Not applicable in other cases.

If the source value is REQUEST_HEADER or RESPONSE_HEADER, the CAPTURE_AND_STORE_ON_BOTH location is not allowed.

The element can hold these values
  • CAPTURE_AND_STORE_ON_BOTH
  • CAPTURE_AND_STORE_ON_CLIENT
  • CAPTURE_AND_STORE_ON_SERVER
  • CAPTURE_ON_CLIENT_STORE_ON_SERVER
optional
iibNodeTypestring

The IBM integration bus node type for which the value is captured.

This or iibMethodNodeCondition is required if the source is: IIB_NODE.

Not applicable in other cases.

The element can hold these values
  • AGGREGATE_CONTROL_NODE
  • AGGREGATE_REPLY_NODE
  • AGGREGATE_REQUEST_NODE
  • CALLABLE_FLOW_REPLY_NODE
  • COLLECTOR_NODE
  • COMPUTE_NODE
  • DATABASE_NODE
  • DATABASE_RETRIEVE_NODE
  • DATABASE_ROUTE_NODE
  • DECISION_SERVICE_NODE
  • DOT_NET_COMPUTE_NODE
  • FILE_READ_NODE
  • FILTER_NODE
  • FLOW_ORDER_NODE
  • GROUP_COMPLETE_NODE
  • GROUP_GATHER_NODE
  • GROUP_SCATTER_NODE
  • HTTP_ASYNC_REQUEST
  • HTTP_ASYNC_RESPONSE
  • HTTP_HEADER
  • HTTP_INPUT
  • HTTP_REPLY
  • HTTP_REQUEST
  • JAVA_COMPUTE_NODE
  • JMS_CLIENT_RECEIVE
  • JMS_CLIENT_REPLY_NODE
  • JMS_HEADER
  • JMS_INPUT_NODE
  • JMS_OUTPUT_NODE
  • JMS_REPLY_NODE
  • MQ_GET_NODE
  • MQ_INPUT_NODE
  • MQ_OUTPUT_NODE
  • MQ_REPLY_NODE
  • PASSTHRU_NODE
  • PUBLICATION_NODE
  • RESET_CONTENT_DESCRIPTOR_NODE
  • REST_ASYNC_REQUEST_NODE
  • REST_ASYNC_RESPONSE_NODE
  • REST_REQUEST_NODE
  • RE_SEQUENCE_NODE
  • ROUTE_NODE
  • SAP_REPLY_NODE
  • SCA_REPLY_NODE
  • SECURITY_PEP
  • SEQUENCE_NODE
  • SOAP_ASYNC_REQUEST_NODE
  • SOAP_ASYNC_RESPONSE_NODE
  • SOAP_EXTRACT_NODE
  • SOAP_INPUT_NODE
  • SOAP_REPLY_NODE
  • SOAP_REQUEST_NODE
  • SOAP_WRAPPER_NODE
  • SR_RETRIEVE_ENTITY_NODE
  • SR_RETRIEVE_IT_SERVICE_NODE
  • THROW_NODE
  • TRACE_NODE
  • TRY_CATCH_NODE
  • VALIDATE_NODE
  • WS_REPLY_NODE
  • XSL_MQSI_NODE
optional
iibMethodNodeConditionValueCondition

IBM integration bus label node name condition for which the value is captured.

optional
cicsSDKMethodNodeConditionValueCondition

IBM integration bus label node name condition for which the value is captured.

optional
iibLabelMethodNodeConditionValueCondition

IBM integration bus label node name condition for which the value is captured.

optional
spanAttributeKeystring

The key of the span attribute to capture.

Required if the source is: SPAN_ATTRIBUTE.

Not applicable in other cases.

optional
cicsTransactionCallTypestring

CICS transaction call type condition for which the value is captured.

Required if the source is: CICS_TRANSACTION_CALL_TYPE.

Not applicable in other cases.

The element can hold these values
  • CTG
  • DPL
  • EXPLICIT_ADK
  • HTTP
  • IMS_CONNECT
  • IMS_CONNECT_API
  • IMS_ITRA
  • IMS_MSC
  • IMS_PGM_SWITCH
  • IMS_SHARED_QUEUES
  • IMS_TRANS_EXEC
  • MQ
  • SOAP
  • START
  • TTX
  • TX
  • UNKNOWN
  • ZOS_CONNECT
optional
imsTransactionCallTypestring

IMS transaction call type condition for which the value is captured.

Required if the source is: IMS_TRANSACTION_CALL_TYPE.

Not applicable in other cases.

The element can hold these values
  • CTG
  • DPL
  • EXPLICIT_ADK
  • HTTP
  • IMS_CONNECT
  • IMS_CONNECT_API
  • IMS_ITRA
  • IMS_MSC
  • IMS_PGM_SWITCH
  • IMS_SHARED_QUEUES
  • IMS_TRANS_EXEC
  • MQ
  • SOAP
  • START
  • TTX
  • TX
  • UNKNOWN
  • ZOS_CONNECT
optional

The ValueProcessing object

Process values as specified.

ElementTypeDescriptionRequired
valueConditionValueCondition

IBM integration bus label node name condition for which the value is captured.

optional
valueExtractorRegexstring

Extract value from captured data per regex.

optional
splitAtstring

Split (preprocessed) string values at this separator.

optional
trimboolean

Prune Whitespaces. Defaults to false.

required
extractSubstringExtractSubstring

Preprocess by extracting a substring from the original value.

optional

The ValueCondition object

IBM integration bus label node name condition for which the value is captured.

ElementTypeDescriptionRequired
operatorstring

Operator comparing the extracted value to the comparison value.

The element can hold these values
  • BEGINS_WITH
  • BEGINS_WITH_ANY_OF
  • CONTAINS
  • ENDS_WITH
  • ENDS_WITH_ANY_OF
  • EQUALS
  • EQUALS_ANY_OF
required
negateboolean

Negate the comparison.

required
valuestring

The value to compare to.

required

The ExtractSubstring object

Preprocess by extracting a substring from the original value.

ElementTypeDescriptionRequired
positionstring

The position of the extracted string relative to delimiters.

The element can hold these values
  • AFTER
  • BEFORE
  • BETWEEN
required
delimiterstring

The delimiter string.

required
endDelimiterstring

The end-delimiter string.

Required if the position value is BETWEEN. Otherwise not allowed.

optional

The CapturedMethod object

ElementTypeDescriptionRequired
methodMethodReference

Configuration of a method to be captured.

required
capturestring

What to capture from the method.

The element can hold these values
  • ARGUMENT
  • CLASS_NAME
  • METHOD_NAME
  • OCCURRENCES
  • SIMPLE_CLASS_NAME
  • THIS
required
argumentIndexinteger

The index of the argument to capture. Set 0 to capture the return value, 1 or higher to capture a mehtod argument.

Required if the capture is set to ARGUMENT.

Not applicable in other cases.

optional
deepObjectAccessstring

The getter chain to apply to the captured object. It is required in one of the following cases:

The capture is set to THIS. The capture is set to ARGUMENT, and the argument is not a primitive, a primitive wrapper class, a string, or an array.

Not applicable in other cases.

optional

The MethodReference object

Configuration of a method to be captured.

ElementTypeDescriptionRequired
visibilitystring

The visibility of the method to capture.

The element can hold these values
  • INTERNAL
  • PACKAGE_PROTECTED
  • PRIVATE
  • PROTECTED
  • PUBLIC
required
modifiersstring[]

The modifiers of the method to capture.

The element can hold these values
  • ABSTRACT
  • EXTERN
  • FINAL
  • NATIVE
  • STATIC
required
classNamestring

The class name where the method to capture resides.

Either this or the fileName must be set.

optional
fileNamestring

The file name where the method to capture resides.

Either this or className must be set.

optional
fileNameMatcherstring

The operator of the comparison.

If not set, EQUALS is used.

The element can hold these values
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH
optional
methodNamestring

The name of the method to capture.

required
argumentTypesstring[]

The list of argument types.

required
returnTypestring

The return type.

required

The ScopeConditions object

Conditions for data capturing.

ElementTypeDescriptionRequired
serviceTechnologystring

Only applies to this service technology.

The element can hold these values
  • ACTIVE_MQ
  • ACTIVE_MQ_ARTEMIS
  • ADO_NET
  • AIX
  • AKKA
  • AMAZON_REDSHIFT
  • AMQP
  • APACHE_CAMEL
  • APACHE_CASSANDRA
  • APACHE_COUCH_DB
  • APACHE_DERBY
  • APACHE_HTTP_CLIENT_ASYNC
  • APACHE_HTTP_CLIENT_SYNC
  • APACHE_HTTP_SERVER
  • APACHE_KAFKA
  • APACHE_LOG4J
  • APACHE_SOLR
  • APACHE_STORM
  • APACHE_SYNAPSE
  • APACHE_TOMCAT
  • APPARMOR
  • APPLICATION_INSIGHTS_SDK
  • ASP_DOTNET
  • ASP_DOTNET_CORE
  • ASP_DOTNET_CORE_SIGNALR
  • ASP_DOTNET_SIGNALR
  • ASYNC_HTTP_CLIENT
  • AWS_DYNAMO_DB
  • AWS_LAMBDA
  • AWS_RDS
  • AWS_SERVICE
  • AXIS
  • AZURE_FUNCTIONS
  • AZURE_SERVICE_BUS
  • AZURE_SERVICE_FABRIC
  • AZURE_STORAGE
  • BOSHBPM
  • CICS_FILE_ACCESS
  • CITRIX
  • CITRIX_COMMON
  • CITRIX_DESKTOP_DELIVERY_CONTROLLERS
  • CITRIX_DIRECTOR
  • CITRIX_LICENSE_SERVER
  • CITRIX_PROVISIONING_SERVICES
  • CITRIX_STOREFRONT
  • CITRIX_VIRTUAL_DELIVERY_AGENT
  • CITRIX_WORKSPACE_ENVIRONMENT_MANAGEMENT
  • CITRIX_XEN
  • CLOUDFOUNDRY
  • CLOUDFOUNDRY_AUCTIONEER
  • CLOUDFOUNDRY_BOSH
  • CLOUDFOUNDRY_GOROUTER
  • COLDFUSION
  • CONFLUENT_KAFKA_CLIENT
  • CONTAINERD
  • CORE_DNS
  • COUCHBASE
  • CRIO
  • CXF
  • DATASTAX
  • DB2
  • DIEGO_CELL
  • DOCKER
  • DOTNET
  • DOTNET_REMOTING
  • ELASTIC_SEARCH
  • ENVOY
  • ERLANG
  • ETCD
  • F5_LTM
  • FSHARP
  • GARDEN
  • GLASSFISH
  • GO
  • GOOGLE_CLOUD_FUNCTIONS
  • GRAAL_TRUFFLE
  • GRAPH_QL
  • GRPC
  • GRSECURITY
  • HADOOP
  • HADOOP_HDFS
  • HADOOP_YARN
  • HAPROXY
  • HEAT
  • HESSIAN
  • HORNET_Q
  • IBM_CICS_REGION
  • IBM_CICS_TRANSACTION_GATEWAY
  • IBM_IMS_CONNECT_REGION
  • IBM_IMS_CONTROL_REGION
  • IBM_IMS_MESSAGE_PROCESSING_REGION
  • IBM_IMS_SOAP_GATEWAY
  • IBM_INTEGRATION_BUS
  • IBM_MQ
  • IBM_MQ_CLIENT
  • IBM_WEBSHPRERE_APPLICATION_SERVER
  • IBM_WEBSHPRERE_LIBERTY
  • IBM_WEBSPHERE_APPLICATION_SERVER
  • IBM_WEBSPHERE_LIBERTY
  • IIS
  • IIS_APP_POOL
  • ISTIO
  • JAVA
  • JAX_WS
  • JBOSS
  • JBOSS_EAP
  • JDK_HTTP_CLIENT
  • JDK_HTTP_SERVER
  • JERSEY
  • JETTY
  • JRUBY
  • JYTHON
  • KUBERNETES
  • LIBC
  • LIBVIRT
  • LINKERD
  • LINUX_SYSTEM
  • MARIADB
  • MEMCACHED
  • MICROSOFT_SQL_SERVER
  • MONGODB
  • MSSQL_CLIENT
  • MULE_ESB
  • MYSQL
  • MYSQL_CONNECTOR
  • NETFLIX_SERVO
  • NETTY
  • NGINX
  • NODE_JS
  • OK_HTTP_CLIENT
  • ONEAGENT_SDK
  • OPENCENSUS
  • OPENSHIFT
  • OPENSTACK_COMPUTE
  • OPENSTACK_CONTROLLER
  • OPENTELEMETRY
  • OPENTRACING
  • OPEN_LIBERTY
  • ORACLE_DATABASE
  • ORACLE_WEBLOGIC
  • OWIN
  • PERL
  • PHP
  • PHP_FPM
  • PLAY
  • PODMAN
  • POSTGRE_SQL
  • POSTGRE_SQL_DOTNET_DATA_PROVIDER
  • POWER_DNS
  • PROGRESS
  • PYTHON
  • QOS_LOGBACK
  • RABBIT_MQ
  • REACTOR_CORE
  • REDIS
  • RESTEASY
  • RESTLET
  • RIAK
  • RSOCKET
  • RUBY
  • RUNC
  • RXJAVA
  • SAG_WEBMETHODS_IS
  • SAP
  • SAP_HANADB
  • SAP_HYBRIS
  • SAP_MAXDB
  • SAP_SYBASE
  • SCALA
  • SELINUX
  • SHAREPOINT
  • SPARK
  • SPRING
  • SQLITE
  • THRIFT
  • TIBCO
  • TIBCO_BUSINESS_WORKS
  • TIBCO_EMS
  • UNDERTOW_IO
  • VARNISH_CACHE
  • VERTX
  • VIM2
  • VIOS
  • VIRTUAL_MACHINE_KVM
  • VIRTUAL_MACHINE_QEMU
  • WILDFLY
  • WINDOWS_CONTAINERS
  • WINDOWS_SYSTEM
  • WINK
  • ZERO_MQ
  • ZOS_CONNECT
optional
processGroupstring

Only applies to this process group. Note that this can't be transferred between different clusters or environments.

optional
hostGroupstring

Only applies to this host group.

optional
tagOfProcessGroupstring

Only apply to process groups matching this tag.

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.

json
{ "name": "Query Term", "enabled": true, "dataType": "STRING", "dataSources": [ { "enabled": true, "source": "QUERY_PARAMETER", "parameterName": "query", "scope": { "tagOfProcessGroup": "SearchFrontend" }, "capturingAndStorageLocation": "CAPTURE_AND_STORE_ON_SERVER" } ], "normalization": "TO_LOWER_CASE", "aggregation": "ALL_DISTINCT_VALUES", "confidential": false, "skipPersonalDataMasking": false }

Response

Response codes

CodeTypeDescription
201EntityShortRepresentation

Success. The request attribute with the specified ID has been created. The ID of the new configuration is returned.

204

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

400ErrorEnvelope

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

ElementTypeDescription
idstring

The ID of the Dynatrace entity.

namestring

The name of the Dynatrace entity.

descriptionstring

A short description of the Dynatrace entity.

Response body JSON model

json
{ "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a", "name": "Dynatrace entity", "description": "Dynatrace entity for the REST API example" }

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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/service/requestAttributes/{id}/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/requestAttributes/{id}/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/service/requestAttributes/{id}/validator

Authentication

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

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

Response

Response codes

CodeTypeDescription
204

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

400ErrorEnvelope

Failed. The input is invalid.

Related topics
  • Request attributes

    Understand what request attributes are and learn how to use them across all levels of all service-analysis views.