correlator management API

Apama management API for correlator
More information: http://www.apamacommunity.com/
Contact Info: sales@softwareag.com
Version: 10.5.4.1
All rights reserved
http://www.apamacommunity.com/terms-conditions/

Access

Methods

[ Jump to Models ]

Table of Contents

  1. get /connections
  2. get /deepPing
  3. get /info/argv
  4. get /info/categories
  5. get /info/envp
  6. get /info
  7. get /info/stats
  8. get /logLevel
  9. put /logLevel
  10. get /ping
  11. get /correlator/appLogging
  12. get /correlator/info
  13. get /correlator/status
  14. get /correlator/types
  15. get /info/license
  16. put /request
Up 
get /connections
Retrieve the connections to the component. (connectionsGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /deepPing
Check if the component is running. (deepPingGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /info/argv
Retrieve the arguments that were specified when the component was started. (infoArgvGet)

Return type

array[Object]

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Error Object
Up 
get /info/categories
Retrieve the list of other categories available under /info on this component. (infoCategoriesGet)

Return type

array[Object]

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Error Object
Up 
get /info/envp
Retrieve the names and values of the environment variables in use. (infoEnvpGet)

Return type

array[Object]

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Error Object
Up 
get /info
Summary information about the component including its name, version, etc. (infoGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /info/stats
Retrieve component-specific status information. (infoStatsGet)

Return type

array[Object]

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Error Object
Up 
get /logLevel
Retrieve the current log level of the component. (logLevelGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
put /logLevel
Change the log level of the component. (logLevelPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter —

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /ping
Check if the component is running. (pingGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /correlator/appLogging
Retrieve the EPL logging categories and levels. (correlatorAppLoggingGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /correlator/info
Retrieve information about the state of the correlator. (correlatorInfoGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /correlator/status
Retrieve the runtime status of the correlator including user-defined status values. (correlatorStatusGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /correlator/types
Retrieve a description of all the event types defined in the correlator. (correlatorTypesGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
get /info/license
Retrieve information about the license status of the correlator and what restrictions apply. (infoLicenseGet)

Return type

Object

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Object

400

Error Object
Up 
put /request
Perform a request on the correlator and get the response. The request has a single parameter 'args' which is a list of strings of the request. (requestPut)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter —

Return type

inline_response_200

Example data

Content-Type: application/json
{
  "response" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK inline_response_200

400

Error Object
Up

Models

[ Jump to Methods ]

Table of Contents

  1. body
  2. inline_response_200

body Up

args
array[String]

inline_response_200 Up

response (optional)
String