Failure detection API - JSON models

Reference
Published Jan 11, 2021

JSON models of the Failure detection rules API vary greatly, depending on the type of some objects. Here you can find JSON models for each variation.

Variations of the `FdpTagPredicate` object

The FdpTagPredicate object is the base of tag conditions for failure detection parameter sets. The actual set of fields depends on the type of the condition.

STRING_EQUALS

The `FdpTagStringStartsWith` object

The predicate of the STRING_STARTS_WITH type. It checks whether the tag (which is a string) starts with the reference value.

Element	Type	Description
ignoreCase	boolean	-
negated	boolean	-
value	string	The reference value. The condition is fulfilled when the tag (which is a string) starts with this value.

STRING_STARTS_WITH

The `FdpTagStringEquals` object

The predicate of the STRING_EQUALS type. It checks whether the tag (which is a string) equals the reference value.

Element	Type	Description
ignoreCase	boolean	-
negated	boolean	-
value	string	The reference value. The condition is fulfilled when the tag (which is a string) equals this value.

STRING_ENDS_WITH

The `FdpTagStringEndsWith` object

The predicate of the STRING_ENDS_WITH type. It checks whether the tag (which is a string) ends with the reference value.

Element	Type	Description
ignoreCase	boolean	-
negated	boolean	-
value	string	The reference value. The condition is fulfilled when the tag (which is a string) ends with this value.

STRING_CONTAINS_SUBSTRING

The `FdpTagStringContainsSubstring` object

The predicate of the STRING_CONTAINS_SUBSTRING type. It checks whether the tag (which is a string) contains the reference value.

Element	Type	Description
ignoreCase	boolean	-
negated	boolean	-
value	string	The reference value. The condition is fulfilled when the tag (which is a string) contains this value.

INTEGER_EQUALS

The `FdpTagIntegerEquals` object

The predicate of the INTEGER_EQUALS type. It checks whether the tag (which is an integer) equals the reference value.

Element	Type	Description
negated	boolean	-
value	string	The reference value.

INTEGER_LESS_THAN

The `FdpTagIntegerLessThan` object

The predicate of the INTEGER_LESS_THAN type. It checks whether the tag (which is an integer) is less than the reference value.

Element	Type	Description
value	string	The reference value.

INTEGER_LESS_THAN_OR_EQUAL

The `FdpTagIntegerLessThanOrEqual` object

The predicate of the INTEGER_LESS_THAN_OR_EQUAL type. It checks whether the tag (which is an integer) is less than or equals the reference value.

Element	Type	Description
value	string	The reference value.

INTEGER_GREATER_THAN

The `FdpTagIntegerGreaterThan` object

The predicate of the INTEGER_GREATER_THAN type. It checks whether the tag (which is an integer) is greater than the reference value.

Element	Type	Description
value	string	The reference value.

INTEGER_GREATER_THAN_OR_EQUAL

The `FdpTagIntegerGreaterThanOrEqual` object

The predicate of the INTEGER_GREATER_THAN_OR_EQUAL type. It checks whether the tag (which is an integer) is greater than or equals the reference value.

Element	Type	Description
value	string	The reference value.

DOUBLE_EQUALS

The `FdpTagDoubleEquals` object

The predicate of the DOUBLE_EQUALS type. It checks whether the tag (which is a double) equals the reference value.

Element	Type	Description
negated	boolean	-
value	number	The reference value.

DOUBLE_LESS_THAN

The `FdpTagDoubleLessThan` object

The predicate of the DOUBLE_LESS_THAN type. It checks whether the tag (which is a double) is less than the reference value.

Element	Type	Description
value	number	The reference value.

DOUBLE_LESS_THAN_OR_EQUAL

The `FdpTagDoubleLessThanOrEqual` object

The predicate of the DOUBLE_LESS_THAN_OR_EQUAL type. It checks whether the tag (which is a double) is less than or equals the reference value.

Element	Type	Description
value	number	The reference value.

DOUBLE_GREATER_THAN

The `FdpTagDoubleGreaterThan` object

The predicate of the DOUBLE_GREATER_THAN type. It checks whether the tag (which is a double) is greater than the reference value.

Element	Type	Description
value	number	The reference value.

DOUBLE_GREATER_THAN_OR_EQUAL

The `FdpTagDoubleGreaterThanOrEqual` object

The predicate of the DOUBLE_GREATER_THAN_OR_EQUAL type. It checks whether the tag (which is a double) is greater than or equals the reference value.

