Request naming API - JSON models

Some JSON models of the Request naming API vary, depending on the type of some objects. Here you can find JSON models for each variation.

Variations of the `ComparisonInfo` object

BOOLEAN

BooleanComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Type-specific comparison for attributes. The actual set of fields depends on the type of the comparison. Find the list of actual objects in the description of the type field or see Service metrics API - JSON models.

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": true,
  "negate": false,
  "type": "BOOLEAN"
}

ESB_INPUT_NODE_TYPE

ESBInputNodeTypeComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "EVENT_INPUT_NODE",
  "negate": false,
  "type": "ESB_INPUT_NODE_TYPE"
}

FAILED_STATE

FailedStateComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "SUCCESSFUL",
  "negate": false,
  "type": "FAILED_STATE "
}

FAILURE_REASON

FailureReasonComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "EXCEPTION_ON_ANY_NODE",
  "negate": false,
  "type": "FAILURE_REASON"
}

FAST_STRING

FastStringComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "CONTAINS",
  "value": "sample",
  "negate": false,
  "type": "FAST_STRING"
}

FLAW_STATE

FlawStateComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "FLAWED",
  "negate": false,
  "type": "FLAW_STATE"
}

HTTP_METHOD

HttpMethodComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "POST",
  "negate": false,
  "type": "HTTP_METHOD"
}

HTTP_STATUS_CLASS

HttpStatusClassComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "C_2XX",
  "negate": false,
  "type": "HTTP_STATUS_CLASS"
}

IIB_INPUT_NODE_TYPE

IIBInputNodeTypeComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "JMS_CLIENT_INPUT_NODE",
  "negate": false,
  "type": "IIB_INPUT_NODE_TYPE"
}

NUMBER

NumberComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "GREATER_THAN_OR_EQUAL",
  "value": {},
  "negate": false,
  "type": "NUMBER"
}

NUMBER_REQUEST_ATTRIBUTE

NumberRequestAttributeComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

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 `serviceTag`	optional
serviceTag	UniversalTag	Use only request attributes from services that have this tag. Use either this or `managementZone`	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 `CONTEXTLESS` value. 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, `CONTEXTLESS` set. The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_COMPUTE_ENGINE` `KUBERNETES`	optional

The `UniversalTagKey` object

Element	Type	Description	Required
context	string	- The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_COMPUTE_ENGINE` `KUBERNETES`	optional
key	string	-	optional

json
{
  "comparison": "GREATER_THAN",
  "value": {},
  "negate": false,
  "type": "NUMBER_REQUEST_ATTRIBUTE",
  "requestAttribute": "sample"
}

SERVICE_TYPE

ServiceTypeComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "BACKGROUND_ACTIVITY",
  "negate": false,
  "type": "SERVICE_TYPE"
}

STRING

StringComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "ENDS_WITH",
  "value": "sample",
  "negate": false,
  "type": "STRING",
  "caseSensitive": false
}

STRING_REQUEST_ATTRIBUTE

StringRequestAttributeComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

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 `serviceTag`	optional
serviceTag	UniversalTag	Use only request attributes from services that have this tag. Use either this or `managementZone`	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 `CONTEXTLESS` value. 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, `CONTEXTLESS` set. The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_COMPUTE_ENGINE` `KUBERNETES`	optional

The `UniversalTagKey` object

Element	Type	Description	Required
context	string	- The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_COMPUTE_ENGINE` `KUBERNETES`	optional
key	string	-	optional

json
{
  "comparison": "BEGINS_WITH",
  "value": "sample",
  "negate": false,
  "type": "STRING_REQUEST_ATTRIBUTE",
  "requestAttribute": "myAttribute",
  "caseSensitive": false
}

TAG

TagComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

The `TagInfo` object

Tag of a Dynatrace entity.

Element Type Description Required

context

string

Element	Type	Description	Required
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_CLOUD` `KUBERNETES`	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

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The element can hold these values

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

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

json
{
  "comparison": "EQUALS",
  "value": {
    "context": "CONTEXTLESS",
    "key": "myTag"
  },
  "negate": false,
  "type": "TAG"
}

ZOS_CALL_TYPE

ZosComparisonInfo

ParametersJSON model

The `ComparisonInfo` object

Element	Type	Description	Required
comparison	string	Operator of the comparision. You can reverse it by setting negate to `true`.	required
value	object	The value to compare to.	optional
values	object[]	The values 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: `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 element can hold these values `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`	required

json
{
  "comparison": "EQUALS",
  "value": "IMS_CONNECT_API",
  "negate": false,
  "type": "ZOS_CALL_TYPE"
}

Request naming API - JSON models

Variations of the ComparisonInfo object

BOOLEAN

The ComparisonInfo object

ESB_INPUT_NODE_TYPE

The ComparisonInfo object

FAILED_STATE

The ComparisonInfo object

FAILURE_REASON

The ComparisonInfo object

FAST_STRING

The ComparisonInfo object

FLAW_STATE

The ComparisonInfo object

HTTP_METHOD

The ComparisonInfo object

HTTP_STATUS_CLASS

The ComparisonInfo object

IIB_INPUT_NODE_TYPE

The ComparisonInfo object

NUMBER

The ComparisonInfo object

NUMBER_REQUEST_ATTRIBUTE

The ComparisonInfo object

The PropagationSource object

The UniversalTag object

The UniversalTagKey object

SERVICE_TYPE

The ComparisonInfo object

STRING

The ComparisonInfo object

STRING_REQUEST_ATTRIBUTE

The ComparisonInfo object

The PropagationSource object

The UniversalTag object

The UniversalTagKey object

TAG

The ComparisonInfo object

The TagInfo object

ZOS_CALL_TYPE

The ComparisonInfo object

Variations of the `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `PropagationSource` object

The `UniversalTag` object

The `UniversalTagKey` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `ComparisonInfo` object

The `PropagationSource` object

The `UniversalTag` object

The `UniversalTagKey` object

The `ComparisonInfo` object

The `TagInfo` object

The `ComparisonInfo` object