Request attributes API - POST a request attribute
Creates a new request attribute.
The request consumes and produces an application/json
payload.
POST |
|
Authentication
To execute this request, you need the Capture request data (CaptureRequestData
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
body | RequestAttribute | body | optional |
Body format
The RequestAttribute object
Element | Type | Description | Required |
---|---|---|---|
metadata | ConfigurationMetadata | optional | |
id | string |
The ID of the request attribute. |
optional |
name | string |
The name of the request attribute. |
required |
enabled | boolean |
The request attribute is enabled ( |
required |
dataType | string |
The data type of the request attribute. |
required |
dataSources | DataSource[] |
The list of data sources. |
required |
normalization | string |
String values transformation. If the dataType is not |
required |
aggregation | string |
Aggregation type for the request values. |
required |
confidential | boolean |
Confidential data flag. Set |
required |
skipPersonalDataMasking | boolean |
Personal data masking flag. Set Warning: This will potentially access personalized data. |
required |
The DataSource object
Element | Type | Description | Required |
---|---|---|---|
enabled | boolean |
The data source is enabled ( |
required |
source | string |
The source of the attribute to capture. Works in conjunction with parameterName or methods and technology. |
required |
valueProcessing | ValueProcessing | optional | |
technology | string |
The technology of the method to capture if the source value is |
optional |
sessionAttributeTechnology | string |
The technology of the session attribute to capture if the source value is |
optional |
methods | CapturedMethod[] |
The method specification if the source value is Not applicable in other cases. |
optional |
parameterName | string |
The name of the web request parameter to capture. Required if the source is one of the following: Not applicable in other cases. |
optional |
scope | ScopeConditions | optional | |
capturingAndStorageLocation | string |
Specifies the location where the values are captured and stored. Required if the source is one of the following: Not applicable in other cases. If the source value is |
optional |
iibNodeType | string |
The IBM integration bus node type for which the value is captured. This or Not applicable in other cases. |
optional |
iibMethodNodeCondition | ValueCondition | optional | |
cicsSDKMethodNodeCondition | ValueCondition | optional | |
iibLabelMethodNodeCondition | ValueCondition | optional | |
spanAttributeKey | string |
The key of the span attribute to capture. Required if the source is: Not applicable in other cases. |
optional |
The ScopeConditions object
Conditions for data capturing.
Element | Type | Description | Required |
---|---|---|---|
serviceTechnology | string |
Only applies to this service technology. |
optional |
processGroup | string |
Only applies to this process group. Note that this can't be transferred between different clusters or environments. |
optional |
hostGroup | string |
Only applies to this host group. |
optional |
tagOfProcessGroup | string |
Only apply to process groups matching this tag. |
optional |
The CapturedMethod object
Element | Type | Description | Required |
---|---|---|---|
method | MethodReference | required | |
capture | string |
What to capture from the method. |
required |
argumentIndex | integer |
The index of the argument to capture. Set Required if the capture is set to Not applicable in other cases. |
optional |
deepObjectAccess | string |
The getter chain to apply to the captured object. It is required in one of the following cases: The capture is set to Not applicable in other cases. |
optional |
The MethodReference object
Configuration of a method to be captured.
Element | Type | Description | Required |
---|---|---|---|
visibility | string |
The visibility of the method to capture. |
required |
modifiers | string[] |
The modifiers of the method to capture. |
required |
className | string |
The class name where the method to capture resides. Either this or the fileName must be set. |
optional |
fileName | string |
The file name where the method to capture resides. Either this or className must be set. |
optional |
fileNameMatcher | string |
The operator of the comparison. If not set, |
optional |
methodName | string |
The name of the method to capture. |
required |
argumentTypes | string[] |
The list of argument types. |
required |
returnType | string |
The return type. |
required |
The ValueProcessing object
Process values as specified.
Element | Type | Description | Required |
---|---|---|---|
valueCondition | ValueCondition | optional | |
valueExtractorRegex | string |
Extract value from captured data per regex. |
optional |
splitAt | string |
Split (preprocessed) string values at this separator. |
optional |
trim | boolean |
Prune Whitespaces. Defaults to false. |
required |
extractSubstring | ExtractSubstring | optional |
The ExtractSubstring object
Preprocess by extracting a substring from the original value.
Element | Type | Description | Required |
---|---|---|---|
position | string |
The position of the extracted string relative to delimiters. |
required |
delimiter | string |
The delimiter string. |
required |
endDelimiter | string |
The end-delimiter string. Required if the position value is |
optional |
The ValueCondition object
IBM integration bus label node name condition for which the value is captured.
Element | Type | Description | Required |
---|---|---|---|
operator | string |
Operator comparing the extracted value to the comparison value. |
required |
negate | boolean |
Negate the comparison. |
required |
value | string |
The value to compare to. |
required |
The ConfigurationMetadata object
Metadata useful for debugging
Element | Type | Description | Required |
---|---|---|---|
configurationVersions | integer[] |
A Sorted list of the version numbers of the configuration. |
optional |
currentConfigurationVersions | string[] |
A Sorted list of string version numbers of the configuration. |
optional |
clusterVersion | string |
Dynatrace server version. |
optional |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"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
Code | Description |
---|---|
201 | Success. Request attribute has been created. The ID of the new configuration is returned. |
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. |
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "Dynatrace entity",
"description": "Dynatrace entity for the REST API example\n"
}
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 |
|
Authentication
To execute this request, you need the Capture request data (CaptureRequestData
) 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.