Element	Type	Description
value	number	The reference value.

Variations of the `FdcPredicate` object

The FdcPredicate object is the base for predicates of a failure detection rule's condition. The actual set of fields depends on the type of the condition.

STRING_EQUALS

The `FdcPredicateStringEquals` object

The predicate of the STRING_EQUALS type. It checks whether the attribute (which is a string) equals one of the reference values.

Element Type Description

ignoreCase

boolean

Element	Type	Description
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is a string) equals any of these.

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

values

string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) equals any of these.

STRING_STARTS_WITH

The `FdcPredicateStringStartsWith` object

The predicate of the STRING_STARTS_WITH type. It checks whether the attribute (which is a string) starts with one of the reference values.

Element Type Description

ignoreCase

boolean

Element	Type	Description
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is a string) start with any of these.

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

values

string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) start with any of these.

STRING_ENDS_WITH

The `FdcPredicateStringEndsWith` object

The predicate of the STRING_ENDS_WITH type. It checks whether the attribute (which is a string) ends with one of the reference values.

Element Type Description

ignoreCase

boolean

Element	Type	Description
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is a string) ends with any of these.

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

values

string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) ends with any of these.

STRING_CONTAINS_SUBSTRING

The `FdcPredicateStringContains` object

The predicate of the STRING_CONTAINS_SUBSTRING type. It checks whether the attribute (which is a string) contains one of the reference values.

Element Type Description

ignoreCase

boolean

Element	Type	Description
ignoreCase	boolean	The condition is case sensitive (`false`) or case insensitive (`true`). If not set, then `false` is used, making the condition case sensitive.
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is a string) contains any of these.

The condition is case sensitive (false) or case insensitive (true).

If not set, then false is used, making the condition case sensitive.

values

string[]

A list of reference values. The condition is fulfilled when the attribute (which is a string) contains any of these.

INTEGER_EQUALS

The `FdcPredicateIntegerEquals` object

The predicate of the INTEGER_EQUALS type. It checks whether the attribute (which is an integer) equals one of the reference values.

Element	Type	Description
values	integer[]	The reference value. The condition is fulfilled when the attribute (which is an integer) equals any of these.

INTEGER_LESS_THAN

The `FdcPredicateIntegerLessThan` object

The predicate of the INTEGER_LESS_THAN type. It checks whether the attribute (which is an integer) is less than the reference value.

Element	Type	Description
value	integer	The reference value. The condition is fulfilled when the attribute (which is an integer) is less than this value.

INTEGER_LESS_THAN_OR_EQUAL

The `FdcPredicateIntegerLessThanOrEqual` object

The predicate of the INTEGER_LESS_THAN_OR_EQUAL type. It checks whether the attribute (which is an integer) is less than or equals the reference value.

Element	Type	Description
value	integer	The reference value. The condition is fulfilled when the attribute (which is an integer) is less than or equals this value.

INTEGER_GREATER_THAN

The `FdcPredicateIntegerGreaterThan` object

The predicate of the INTEGER_GREATER_THAN type. It checks whether the attribute (which is an integer) is greater than the reference value.

Element	Type	Description
value	integer	The reference value. The condition is fulfilled when the attribute (which is an integer) is greater than this value.

INTEGER_GREATER_THAN_OR_EQUAL

The `FdcPredicateIntegerGreaterThanOrEqual` object

The predicate of the INTEGER_GREATER_THAN_OR_EQUAL type. It checks whether the attribute (which is an integer) is greater than or equals the reference value.

Element	Type	Description
value	integer	The reference value. The condition is fulfilled when the attribute (which is an integer) is greater than or equals this value.

LONG_EQUALS

The `FdcPredicateLongEquals` object

The predicate of the LONG_EQUALS type. It checks whether the attribute (which is a long) equals one of the reference values.

Element	Type	Description
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is a long) equals any of these.

LONG_LESS_THAN

The `FdcPredicateLongLessThan` object

The predicate of the LONG_LESS_THAN type. It checks whether the attribute (which is a long) is less than the reference value.

Element	Type	Description
value	string	The reference value. The condition is fulfilled when the attribute (which is a long) is less than this value.

LONG_LESS_THAN_OR_EQUAL

The `FdcPredicateLongLessThanOrEqual` object

The predicate of the LONG_LESS_THAN_OR_EQUAL type. It checks whether the attribute (which is a long) is less than or equals the reference value.

