Interlok UI API Swagger Documentation

Interlok Artifact Downloader Api web service documentation.

[ base url: /interlok/api , api version: 3.10.2-RELEASE ]

/adapter

GET /external/adapter/{url}/{jmxUid}

Get an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}?jmxEnv={jmxEnv}'

GET /external/adapter/{adapter}

Get an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET 'http://host:8080/interlok/api/external/adapter/{adapter}'

DELETE /external/adapter/{adapter}

Delete an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X DELETE 'http://host:8080/interlok/api/external/adapter/{adapter}'

GET /external/adapter

List all register adapters in the Interlok UI

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
pageSize			query	Integer
page			query	Integer

Curl Example

curl -X GET 'http://host:8080/interlok/api/external/adapter?pageSize={pageSize}&page={page}'

POST /external/adapter

Add an adapter in the Interlok UI

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type

Request Body

Parameter Content Type

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter'

GET /external/adapter/{adapter}/state

Get an adapter's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/state'

PUT /external/adapter/{adapter}/state

Update an adapter's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
adpMgmtTimeout	The max timeout to wait for in milliseconds	query	String
option		query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/state?adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/adapter/{url}/{jmxUid}/state

Get an adapter's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/state?jmxEnv={jmxEnv}'

PUT /external/adapter/{url}/{jmxUid}/state

Update an adapter's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
adpMgmtTimeout	The max timeout to wait for in milliseconds	query	String
option		query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/state?jmxEnv={jmxEnv}&adpMgmtTimeout={adpMgmtTimeout}&option={option}'

POST /external/adapter/batch

Add multiple adapters in the Interlok UI

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type

Request Body

Parameter Content Type

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/batch'

GET /external/adapter/{adapter}/configuration

Get an adapter's configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/configuration'

GET /external/adapter/{url}/{jmxUid}/configuration

Get an adapter's configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/configuration?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/details

Get details for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/details?jmxEnv={jmxEnv}'

GET /external/adapter/{adapter}/details

Get details for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/details'

PUT /external/adapter/{adapter}/name

Update an adapter's name

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Request Body

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/name'

PUT /external/adapter/{adapter}/tags

Update an adapter's tags

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Request Body

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/tags'

/adapter/component-checker

POST /external/adapter/{adapter}/component-checker/check-service

Send a message through a a service (collection) to check its validity

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Request Body

Parameter Content Type

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/component-checker/check-service'

POST /external/adapter/{url}/{jmxUid}/component-checker/check-service

Send a message through a a service (collection) to check its validity

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Request Body

Parameter Content Type

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/component-checker/check-service?jmxEnv={jmxEnv}'

/adapter/failed-messages

GET /external/adapter/{adapter}/failed-messages/count

Get the number of failed messages for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/count'

PUT /external/adapter/{adapter}/failed-messages/ignore

Ignore an adapter failed message

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
deleteMsgFile		Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.	query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/ignore?deleteMsgFile={deleteMsgFile}'

POST /external/adapter/{adapter}/failed-messages/ignore

Ignore all the adapter failed message

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
deleteMsgFile		Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.	query	String

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/ignore?deleteMsgFile={deleteMsgFile}'

GET /external/adapter/{adapter}/failed-messages/total-count

Get an adapter total failed messages count since started

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/total-count'

PUT /external/adapter/{adapter}/failed-messages/retry

Retry an adapter failed message

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/retry'

POST /external/adapter/{adapter}/failed-messages/retry

Retry all the adapter failed messages

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/retry'

GET /external/adapter/{adapter}/failed-messages/last-hundred

Get all the failed messages for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages/last-hundred'

GET /external/adapter/{adapter}/failed-messages

Get all the failed messages for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
from		query	Integer
to		query	Integer

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/failed-messages?from={from}&to={to}'

GET /external/adapter/{url}/{jmxUid}/failed-messages/count

Get the number of failed messages for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/count?jmxEnv={jmxEnv}'

