Elements and Attributes in a Response

Service Health Check Service Response Schema
Name of element/attribute Type Description
HealthCheckResponse Element The outermost element in a Service Health Check response. It comprises the Service Health Check of an application or a chain of applications.
applicationName Attribute The name of the application where the Service, Component, Reference, or Shared Resource is deployed.
correlationID Attribute A unique identifier associated with each Element, to help in correlating log messages related to a particular Service Health Check request Invocation. Applicable to all elements.
status Attribute The status value can be Pass, Failed, or TimedOut. It is applicable for the Service, Reference, Component, Shared Resource, or healthcheckresponse element. The value is inferred from the status values of the child elements.
name Attribute Specifies name of the Component, Shared Resource, Reference, or Service.
nodeName Attribute The name of the node on which Service, Component, Reference, or Shared Resource is deployed.
environmentName Attribute The name of the environment where the Service, Component, Reference, or Shared Resource is deployed.
hostName Attribute The name of the host where the Service, Component, Reference, or Shared Resource is deployed.
startTime Attribute The time at which Service, Reference, Component, or Shared Resource received a request. The format is: 
dd MMM yyyy HH:mm:ss,SSS.
endTime Attribute The time at which Service, Reference, Component, or Shared Resource received a Service Health Check response. The format is: dd MMM yyyy HH:mm:ss,SSS.
responseTime Attribute The time taken by a Service, Reference, Component, or Shared Resource to process the Service Health Check request in milliseconds.
cachedForDurationlnSecs Attribute Indicates the cache interval specified for the request.
Note: This attribute is present in the response only if the response is returned from the cache.
cachedAtTime Attribute

Indicates the time at which the response was cached.

Note: This attribute is present in the response only if the response is returned from the cache.
isCached Attribute Indicates whether the response is cached or not.
Note: This attribute is present in the response only if the response is returned from the cache.
Service Element Represents Service Health Check information for a Service Component Endpoint.
bindingName Attribute The name of the Binding.
bindingType Attribute The type of the Binding (SOAP Binding, JMS Binding, REST Binding, and so on).
portTypeName Attribute The name of the port Type.
ipAddress Attribute IP address of the machine where the Service Component is deployed.
isSSLEnabled Attribute Identifies whether the HTTP connector used by the SOAP/HTTP Binding is SSL-enabled.
transportType Attribute The Transport Type of the Service Component (SOAP over HTTP, SOAP over JMS, and so on).
endpointURI Attribute Specifies the Service endpoint URI of a SOAP/HTTP Binding.
machineName Attribute The name of the machine on which the Service Component is deployed.
correlationScheme Attribute The correlation scheme used by SOAP/JMS Bindings to correlate a request/response message pair using the JMS Message ID and JMS Correlation ID headers in the JMS Message. If the Service and Reference Bindings use different correlation schemes, the message exchange may fail.
soapJmsBindingSpec Attribute The JMS specification of the SOAP/JMS Binding in terms of TIBCO SOAP/JMS (default) and W3C SOAP/JMS
destination Attribute The JMS Destination (Queue) on which the SOAP/JMS Service Binding is listening
deliveryMode Attribute The delivery mode specified for the SOAP/JMS Binding in terms of Persistent and Non-Persistent
replyTo Attribute

The JMS Destination (Queue) on which the reply message is sent by the SOAP/JMS Service Binding.

jmsMsgId Attribute The JMS Message ID Header of the JMS Message. This value is set by the underlying JMS Server.
Reference Element Represents Service Health Check information for a Reference binding
targetServiceURL Attribute

Represents the URL of the target service for the Reference binding

ComponentReference Element Represents a Component Reference present on the Component and is the container for embedding Service Health Check information for either Component or Reference binding.
Component Element Indicates the Implementation Type Component
componentType Attribute Classifies the Implementation Type as Java, Spring, BWSE or Mediation
version Attribute The version of the Implementation Type Component or Reference.
SharedResource Element Represents Service Health Check information for a Shared Resource
resourceName Attribute Specifies the name of the shared resource instance
jdbcURL Attribute The JDBC URL used to establish connection to the database

See Database Queries for Service Health Check of JDBC Shared Resource.

queryUsed Attribute The query used to check database health.
userID Attribute The user ID used to create a JDBC connection
Error Element Specifies Service Health Check error information which occurs during any path of Service Health Check execution
errorCode Attribute Unique identifier for the error that has occurred during Service Health Check Invocation.
errorString Attribute Description of the error that has occurred during Service Health Check Invocation.