Element	Type	Description
value	string	The reference value. The condition is fulfilled when the attribute (which is a long) is less than or equals this value.

LONG_GREATER_THAN

The `FdcPredicateLongGreaterThan` object

The predicate of the LONG_GREATER_THAN type. It checks whether the attribute (which is a long) is greater than the reference value.

Element	Type	Description
value	string	The reference value. The condition is fulfilled when the attribute (which is a long) is greater than this value.

LONG_GREATER_THAN_OR_EQUAL

The `FdcPredicateLongGreaterThanOrEqual` object

The predicate of the LONG_GREATER_THAN_OR_EQUAL type. It checks whether the attribute (which is a long) is greater than or equals the reference value.

Element	Type	Description
value	string	The reference value. The condition is fulfilled when the attribute (which is a long) is greater than or equals this value.

TAG_KEY_EQUALS

The `FdcPredicateTagKeyEquals` object

The predicate of the TAG_KEY_EQUALS type. It checks whether the attribute (which is the key of a tag) equals one of the reference values.

Element	Type	Description
keys	string[]	A list of reference values. The condition is fulfilled when the attribute (which is the key of a tag) equals any of these.

TAG_EQUALS

The `FdcPredicateTagEquals` object

The predicate of the TAG_EQUALS type. It checks whether the attribute (which is a key:value pair) equals one of the reference values.

The reference value is a key:value pair, consisting of a key and a value that are at the same position in the respective list.

Element	Type	Description
keys	string[]	A list of reference tag keys. The condition is fulfilled when the tag matches any key:value pair, consisting of a key and a value that are at the same position in the respective list.
values	string[]	A list of reference tag values. The condition is fulfilled when the tag matches any key:value pair, consisting of a key and a value that are at the same position in the respective list.

Element

Type

Description

keys

string[]

A list of reference tag keys.

The condition is fulfilled when the tag matches any key:value pair, consisting of a key and a value that are at the same position in the respective list.

values

string[]

A list of reference tag values.

The condition is fulfilled when the tag matches any key:value pair, consisting of a key and a value that are at the same position in the respective list.

SERVICE_TYPE_EQUALS

The `FdcPredicateServiceTypeEquals` object

The predicate of the SERVICE_TYPE_EQUALS type. It checks whether the attribute (which is the type of the service) equals one of the reference values.

Element	Type	Description
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is the type of the service) equals any of these.The possible values are: WebRequest, WebService, Database, Method, WebSite, Messaging, Mobile, Process, Rmi, External, QueueListener, QueueInteraction, RemoteCall, SaasVendor, CustomApplication, Cics, Ims, CicsInteraction, ImsInteraction, EnterpriseServiceBus, ZosConnect.

MANAGEMENT_ZONES_CONTAINS_ALL

The `FdcPredicateManagementZonesContainsAll` object

The predicate of the MANAGEMENT_ZONES_CONTAINS_ALL type. It checks whether the attribute (which is a set of management zones) contains all the reference values.

Element	Type	Description
values	string[]	A list of reference values. The condition is fulfilled when the attribute (which is a set of management zones) contains all the reference values. Specify the ID or the name of the management zone here.

Element

Type

Description

values

string[]

A list of reference values. The condition is fulfilled when the attribute (which is a set of management zones) contains all the reference values.

Specify the ID or the name of the management zone here.

SET_OF_INTEGERS_CONTAINS_ANY

The `FdcPredicateLongLessThan` object

The predicate of the LONG_LESS_THAN type. It checks whether the attribute (which is a long) is less than the reference value.

Element	Type	Description
value	string	The reference value. The condition is fulfilled when the attribute (which is a long) is less than this value.

SET_OF_INTEGERS_CONTAINS_ALL

The `FdcPredicateLongLessThan` object

The predicate of the LONG_LESS_THAN type. It checks whether the attribute (which is a long) is less than the reference value.

Element	Type	Description
value	string	The reference value. The condition is fulfilled when the attribute (which is a long) is less than this value.

Failure detection API - JSON models

Variations of the FdpTagPredicate object

STRING_EQUALS

The FdpTagStringStartsWith object

STRING_STARTS_WITH

The FdpTagStringEquals object

STRING_ENDS_WITH

The FdpTagStringEndsWith object

STRING_CONTAINS_SUBSTRING

The FdpTagStringContainsSubstring object

INTEGER_EQUALS

The FdpTagIntegerEquals object