PUT /external/adapter/{url}/{jmxUid}/failed-messages/ignore

Ignore an adapter failed message

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
deleteMsgFile	Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.	query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/ignore?jmxEnv={jmxEnv}&deleteMsgFile={deleteMsgFile}'

POST /external/adapter/{url}/{jmxUid}/failed-messages/ignore

Ignore all the adapter failed message

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
deleteMsgFile	Delete message file on the adapter file system when ignoring a failed message. Once deleted, this can't be undone.	query	String

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/ignore?jmxEnv={jmxEnv}&deleteMsgFile={deleteMsgFile}'

GET /external/adapter/{url}/{jmxUid}/failed-messages/total-count

Get an adapter total failed messages count since started

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/total-count?jmxEnv={jmxEnv}'

PUT /external/adapter/{url}/{jmxUid}/failed-messages/retry

Retry an adapter failed message

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/retry?jmxEnv={jmxEnv}'

POST /external/adapter/{url}/{jmxUid}/failed-messages/retry

Retry all the adapter failed messages

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X POST -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/retry?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/failed-messages/last-hundred

Get all the failed messages for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages/last-hundred?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/failed-messages

Get all the failed messages for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
from		query	Integer
to		query	Integer

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/failed-messages?jmxEnv={jmxEnv}&from={from}&to={to}'

/adapter/metrics

GET /external/adapter/{adapter}/metrics/message-metrics

Get an adapter message metrics statistics

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/metrics/message-metrics'

GET /external/adapter/{adapter}/metrics/message-metrics/{id}

Get an adapter message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
id			path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/metrics/message-metrics/{id}'

GET /external/adapter/{url}/{jmxUid}/metrics/message-metrics

Get an adapter message metrics statistics

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/metrics/message-metrics?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/metrics/message-metrics/{id}

Get an adapter message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

/adapter/platform

GET /external/adapter/{adapter}/platform/runtime-properties

Get an adapter platform runtime properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/runtime-properties'

GET /external/adapter/{adapter}/platform/memory-non-heap-properties

Get an adapter platform memory non heap properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/memory-non-heap-properties'

GET /external/adapter/{adapter}/platform/memory-properties

Get an adapter platform memory properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/memory-properties'

GET /external/adapter/{adapter}/platform/memory-heap-properties

Get an adapter platform memory heap properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/memory-heap-properties'

GET /external/adapter/{adapter}/platform/runtime-system-properties

Get an adapter platform runtime system properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/runtime-system-properties'

GET /external/adapter/{adapter}/platform/runtime-path-properties

Get an adapter platform runtime path properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/runtime-path-properties'

GET /external/adapter/{adapter}/platform/operating-system-properties

Get an adapter platform operating system properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/operating-system-properties'

GET /external/adapter/{adapter}/platform/gc

Run an adapter jvm garbage collector

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/gc'

GET /external/adapter/{adapter}/platform/thread-properties

Get an adapter platform thread properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/thread-properties'

GET /external/adapter/{adapter}/platform/operating-system-load-properties

Get an adapter platform operating system load properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/operating-system-load-properties'

GET /external/adapter/{adapter}/platform/thread-dump

Get an adapter thread dump

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/platform/thread-dump'

GET /external/adapter/{url}/{jmxUid}/platform/runtime-properties

Get an adapter platform runtime properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/runtime-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/memory-non-heap-properties

Get an adapter platform memory non heap properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/memory-non-heap-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/memory-properties

Get an adapter platform memory properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/memory-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/memory-heap-properties

Get an adapter platform memory heap properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/memory-heap-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/runtime-system-properties

Get an adapter platform runtime system properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/runtime-system-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/runtime-path-properties

Get an adapter platform runtime path properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/runtime-path-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/operating-system-properties

Get an adapter platform operating system properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/operating-system-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/gc

Run an adapter jvm garbage collector

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/gc?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/thread-properties

Get an adapter platform thread properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/thread-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/operating-system-load-properties

