Service metrics API - JSON models
Some JSON models of the Calculated service metrics API vary according to the type of some objects. Here you can find JSON models for each variation.
Variations of the ComparisonInfo object
BOOLEAN
The BooleanComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | boolean |
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. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": true,
"negate": false,
"type": "BOOLEAN"
}
ESB_INPUT_NODE_TYPE
The ESBInputNodeTypeComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
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
{
"comparison": "EQUALS",
"value": "EVENT_INPUT_NODE",
"negate": false,
"type": "ESB_INPUT_NODE_TYPE"
}
FAILED_STATE
The FailedStateComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the value element:
- FAILED
- SUCCESSFUL
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": "SUCCESSFUL",
"negate": false,
"type": "FAILED_STATE "
}
FAILURE_REASON
The FailureReasonComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the value element:
- EXCEPTION_AT_ENTRY_NODE
- EXCEPTION_ON_ANY_NODE
- HTTP_CODE
- REQUEST_ATTRIBUTE
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": "EXCEPTION_ON_ANY_NODE",
"negate": false,
"type": "FAILURE_REASON"
}
FAST_STRING
The FastStringComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | string |
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. See one of the following objects:
|
required |
| caseSensitive | boolean |
The comparison is case-sensitive ( |
optional |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the comparison element:
- CONTAINS
- EQUALS
{
"comparison": "CONTAINS",
"value": "sample",
"negate": false,
"type": "FAST_STRING"
}
FLAW_STATE
The FlawStateComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the value element:
- FLAWED
- NOT_FLAWED
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": "FLAWED",
"negate": false,
"type": "FLAW_STATE"
}
HTTP_METHOD
The HttpMethodComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the value element:
- CONNECT
- DELETE
- GET
- HEAD
- OPTIONS
- PATCH
- POST
- PUT
- TRACE
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": "POST",
"negate": false,
"type": "HTTP_METHOD"
}
HTTP_STATUS_CLASS
The HttpStatusClassComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the value element:
- C_1XX
- C_2XX
- C_3XX
- C_4XX
- C_5XX
- NO_RESPONSE
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": "C_2XX",
"negate": false,
"type": "HTTP_STATUS_CLASS"
}
IIB_INPUT_NODE_TYPE
The IIBInputNodeTypeComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
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
{
"comparison": "EQUALS",
"value": "JMS_CLIENT_INPUT_NODE",
"negate": false,
"type": "IIB_INPUT_NODE_TYPE"
}
NUMBER
The NumberComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | number |
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. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the comparison element:
- EQUALS
- EXISTS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- LOWER_THAN
- LOWER_THAN_OR_EQUAL
{
"comparison": "GREATER_THAN_OR_EQUAL",
"value": {},
"negate": false,
"type": "NUMBER"
}
NUMBER_REQUEST_ATTRIBUTE
The NumberRequestAttributeComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | number |
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. See one of the following objects:
|
required |
| requestAttribute | string | required | |
| matchOnChildCalls | boolean |
If Default is |
optional |
| source | PropagationSource | optional |
The PropagationSource object
Defines valid sources of request attributes for conditions or placeholders.
| Element | Type | Description | Required |
|---|---|---|---|
| managementZone | string |
Use only request attributes from services that belong to this management zone.. Use either this or |
optional |
| serviceTag | UniversalTag | optional |
The UniversalTag object
Use only request attributes from services that have this tag. Use either this or managementZone
| Element | Type | Description | Required |
|---|---|---|---|
| tagKey | UniversalTagKey | optional | |
| value | string |
The value of the tag. Not applicable to custom tags. If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used. |
optional |
| key | string |
The key of the tag. For custom tags, put the tag value here. The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags. |
required |
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, |
optional |
The UniversalTagKey object
| Element | Type | Description | Required |
|---|---|---|---|
| context | string | The context element can hold these values. | optional |
| key | string | optional |
Possible values
Possible values for the context element in the UniversalTagKey object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_COMPUTE_ENGINE
- KUBERNETES
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the comparison element:
- EQUALS
- EXISTS
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- LOWER_THAN
- LOWER_THAN_OR_EQUAL
{
"comparison": "GREATER_THAN",
"value": {},
"negate": false,
"type": "NUMBER_REQUEST_ATTRIBUTE",
"requestAttribute": "sample"
}
SERVICE_TYPE
The ServiceTypeComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the value element:
- BACKGROUND_ACTIVITY
- CICS_SERVICE
- CUSTOM_SERVICE
- DATABASE_SERVICE
- ENTERPRISE_SERVICE_BUS_SERVICE
- EXTERNAL
- IBM_INTEGRATION_BUS_SERVICE
- IMS_SERVICE
- MESSAGING_SERVICE
- QUEUE_LISTENER_SERVICE
- RMI_SERVICE
- RPC_SERVICE
- WEB_REQUEST_SERVICE
- WEB_SERVICE
Possible values for the comparison element:
- EQUALS
- EXISTS
{
"comparison": "EQUALS",
"value": "BACKGROUND_ACTIVITY",
"negate": false,
"type": "SERVICE_TYPE"
}
STRING
The StringComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | string |
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. See one of the following objects:
|
required |
| caseSensitive | boolean |
The comparison is case-sensitive ( |
optional |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the comparison element:
- BEGINS_WITH
- CONTAINS
- ENDS_WITH
- EQUALS
- EXISTS
- REGEX_MATCHES
{
"comparison": "ENDS_WITH",
"value": "sample",
"negate": false,
"type": "STRING",
"caseSensitive": false
}
STRING_REQUEST_ATTRIBUTE
The StringRequestAttributeComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | string |
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. See one of the following objects:
|
required |
| requestAttribute | string | required | |
| caseSensitive | boolean |
The comparison is case-sensitive ( |
optional |
| matchOnChildCalls | boolean |
If Default is |
optional |
| source | PropagationSource | optional |
The PropagationSource object
Defines valid sources of request attributes for conditions or placeholders.
| Element | Type | Description | Required |
|---|---|---|---|
| managementZone | string |
Use only request attributes from services that belong to this management zone.. Use either this or |
optional |
| serviceTag | UniversalTag | optional |
The UniversalTag object
Use only request attributes from services that have this tag. Use either this or managementZone
| Element | Type | Description | Required |
|---|---|---|---|
| tagKey | UniversalTagKey | optional | |
| value | string |
The value of the tag. Not applicable to custom tags. If a tag does have a separate key and value (in the textual representation they are split by the colon ‘:’), this field is set with the actual value. Key-value pairs can occur for automatically imported tags and tags set by rules if extractors are used. |
optional |
| key | string |
The key of the tag. For custom tags, put the tag value here. The key allows categorization of multiple tags. It is possible that there are multiple values for a single key which will all be represented as standalone tags. Therefore, the key does not have the semantic of a map key but is more like a key of a key-value tuple. In some cases, for example custom tags, the key represents the actual tag value and the value field is not set – those are called valueless tags. |
required |
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. For custom tags use the The context is set for tags that are automatically imported by OneAgent (for example, from the AWS console or environment variables). It’s useful for determining the origin of tags when not manually defined, and it also helps to prevent clashes with other existing tags. If the tag is not automatically imported, |
optional |
The UniversalTagKey object
| Element | Type | Description | Required |
|---|---|---|---|
| context | string | The context element can hold these values. | optional |
| key | string | optional |
Possible values
Possible values for the context element in the UniversalTagKey object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_COMPUTE_ENGINE
- KUBERNETES
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the comparison element:
- BEGINS_WITH
- CONTAINS
- ENDS_WITH
- EQUALS
- EXISTS
- REGEX_MATCHES
{
"comparison": "BEGINS_WITH",
"value": "sample",
"negate": false,
"type": "STRING_REQUEST_ATTRIBUTE",
"requestAttribute": "myAttribute",
"caseSensitive": false
}
TAG
The TagComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
required |
| value | TagInfo | 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. See one of the following objects:
|
required |
The TagInfo object
Tag of a Dynatrace entity.
| Element | Type | Description | Required |
|---|---|---|---|
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
required |
| key | string |
The key of the tag. Custom tags have the tag value here. |
required |
| value | string |
The value of the tag. Not applicable to custom tags. |
optional |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
Possible values for the context element in the TagInfo object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_CLOUD
- KUBERNETES
Possible values for the comparison element:
- EQUALS
- TAG_KEY_EQUALS
{
"comparison": "EQUALS",
"value": {
"context": "CONTEXTLESS",
"key": "myTag"
},
"negate": false,
"type": "TAG"
}
ZOS_CALL_TYPE
The ZosComparisonInfo object
Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison.
| Element | Type | Description | Required |
|---|---|---|---|
| comparison | string |
Operator of the comparision. You can reverse it by setting negate to |
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 equals into does not equal. |
required |
| type | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
Possible values
Possible values for the type element:
- BOOLEAN
- ESB_INPUT_NODE_TYPE
- FAILED_STATE
- FAILURE_REASON
- FAST_STRING
- FLAW_STATE
- HTTP_METHOD
- HTTP_STATUS_CLASS
- IIB_INPUT_NODE_TYPE
- NUMBER
- NUMBER_REQUEST_ATTRIBUTE
- SERVICE_TYPE
- STRING
- STRING_REQUEST_ATTRIBUTE
- TAG
- ZOS_CALL_TYPE
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
{
"comparison": "EQUALS",
"value": "IMS_CONNECT_API",
"negate": false,
"type": "ZOS_CALL_TYPE"
}