INTEGER_LESS_THAN

The FdpTagIntegerLessThan object

INTEGER_LESS_THAN_OR_EQUAL

The FdpTagIntegerLessThanOrEqual object

INTEGER_GREATER_THAN

The FdpTagIntegerGreaterThan object

INTEGER_GREATER_THAN_OR_EQUAL

The FdpTagIntegerGreaterThanOrEqual object

DOUBLE_EQUALS

The FdpTagDoubleEquals object

DOUBLE_LESS_THAN

The FdpTagDoubleLessThan object

DOUBLE_LESS_THAN_OR_EQUAL

The FdpTagDoubleLessThanOrEqual object

DOUBLE_GREATER_THAN

The FdpTagDoubleGreaterThan object

DOUBLE_GREATER_THAN_OR_EQUAL

The FdpTagDoubleGreaterThanOrEqual object

Variations of the FdcPredicate object

STRING_EQUALS

The FdcPredicateStringEquals object

STRING_STARTS_WITH

The FdcPredicateStringStartsWith object

STRING_ENDS_WITH

The FdcPredicateStringEndsWith object

STRING_CONTAINS_SUBSTRING

The FdcPredicateStringContains object

INTEGER_EQUALS

The FdcPredicateIntegerEquals object

INTEGER_LESS_THAN

The FdcPredicateIntegerLessThan object

INTEGER_LESS_THAN_OR_EQUAL

The FdcPredicateIntegerLessThanOrEqual object

INTEGER_GREATER_THAN

The FdcPredicateIntegerGreaterThan object

INTEGER_GREATER_THAN_OR_EQUAL

The FdcPredicateIntegerGreaterThanOrEqual object

LONG_EQUALS

The FdcPredicateLongEquals object

LONG_LESS_THAN

The FdcPredicateLongLessThan object

LONG_LESS_THAN_OR_EQUAL

The FdcPredicateLongLessThanOrEqual object

LONG_GREATER_THAN

The FdcPredicateLongGreaterThan object

LONG_GREATER_THAN_OR_EQUAL

The FdcPredicateLongGreaterThanOrEqual object

TAG_KEY_EQUALS

The FdcPredicateTagKeyEquals object

TAG_EQUALS

The FdcPredicateTagEquals object

SERVICE_TYPE_EQUALS

The FdcPredicateServiceTypeEquals object

MANAGEMENT_ZONES_CONTAINS_ALL

The FdcPredicateManagementZonesContainsAll object

SET_OF_INTEGERS_CONTAINS_ANY

The FdcPredicateLongLessThan object

SET_OF_INTEGERS_CONTAINS_ALL

The FdcPredicateLongLessThan object

Variations of the `FdpTagPredicate` object

The `FdpTagStringStartsWith` object

The `FdpTagStringEquals` object

The `FdpTagStringEndsWith` object

The `FdpTagStringContainsSubstring` object

The `FdpTagIntegerEquals` object

The `FdpTagIntegerLessThan` object

The `FdpTagIntegerLessThanOrEqual` object

The `FdpTagIntegerGreaterThan` object

The `FdpTagIntegerGreaterThanOrEqual` object

The `FdpTagDoubleEquals` object

The `FdpTagDoubleLessThan` object

The `FdpTagDoubleLessThanOrEqual` object

The `FdpTagDoubleGreaterThan` object

The `FdpTagDoubleGreaterThanOrEqual` object

Variations of the `FdcPredicate` object

The `FdcPredicateStringEquals` object

The `FdcPredicateStringStartsWith` object

The `FdcPredicateStringEndsWith` object

The `FdcPredicateStringContains` object

The `FdcPredicateIntegerEquals` object

The `FdcPredicateIntegerLessThan` object

The `FdcPredicateIntegerLessThanOrEqual` object

The `FdcPredicateIntegerGreaterThan` object

The `FdcPredicateIntegerGreaterThanOrEqual` object

The `FdcPredicateLongEquals` object

The `FdcPredicateLongLessThan` object

The `FdcPredicateLongLessThanOrEqual` object

The `FdcPredicateLongGreaterThan` object

The `FdcPredicateLongGreaterThanOrEqual` object

The `FdcPredicateTagKeyEquals` object

The `FdcPredicateTagEquals` object

The `FdcPredicateServiceTypeEquals` object

The `FdcPredicateManagementZonesContainsAll` object

The `FdcPredicateLongLessThan` object

The `FdcPredicateLongLessThan` object