Get an adapter platform operating system load properties

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/operating-system-load-properties?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/platform/thread-dump

Get an adapter thread dump

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/platform/thread-dump?jmxEnv={jmxEnv}'

/channel

GET /external/adapter/{adapter}/channel/{channel}

Get a channel for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}'

GET /external/adapter/{adapter}/channel/count

Counts channels for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter			path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/count'

GET /external/adapter/{adapter}/channel

Lists channels for an adapter

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel'

GET /external/adapter/{adapter}/channel/{channel}/state

Get a channel's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/state'

PUT /external/adapter/{adapter}/channel/{channel}/state

Update a channel's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
adpMgmtTimeout	adpMgmtTimeout	query	String
option		query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/state?adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/adapter/{adapter}/channel/{channel}/configuration

Get a channel's configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/configuration'

GET /external/adapter/{adapter}/channel/{channel}/details

Get details for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/details'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/count

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/count?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/state?jmxEnv={jmxEnv}'

PUT /external/adapter/{url}/{jmxUid}/channel/{channel}/state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String
adpMgmtTimeout	query	String
option	query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/state?jmxEnv={jmxEnv}&adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/configuration?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/details

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/details?jmxEnv={jmxEnv}'

/channel/failed-messages

GET /external/adapter/{adapter}/channel/{channel}/failed-messages/count

Get the number of failed messages for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/failed-messages/count'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/failed-messages/count

Get the number of failed messages for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/failed-messages/count?jmxEnv={jmxEnv}'

/channel/metrics

GET /external/adapter/{adapter}/channel/{channel}/metrics/message-metrics

Get a channel message metrics statistics

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter		The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/metrics/message-metrics'

GET /external/adapter/{adapter}/channel/{channel}/metrics/message-metrics/{id}

Get a channel message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/metrics/message-metrics/{id}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/metrics/message-metrics

Get a channel message metrics statistics

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/metrics/message-metrics?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/metrics/message-metrics/{id}

Get a channel message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String
id	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

/workflow

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}

Gets a workflow for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter		path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}'

GET /external/adapter/{adapter}/channel/{channel}/workflow/count

Counts workflows for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter			path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/count'

GET /external/adapter/{adapter}/channel/{channel}/workflow

Lists workflows for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
adapter			path	String
channel		The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state

Get a workflow's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter		path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state'

PUT /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state

Update a workflow's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter		path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
adpMgmtTimeout	adpMgmtTimeout	query	String
option		query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/state?adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/configuration

Get a workflow's configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/configuration'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/details

Get details for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter		path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/details'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}

Gets a workflow for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/count

Counts workflows for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/count?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow

Lists workflows for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state

Get a workflow's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state?jmxEnv={jmxEnv}'

PUT /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state

Update a workflow's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
adpMgmtTimeout	adpMgmtTimeout	query	String
option		query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/state?jmxEnv={jmxEnv}&adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/configuration

Get a workflow's configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/configuration?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/details

Get details for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/details?jmxEnv={jmxEnv}'

/workflow/failed-messages

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/failed-messages/count

Get the number of failed messages for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter		path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/failed-messages/count'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/failed-messages/count

Get the number of failed messages for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/failed-messages/count?jmxEnv={jmxEnv}'

/workflow/metrics

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids

Get all the metadata statistics ids for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids

Get all the message metrics statistics ids for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}

Get a workflow message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}'

DELETE /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}

Delete the workflow message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X DELETE -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}

Get a workflow matadata statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}'

DELETE /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}

Delete the workflow matadata statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X DELETE -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}'

GET /external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics

Get a workflow message metrics statistics. The first found will be returned

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
adapter	The unique Id or Name of an Adapter in the UI or 'local' to get the UI local Adapter.	path	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{adapter}/channel/{channel}/workflow/{workflow}/metrics/message-metrics'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids

Get all the metadata statistics ids for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics-ids?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids

