Btm REST API

Auto-generated swagger documentation

The REST API for the Hawkular Business Transaction Management server

Base path

/hawkular/btm

Operations

/analytics/alerts/count/{name}

GET

Get the business transaction alert count

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

name

path

yes

business transaction name

-

string
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

500

Internal server error

-


/analytics/boundendpoints/{name}

GET

Identify the bound endpoints for a business transaction

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

name

path

yes

business transaction name

-

string

startTime

query

no

optional 'start' time, default 1 hour before current time

0

integer (int64)

endTime

query

no

optional 'end' time, default current time

0

integer (int64)
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/communication/summary

GET

Get the business transaction communication summary statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

no

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

tree

query

no

tree

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the business transaction communication summary statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria

tree

query

no

tree

-

boolean
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/completion/count

GET

Get the business transaction completion count

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

500

Internal server error

-


/analytics/completion/faultcount

GET

Get the number of business transaction instances that returned a fault

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

500

Internal server error

-


/analytics/completion/faults

GET

Get the business transaction completion fault details associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the business transaction completion fault details associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/completion/percentiles

GET

Get the business transaction completion percentiles associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Percentiles

500

Internal server error

-


/analytics/completion/property/{property}

GET

Get the business transaction completion property details associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-

string

property

path

yes

property

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the business transaction completion property details associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

property

path

yes

property

-

string

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/completion/statistics

GET

Get the business transaction completion timeseries statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

interval

query

no

aggregation time interval (in milliseconds)

60000

integer (int64)

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the business transaction completion timeseries statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

interval

query

no

aggregation time interval (in milliseconds)

60000

integer (int64)

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/hostnames

GET

Get the host names associated with the criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

no

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the host names associated with the criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/node/statistics

GET

Get the business transaction node timeseries statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

no

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

interval

query

no

aggregation time interval (in milliseconds)

60000
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the business transaction node timeseries statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

interval

query

no

aggregation time interval (in milliseconds)

60000

integer (int64)

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/node/summary

GET

Get the business transaction node summary statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

no

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get the business transaction node summary statistics associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/principals

GET

Get principal information

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get principal information

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/properties

GET

Get property information

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

yes

business transaction name

-

string

startTime

query

no

business transactions after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

business transactions before this time, millisecond since epoch

0

integer (int64)

hostName

query

no

host name

-

string

principal

query

no

principal

-

string

properties

query

no

business transactions with these properties, defined as a comma separated list of name

value pairs

-

string

faults

query

no

faults

-
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


POST

Get property information

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/analytics/unboundendpoints

GET

Identify the unbound endpoints

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

startTime

query

no

optional 'start' time, default 1 hour before current time

0

integer (int64)

endTime

query

no

optional 'end' time, default current time

0

integer (int64)

compress

query

no

compress list to show common patterns

false

boolean
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/config/businesstxn/full

GET

Retrieve the business transaction configurations, changed since an optional specified time

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

updated

query

no

updated since

0

integer (int64)
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

500

Internal server error

-


POST

Add or update the business transaction configurations

Request

Content-Type: application/json

Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/config/businesstxn/full/{name}

GET

Retrieve the business transaction configuration for the specified name

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

name

path

yes

business transaction name

-

string
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

BusinessTxnConfig

500

Internal server error

-


PUT

Add or update the business transaction configuration for the specified name

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

name

path

yes

business transaction name

-

string
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


DELETE

Remove the business transaction configuration with the specified name

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

name

path

yes

business transaction name

-

string
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

-

500

Internal server error

-


/config/businesstxn/summary

GET

Retrieve the business transaction summaries

Request

Content-Type: application/json

Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/config/businesstxn/validate

POST

Validate the business transaction configuration

Request

Content-Type: application/json

Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Array[<<,>>]

500

Internal server error

-


/config/collector

GET

Retrieve the collector configuration for the optionally specified host and server

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

type

query

no