Get all the message metrics statistics ids for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics-ids?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}

Get a workflow message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

DELETE /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}

Delete the workflow message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X DELETE -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}

Get a workflow matadata statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}?jmxEnv={jmxEnv}'

DELETE /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}

Delete the workflow matadata statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X DELETE -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/metadata-statistics/{id}?jmxEnv={jmxEnv}'

GET /external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics

Get a workflow message metrics statistics. The first found will be returned

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/adapter/{url}/{jmxUid}/channel/{channel}/workflow/{workflow}/metrics/message-metrics?jmxEnv={jmxEnv}'

deprecated

GET /external/channel/{url}/{jmxUid}/{channel}

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}/count

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/count?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}/{channel}/state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/state?jmxEnv={jmxEnv}'

PUT /external/channel/{url}/{jmxUid}/{channel}/state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String
adpMgmtTimeout	query	String
option	query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/state?jmxEnv={jmxEnv}&adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/channel/{url}/{jmxUid}/{channel}/configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/configuration?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}/{channel}/details

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/details?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}/{channel}/failed-messages/count

Get the number of failed messages for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/failed-messages/count?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}/{channel}/metrics/message-metrics

Get a channel message metrics statistics

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/metrics/message-metrics?jmxEnv={jmxEnv}'

GET /external/channel/{url}/{jmxUid}/{channel}/metrics/message-metrics/{id}

Get a channel message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Parameter Type	Data Type
url	path	String
jmxUid	path	String
Jmx-Credentials	header	String
jmxEnv	query	String
channel	path	String
id	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/channel/{url}/{jmxUid}/{channel}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}

Gets a workflow for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/count

Counts workflows for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/count?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}

Lists workflows for a channel

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/state

Get a workflow's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/state?jmxEnv={jmxEnv}'

PUT /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/state

Update a workflow's state

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
adpMgmtTimeout	adpMgmtTimeout	query	String
option		query	String

Request Body

Parameter Content Type

Curl Example

curl -X PUT -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/state?jmxEnv={jmxEnv}&adpMgmtTimeout={adpMgmtTimeout}&option={option}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/configuration

Get a workflow's configuration

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/configuration?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/details

Get details for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/details?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/failed-messages/count

Get the number of failed messages for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url		path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/failed-messages/count?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/metadata-statistics-ids

Get all the metadata statistics ids for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/metadata-statistics-ids?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics-ids

Get all the message metrics statistics ids for a workflow

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics-ids?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics/{id}

Get a workflow message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

DELETE /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics/{id}

Delete the workflow message metrics statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X DELETE -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics/{id}?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/metadata-statistics/{id}

Get a workflow matadata statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/metadata-statistics/{id}?jmxEnv={jmxEnv}'

DELETE /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/metadata-statistics/{id}

Delete the workflow matadata statistics for the given id

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String
id		path	String

Curl Example

curl -X DELETE -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/metadata-statistics/{id}?jmxEnv={jmxEnv}'

GET /external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics

Get a workflow message metrics statistics. The first found will be returned

Response Class (Status default)

default response

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
url	The JMX URL used to connect to an Adapter.	path	String
jmxUid	The unique identifier used in the Adapter configuration XML.	path	String
Jmx-Credentials	The JMX credentials used to connect to an Adapter. You can encode the password using the Interlok utility class 'Password.encode(plain, Password.PORTABLE_PASSWORD)'.	header	String
jmxEnv	The JMX environment parameters used to connect to an Adapter.	query	String
channel	The channel unique id.	path	String
workflow	The workflow unique id.	path	String

Curl Example

curl -X GET -d '{body}' 'http://host:8080/interlok/api/external/workflow/{url}/{jmxUid}/{channel}/{workflow}/metrics/message-metrics?jmxEnv={jmxEnv}'

Response Class (Status default)

Parameters

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Request Body

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Request Body

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Request Body

Curl Example

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status default)

Parameters

Request Body

Curl Example