optional type

-

string

host

query

no

optional host name

-

string

server

query

no

optional server name

-

string
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

CollectorConfiguration

500

Internal server error

-


/fragments

GET

Query trace fragments associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

businessTransaction

query

no

trace name

-

string

startTime

query

no

retrieve traces after this time, millisecond since epoch

0

integer (int64)

endTime

query

no

retrieve traces before this time, millisecond since epoch

0

integer (int64)

properties

query

no

retrieve traces with these properties, defined as a comma separated list of name

value pairs

-

string

correlations

query

no

retrieve traces with these correlation identifiers, defined as a comma separated list of scope

value pairs
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Trace

500

Internal server error

-


POST

Add a list of trace fragments

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

tenantId

header

no

-

string

body

body

yes

List of traces

-

Array[Trace]
Response

Content-Type: application/json

Status Code Reason Response Model

200

Adding traces succeeded.

-

500

Unexpected error happened while storing the trace fragments

-


/fragments/query

POST

Query trace fragments associated with criteria

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

body

body

yes

query criteria

-

Criteria
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success

Trace

500

Internal server error

-


/fragments/{id}

GET

Retrieve trace fragment for specified id

Request

Content-Type: application/json

Parameter Located in Required Description Default Schema

id

path

yes

id of required trace

-

string
Response

Content-Type: application/json

Status Code Reason Response Model

200

Success, trace fragment found and returned

Trace

404

Unknown trace fragment id

-

500

Internal server error

-


Data Types


AddContentAction

(Derived from ProcessorAction)

Name Type Required Description



AddCorrelationIdAction

(Derived from ProcessorAction)

Name Type Required Description



AssertComplete

(Derived from InstrumentAction)

Name Type Required Description



BusinessTxnConfig

Name Type Required Description

level

string

optional

-

description

string

optional

-

filter

Filter

optional

-

processors

array[Processor]

optional

-

lastUpdated

integer (int64)

optional

-

deleted

boolean

optional

-



CollectorConfiguration

Name Type Required Description

properties

object

optional

-

instrumentation

object

optional

-

businessTransactions

object

optional

-



CompleteCorrelation

(Derived from InstrumentAction)

Name Type Required Description



Component

(Derived from InteractionNode)

Name Type Required Description



Consumer

(Derived from InteractionNode)

Name Type Required Description



ContainerNode

(Derived from Node)

Name Type Required Description



Content

Name Type Required Description

type

string

optional

-

value

string

optional

-



Correlate

(Derived from InstrumentAction)

Name Type Required Description



CorrelationIdentifier

Name Type Required Description

value

string

optional

-

scope

string

optional

-



Criteria

Name Type Required Description

startTime

integer (int64)

optional

-

endTime

integer (int64)

optional

-

businessTransaction

string

optional

-

properties

array[PropertyCriteria]

optional

-

correlationIds

array[CorrelationIdentifier]

optional

-

faults

array[FaultCriteria]

optional

-

hostName

string

optional

-

upperBound

integer (int64)

optional

-

lowerBound

integer (int64)

optional

-

principal

string

optional

-

timeout

integer (int64)

optional

-

maxResponseSize

integer (int32)

optional

-



EvaluateURIAction

(Derived from ProcessorAction)

Name Type Required Description



Expression

Name Type Required Description



FaultCriteria

Name Type Required Description

value

string

optional

-

excluded

boolean

optional

-



Filter

Name Type Required Description

inclusions

array[string]

optional

-

exclusions

array[string]

optional

-



FreeFormAction

(Derived from InstrumentAction)

Name Type Required Description



IgnoreNode

(Derived from InstrumentAction)

Name Type Required Description



InitiateCorrelation

(Derived from InstrumentAction)

Name Type Required Description



InstrumentAction

Name Type Required Description



InstrumentBind

Name Type Required Description

name

string

optional

-

type

string

optional

-

expression

string

optional

-



InstrumentComponent

(Derived from InstrumentAction)

Name Type Required Description



InstrumentConsumer

(Derived from InstrumentAction)

Name Type Required Description



InstrumentProducer

(Derived from InstrumentAction)

Name Type Required Description



InstrumentRule

Name Type Required Description

ruleName

string

optional

-

notes

array[string]

optional

-

className

string

optional

-

interfaceName

string

optional

-

methodName

string

optional

-

parameterTypes

array[string]

optional

-

helper

string

optional

-

location

string

optional

-

binds

array[InstrumentBind]

optional

-

condition

string

optional

-

actions

array[InstrumentAction]

optional

-

fromVersion

string

optional

-

toVersion

string

optional

-

compile

boolean

optional

-



Instrumentation

Name Type Required Description

description

string

optional

-

compile

boolean

optional

-

rules

array[InstrumentRule]

optional

-



InteractionNode

(Derived from ContainerNode)

Name Type Required Description



Issue

Name Type Required Description

description

string

optional

-

severity

string

optional

-



JSONExpression

(Derived from Expression)

Name Type Required Description



LiteralExpression

(Derived from Expression)

Name Type Required Description



Message

Name Type Required Description

headers

object

optional

-

content

object

optional

-



Node

Name Type Required Description

type

string

optional

-

uri

string

optional

-

operation

string

optional

-

baseTime

integer (int64)

optional

-

duration

integer (int64)

optional

-

fault

string

optional

-

faultDescription

string

optional

-

details

object

optional

-

correlationIds

array[CorrelationIdentifier]

optional

-

issues

array[Issue]

optional

-



Percentiles

Name Type Required Description

percentiles

object

optional

-



ProcessContent

(Derived from InstrumentAction)

Name Type Required Description



ProcessHeaders

(Derived from InstrumentAction)

Name Type Required Description



Processor

Name Type Required Description

description

string

optional

-

nodeType

string

optional

-

direction

string

optional

-

uriFilter

string

optional

-

operation

string

optional

-

faultFilter

string

optional

-

predicate

Expression

optional

-

actions

array[ProcessorAction]

optional

-



ProcessorAction

Name Type Required Description

description

string

optional

-

predicate

Expression

optional

-



ProcessorIssue

(Derived from Issue)

Name Type Required Description



Producer

(Derived from InteractionNode)

Name Type Required Description



PropertyCriteria

Name Type Required Description

name

string

optional

-

value

string

optional

-

excluded

boolean

optional

-



SetBusinessTransaction

(Derived from InstrumentAction)

Name Type Required Description



SetDetail

(Derived from InstrumentAction)

Name Type Required Description



SetDetailAction

(Derived from ProcessorAction)

Name Type Required Description



SetFault

(Derived from InstrumentAction)

Name Type Required Description



SetFaultAction

(Derived from ProcessorAction)

Name Type Required Description



SetFaultDescriptionAction

(Derived from ProcessorAction)

Name Type Required Description



SetLevel

(Derived from InstrumentAction)

Name Type Required Description



SetPrincipal

(Derived from InstrumentAction)

Name Type Required Description



SetProperty

(Derived from InstrumentAction)

Name Type Required Description



SetPropertyAction

(Derived from ProcessorAction)

Name Type Required Description



SetState

(Derived from InstrumentAction)

Name Type Required Description



Suppress

(Derived from InstrumentAction)

Name Type Required Description



TextExpression

(Derived from Expression)

Name Type Required Description



Trace

Name Type Required Description

id

string

optional

-

startTime

integer (int64)

optional

-

businessTransaction

string

optional

-

principal

string

optional

-

hostName

string

optional

-

hostAddress

string

optional

-

nodes

array[Node]

optional

-

properties

object

optional

-



(Derived from InstrumentAction)

Name Type Required Description



XMLExpression

(Derived from Expression)

Name Type Required Description






redhatlogo-white

© 2016 | Hawkular is released under Apache License v2.0